Public Member Functions | Public Attributes

nsIContentViewer Interface Reference

import "nsIContentViewer.idl";

Collaboration diagram for nsIContentViewer:

List of all members.

Public Member Functions

void init (in nsIWidgetPtr aParentWidget,[const ] in nsIntRectRef aBounds)
void loadStart (in nsISupports aDoc)
void loadComplete (in unsigned long aStatus)
boolean permitUnload ([optional] in boolean aCallerClosesWindow)
 Checks if the document wants to prevent unloading by firing beforeunload on the document, and if it does, prompts the user.
void resetCloseWindow ()
 Works in tandem with permitUnload, if the caller decides not to close the window it indicated it will, it is the caller's responsibility to reset that with this method.
void pageHide (in boolean isUnload)
void close (in nsISHEntry historyEntry)
 All users of a content viewer are responsible for calling both close() and destroy(), in that order.
void destroy ()
void stop ()
void getBounds (in nsIntRectRef aBounds)
void setBounds ([const ] in nsIntRectRef aBounds)
void move (in long aX, in long aY)
void show ()
void hide ()
boolean requestWindowClose ()
void open (in nsISupports aState, in nsISHEntry aSHEntry)
 Attach the content viewer to its DOM window and docshell.
void clearHistoryEntry ()
 Clears the current history entry.
void setPageMode (in PRBool aPageMode, in nsIPrintSettings aPrintSettings)

Public Attributes

attribute nsISupports container
attribute nsIDOMDocument DOMDocument
attribute nsIContentViewer previousViewer
 The previous content viewer, which has been |close|d but not |destroy|ed.
attribute boolean enableRendering
attribute boolean sticky
readonly attribute nsISHEntry historyEntry
 Get the history entry that this viewer will save itself into when destroyed.

Member Function Documentation

void nsIContentViewer::clearHistoryEntry (  ) 

Clears the current history entry.

This is used if we need to clear out the saved presentation state.

void nsIContentViewer::close ( in 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.

void nsIContentViewer::destroy (  ) 
void nsIContentViewer::getBounds ( in nsIntRectRef  aBounds  ) 
void nsIContentViewer::hide (  ) 
void nsIContentViewer::init ( in nsIWidgetPtr  aParentWidget,
[const ] in nsIntRectRef  aBounds 
)
void nsIContentViewer::loadComplete ( in unsigned long  aStatus  ) 
void nsIContentViewer::loadStart ( in nsISupports  aDoc  ) 
void nsIContentViewer::move ( in long  aX,
in long  aY 
)
void nsIContentViewer::open ( in nsISupports  aState,
in nsISHEntry  aSHEntry 
)

Attach the content viewer to its DOM window and docshell.

Parameters:
aState A state object that might be useful in attaching the DOM window.
aSHEntry The history entry that the content viewer was stored in. The entry must have the docshells for all of the child documents stored in its child shell list.
void nsIContentViewer::pageHide ( in boolean  isUnload  ) 
boolean nsIContentViewer::permitUnload ( [optional] in boolean  aCallerClosesWindow  ) 

Checks if the document wants to prevent unloading by firing beforeunload on the document, and if it does, prompts the user.

The result is returned.

Parameters:
aCallerClosesWindow indicates that the current caller will close the window. If the method returns true, all subsequent calls will be ignored.
boolean nsIContentViewer::requestWindowClose (  ) 
void nsIContentViewer::resetCloseWindow (  ) 

Works in tandem with permitUnload, if the caller decides not to close the window it indicated it will, it is the caller's responsibility to reset that with this method.

this method is only meant to be called on documents for which the caller has indicated that it will close the window. If that is not the case the behavior of this method is undefined.

void nsIContentViewer::setBounds ( [const ] in nsIntRectRef  aBounds  ) 
void nsIContentViewer::setPageMode ( in PRBool  aPageMode,
in nsIPrintSettings  aPrintSettings 
)
void nsIContentViewer::show (  ) 
void nsIContentViewer::stop (  ) 

Member Data Documentation

Get the history entry that this viewer will save itself into when destroyed.

Can return null

The previous content viewer, which has been |close|d but not |destroy|ed.


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