nsIContentViewer

IID:6a7ddb40-8a9e-4576-8ad1-71c5641d8780
Inherits From:nsISupports

Properties

nsISupports container

nsIDOMDocument DOMDocument

PRBool enableRendering

nsIContentViewer previousViewer

The previous content viewer, which has been closed but not destroyed.

PRBool sticky


Methods

void clearHistoryEntry ( ) void close ( nsISHEntry historyEntry ) void destroy ( ) [noscript] void getBounds ( nsRectRef bounds ) void hide ( ) [noscript] void init ( nsIWidgetPtr parentWidget , nsIDeviceContextPtr deviceContext , nsRectRef bounds ) void loadComplete ( PRUint32 status ) void loadStart ( nsISupports doc ) void move ( PRInt32 aX , PRInt32 aY ) void open ( nsISupports state ) void pageHide ( PRBool isUnload ) PRBool permitUnload ( ) PRBool requestWindowClose ( ) [noscript] void setBounds ( nsRectRef bounds ) void show ( ) void stop ( )

void clearHistoryEntry ( )

Clears the current history entry. This is used if we need to clear out the saved presentation state.


void close ( nsISHEntry historyEntry )

All users of a content viewer are responsible for calling both close() and destroy(), in that order.

Close() should be called when the load of a new page for the next content viewer begins, and destroy() should be called when the next content viewer replaces this one.

HistoryEntry sets the session history entry for the content viewer. If this is null, then Destroy() will be called on the document by close(). If it is non-null, the document will not be destroyed, and the following actions will happen when destroy() is called (*): - Sanitize() will be called on the viewer's document - The content viewer will set the contentViewer property on the history entry, and release its reference (ownership reversal). - hide() will be called, and no further destruction will happen.

(*) unless the document is currently being printed, in which case it will never be saved in session history.

Arguments:
historyEntry

void destroy ( )


void getBounds ( nsRectRef bounds )

Arguments:
bounds

void hide ( )


void init ( nsIWidgetPtr parentWidget , nsIDeviceContextPtr deviceContext , nsRectRef bounds )

Arguments:
parentWidget
deviceContext
bounds

void loadComplete ( PRUint32 status )

Arguments:
status

void loadStart ( nsISupports doc )

Arguments:
doc

void move ( PRInt32 aX , PRInt32 aY )

Arguments:
aX
aY

void open ( nsISupports state )

Attach the content viewer to its DOM window and docshell.

Arguments:
state: A state object that might be useful in attaching the DOM window.

void pageHide ( PRBool isUnload )

Arguments:
isUnload

PRBool permitUnload ( )


PRBool requestWindowClose ( )


void setBounds ( nsRectRef bounds )

Arguments:
bounds

void show ( )


void stop ( )


References

This interface is the type of the following properties:

nsIContentViewer.previousViewer, nsIDocShell.contentViewer, nsISHEntry.contentViewer

This interface is passed as an argument to the following methods:

nsIContentViewerContainer.embed, nsIDocShell.beginRestore

This interface is returned from the following methods:

nsIDocumentLoaderFactory.createInstance, nsIDocumentLoaderFactory.createInstanceForDocument, nsISHEntry.getAnyContentViewer

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com