nsIWebNavigation

This interface is implemented by the following components:

 * @mozilla.org/browser/shistory-internal;1
 * @mozilla.org/browser/shistory;1
 * @mozilla.org/embedding/browser/nsWebBrowser;1
 * @mozilla.org/docshell;1

Method overview

Constants

Load Flags

Note

For valid load flag combinations look here nsDocShellLoadTypes.h

Stop Flags

Attributes

Methods

goBack()

Tells the object to navigate to the previous session history item. When a page is loaded from session history, all content is loaded from the cache (if available) and page state (such as form values and scroll position) is restored.

void goBack( );

goForward()

Tells the object to navigate to the next session history item. When a page is loaded from session history, all content is loaded from the cache (if available) and page state (such as form values and scroll position) is restored.

void goForward( );

gotoIndex()

Tells the object to navigate to the session history item at a given index.

void gotoIndex(
  in long index
);

Parameters

index

The index of the session history item to go to.

loadURI()

Loads a given URI. This will give priority to loading the requested URI in the object implementing this interface. If it can't be loaded here however, the URI dispatcher will go through its normal process of content loading.

void loadURI(
  wstring URI,
  unsigned long loadFlags,
  nsIURI referrer,
  nsIInputStream postData,
  nsIInputStream headers
);

Parameters

URI

The URI string to load. For HTTP and FTP URLs and possibly others, characters above U+007F will be converted to UTF-8 and then URL- escaped per the rules of RFC 2396.

loadFlags

Flags modifying load behaviour. This parameter is a bitwise combination of the load flags defined above. (Undefined bits are reserved for future use.) Generally you will pass LOAD_FLAGS_NONE for this parameter.

referrer

The referring URI. If this argument is null, then the referring URI will be inferred internally.

postData

If the URI corresponds to a HTTP request, then this stream is appended directly to the HTTP request headers. It may be prefixed with additional HTTP headers. This stream must contain a \r\n sequence separating any HTTP headers from the HTTP request body. This parameter may be null.

headers

If the URI corresponds to a HTTP request, then any HTTP headers contained in this stream are set on the HTTP request. The HTTP header stream is formatted as: ( HEADER \r\n )* This parameter may be null.

reload()

Tells the Object to reload the current page. There may be cases where the user will be asked to confirm the reload (for example, when it is determined that the request is non-idempotent).

void reload(
  unsigned long reloadFlags
);

Parameters

reloadFlags

Flags modifying load behaviour. This parameter is a bitwise combination of the load flags defined above. (Undefined bits are reserved for future use.) Generally you will pass LOAD_FLAGS_NONE for this parameter.

stop()

Stops a load of a URI.

void stop(
  unsigned long stopFlags
);

Parameters

stopFlags

This parameter is one of the stop flags defined above.