The nsIWebNavigation interface defines an interface for navigating the web.
It provides methods and attributes to direct an object to navigate to a new
location, stop or restart an in process load, or determine where the object
has previously gone.
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.
@throw NS_ERROR_UNEXPECTED
Indicates that the call was unexpected at this time, which implies
that canGoBack is false.
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.
@throw NS_ERROR_UNEXPECTED
Indicates that the call was unexpected at this time, which implies
that canGoForward is false.
Tells the object to navigate to the session history item at a given index.
@throw NS_ERROR_UNEXPECTED
Indicates that the call was unexpected at this time, which implies
that session history entry at the given index does not exist.
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.
| aURI | 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. |
| aLoadFlags | 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. |
| aReferrer | The referring URI. If this argument is null, then the referring URI will be inferred internally. |
| aPostData | 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 is optional and may be null. |
| aHeaders | 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 is optional and may be null. |
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.
Behaves like loadURI, except an additional parameter is provided to supply
a base URI to be used in specific situations where one cannot be inferred
by other means, for example when this is called to view selection source.
Outside of these situations, the behaviour of this function is no
different to loadURI.
| aURI | 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. |
| aLoadFlags | 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. |
| aReferrer | The referring URI. If this argument is null, then the referring URI will be inferred internally. |
| aPostData | 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 is optional and may be null. |
| aHeaders | 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 is optional and may be null. |
| aBaseURI | Set to indicate a base URI to be associated with the load. Note that at present this argument is only used with view-source aURIs and cannot be used to resolve aURI. This parameter is optional and may be null. |
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).
@throw NS_BINDING_ABORTED
Indicating that the user canceled the reload.
| aReloadFlags | 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. |
Stops a load of a URI.
| aStopFlags | This parameter is one of the stop flags defined above. |
Indicates if the object can go back. If true this indicates that
there is back session history available for navigation.
Indicates if the object can go forward. If true this indicates that
there is forward session history available for navigation
Retrieves the current DOM document for the frame, or lazily creates a
blank document if there is none. This attribute never returns null except
for unexpected error situations.
The currently loaded URI or null.
The referring URI for the currently loaded URI or null.
The session history object used by this web navigation instance.
The following flags may be bitwise combined to form the load flags
parameter passed to either the loadURI or reload method. Some of these
flags are only applicable to loadURI.
This flags defines the range of bits that may be specified. Flags
outside this range may be used, but may not be passed to Reload().
This is the default value for the load flags parameter.
Flags 0x1, 0x2, 0x4, 0x8 are reserved for internal use by
nsIWebNavigation implementations for now.
This flag specifies that the load should have the semantics of an HTML
Meta-refresh tag (i.e., that the cache should be bypassed). This flag
is only applicable to loadURI.
XXX the meaning of this flag is poorly defined.
XXX no one uses this, so we should probably deprecate and remove it.
This flag specifies that the load should have the semantics of a link
click. This flag is only applicable to loadURI.
XXX the meaning of this flag is poorly defined.
This flag specifies that history should not be updated. This flag is only
applicable to loadURI.
This flag specifies that any existing history entry should be replaced.
This flag is only applicable to loadURI.
This flag specifies that the local web cache should be bypassed, but an
intermediate proxy cache could still be used to satisfy the load.
This flag specifies that any intermediate proxy caches should be bypassed
(i.e., that the content should be loaded from the origin server).
This flag specifies that a reload was triggered as a result of detecting
an incorrect character encoding while parsing a previously loaded
document.
If this flag is set, Stop() will be called before the load starts
and will stop both content and network activity (the default is to
only stop network activity). Effectively, this passes the
STOP_CONTENT flag to Stop(), in addition to the STOP_NETWORK flag.
A hint this load was prompted by an external program: take care!
This flag is set when a user explicitly disables the Mixed Content
Blocker, and allows Mixed Content to load on an https page.
This flag specifies that this is the first load in this object.
Set with care, since setting incorrectly can cause us to assume that
nothing was actually loaded in this object if the load ends up being
handled by an external application. This flag must not be passed to
Reload.
This flag specifies that the load should not be subject to popup
blocking checks. This flag must not be passed to Reload.
This flag specifies that the URI classifier should not be checked for
this load. This flag must not be passed to Reload.
Force relevant cookies to be sent with this load even if normally they
wouldn’t be.
Prevent the owner principal from being inherited for this load.
This flag specifies that the URI may be submitted to a third-party
server for correction. This should only be applied to non-sensitive
URIs entered by users. This flag must not be passed to Reload.
This flag specifies that common scheme typos should be corrected.
The following flags may be passed as the stop flags parameter to the stop
method defined on this interface.
This flag specifies that all network activity should be stopped. This
includes both active network loads and pending META-refreshes.
This flag specifies that all content activity should be stopped. This
includes animated images, plugins and pending Javascript timeouts.
This flag specifies that all activity should be stopped.