nsIWebNavigation
| IID: | F5D9E7B0-D930-11d3-B057-00A024FFC08C |
| Inherits From: | nsISupports |
| Status: | UNDER_REVIEW |
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.
This interface is implemented by the following components:
Constants
Properties
readonly PRBool canGoBack
Indicates if the object can go back. If true this indicates that there is back session history available for navigation.
readonly PRBool canGoForward
Indicates if the object can go forward. If true this indicates that there is forward session history available for navigation
readonly nsIURI currentURI
The currently loaded URI or null.
readonly nsIDOMDocument document
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.
readonly nsIURI referringURI
The referring URI for the currently loaded URI or null.
nsISHistory sessionHistory
The session history object used by this web navigation instance.
Methods
void goBack ( )
void goForward ( )
void gotoIndex ( PRInt32 index )
void loadURI ( PRUnichar* URI , PRUint32 loadFlags , nsIURI referrer , nsIInputStream postData , nsIInputStream headers )
void reload ( PRUint32 reloadFlags )
void stop ( PRUint32 stopFlags )
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.
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 gotoIndex ( PRInt32 index )
Tells the object to navigate to the session history item at a given index.
- Arguments:
- index
void loadURI ( PRUnichar* URI , PRUint32 loadFlags , nsIURI referrer , nsIInputStream postData , nsIInputStream headers )
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.
- Arguments:
- 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 is optional and 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 is optional and may be null.
void reload ( PRUint32 reloadFlags )
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).
- Arguments:
- 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.
void stop ( PRUint32 stopFlags )
Stops a load of a URI.
- Arguments:
- stopFlags: This parameter is one of the stop flags defined above.
References
This interface is passed as an argument to the following methods:
nsICharsetResolver.requestCharset, nsIDragDropHandler.hookupTo, nsIWebNavigationInfo.isTypeSupported
Reference documentation is generated from Mozilla's source.