nsIWebBrowser
| IID: | 69E5DF00-7B8B-11d3-AF61-00A024FFC08C |
| Inherits From: | nsISupports |
| Status: | FROZEN |
The nsIWebBrowser interface is implemented by web browser objects. Embedders use this interface during initialisation to associate the new web browser instance with the embedders chrome and to register any listeners. The interface may also be used at runtime to obtain the content DOM window and from that the rest of the DOM.
This interface is implemented by the following components:
Properties
nsIWebBrowserChrome containerWindow
The chrome object associated with the browser instance. The embedder
must create one chrome object for each browser object
that is instantiated. The embedder must associate the two by setting
this property to point to the chrome object before creating the browser
window via the browser's nsIBaseWindow interface.
The chrome object must also implement nsIEmbeddingSiteWindow.
The chrome may optionally implement nsIInterfaceRequestor,
nsIWebBrowserChromeFocus,
nsIContextMenuListener and
nsITooltipListener to receive additional notifications
from the browser object.
The chrome object may optionally implement nsIWebProgressListener
instead of explicitly calling addWebBrowserListener and
removeWebBrowserListener to register a progress listener
object. If the implementation does this, it must also implement
nsIWeakReference.
readonly nsIDOMWindow contentDOMWindow
The top-level DOM window. The embedder may walk the entire DOM starting from this value.
nsIURIContentListener parentURIContentListener
URI content listener parent. The embedder may set this property to their own implementation if they intend to override or prevent how certain kinds of content are loaded.
Methods
void addWebBrowserListener ( nsIWeakReference listener , nsIIDRef IID )
void removeWebBrowserListener ( nsIWeakReference listener , nsIIDRef IID )
void addWebBrowserListener ( nsIWeakReference listener , nsIIDRef IID )
Registers a listener of the type specified by the iid to receive
callbacks. The browser stores a weak reference to the listener
to avoid any circular dependencies.
Typically this method will be called to register an object
to receive nsIWebProgressListener or
nsISHistoryListener notifications in which case the
the IID is that of the interface.
- Arguments:
- listener: The listener to be added.
- IID: The IID of the interface that will be called on the listener as appropriate.
- Returns:
NS_OK, listener was successfully added;NS_ERROR_INVALID_ARG, one of the arguments was invalid or the object did not implement the interface specified by the IID.
void removeWebBrowserListener ( nsIWeakReference listener , nsIIDRef IID )
Removes a previously registered listener.
- Arguments:
- listener: The listener to be removed.
- IID: The IID of the interface on the listener that will no longer be called.
- Returns:
NS_OK, listener was successfully removed;NS_ERROR_INVALID_ARGarguments was invalid or the object did not implement the interface specified by the IID.
References
This interface is the type of the following properties:
nsIWebBrowserChrome.webBrowser
Reference documentation is generated from Mozilla's source.