The nsIWebBrowser interface is implemented by web browser objects. More...

import "nsIWebBrowser.idl";

Collaboration diagram for nsIWebBrowser:

Public Member Functions
void	addWebBrowserListener (in nsIWeakReference aListener, in nsIIDRef aIID)
	Registers a listener of the type specified by the iid to receive callbacks.
void	removeWebBrowserListener (in nsIWeakReference aListener, in nsIIDRef aIID)
	Removes a previously registered listener.
Public Attributes
attribute nsIWebBrowserChrome	containerWindow
	The chrome object associated with the browser instance.
attribute nsIURIContentListener	parentURIContentListener
	URI content listener parent.
readonly attribute nsIDOMWindow	contentDOMWindow
	The top-level DOM window.
attribute boolean	isActive
	Whether this web browser is active.

Detailed Description

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.

Member Function Documentation

void nsIWebBrowser::addWebBrowserListener	(	in nsIWeakReference	aListener,
		in nsIIDRef	aIID
	)

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.

Parameters:

	aListener	The listener to be added.
	aIID	The IID of the interface that will be called on the listener as appropriate.

Returns:: NS_OK for successful registration; NS_ERROR_INVALID_ARG if aIID is not supposed to be registered using this method; NS_ERROR_FAILURE either aListener did not expose the interface specified by the IID, or some other internal error occurred.

See also:: removeWebBrowserListener; nsIWeakReference; nsIWebProgressListener; nsISHistoryListener

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 nsIWebBrowser::removeWebBrowserListener	(	in nsIWeakReference	aListener,
		in nsIIDRef	aIID
	)

Removes a previously registered listener.

Parameters:

	aListener	The listener to be removed.
	aIID	The IID of the interface on the listener that will no longer be called.

Returns:: NS_OK, listener was successfully removed; NS_ERROR_INVALID_ARG arguments was invalid or the object did not implement the interface specified by the IID.

See also:: addWebBrowserListener; nsIWeakReference

Member Data Documentation

attribute nsIWebBrowserChrome nsIWebBrowser::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.

Note:: The implementation should not refcount the supplied chrome object; it should assume that a non nsnull value is always valid. The embedder must explicitly set this value back to nsnull if the chrome object is destroyed before the browser object.

See also:: nsIBaseWindow; nsIWebBrowserChrome; nsIEmbeddingSiteWindow; nsIInterfaceRequestor; nsIWebBrowserChromeFocus; nsIContextMenuListener; nsITooltipListener; nsIWeakReference; nsIWebProgressListener

readonly attribute nsIDOMWindow nsIWebBrowser::contentDOMWindow

The top-level DOM window.

The embedder may walk the entire DOM starting from this value.

See also:: nsIDOMWindow

attribute boolean nsIWebBrowser::isActive

Whether this web browser is active.

Active means that it's visible enough that we want to avoid certain optimizations like discarding decoded image data and throttling the refresh driver. In Firefox, this corresponds to the visible tab.

Defaults to true. For optimal performance, set it to false when appropriate.

attribute nsIURIContentListener nsIWebBrowser::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.

Note:: If this attribute is set to an object that implements nsISupportsWeakReference, the implementation should get the nsIWeakReference and hold that. Otherwise, the implementation should not refcount this interface; it should assume that a non null value is always valid. In that case, the embedder should explicitly set this value back to null if the parent content listener is destroyed before the browser object.

See also:: nsIURIContentListener

The documentation for this interface was generated from the following file:

nsIWebBrowser.idl

nsIWebBrowser Interface Reference

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation