Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIDocumentViewer Class Reference

A document viewer is a kind of content viewer that uses NGLayout to manage the presentation of the content. More...

#include <nsIDocumentViewer.h>

Inheritance diagram for nsIDocumentViewer:
Inheritance graph
[legend]
Collaboration diagram for nsIDocumentViewer:
Collaboration graph
[legend]

List of all members.

Public Member Functions

NS_IMETHOD SetUAStyleSheet (nsIStyleSheet *aUAStyleSheet)=0
NS_IMETHOD GetDocument (nsIDocument **aResult)=0
NS_IMETHOD GetPresShell (nsIPresShell **aResult)=0
NS_IMETHOD GetPresContext (nsPresContext **aResult)=0
NS_IMETHOD CreateDocumentViewerUsing (nsPresContext *aPresContext, nsIDocumentViewer **aResult)=0
void init (in nsIWidgetPtr aParentWidget, in nsIDeviceContextPtr aDeviceContext,[const ] in nsRectRef aBounds)
void loadStart (in nsISupports aDoc)
void loadComplete (in unsigned long aStatus)
boolean permitUnload ()
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 nsRectRef aBounds)
void setBounds ([const ] in nsRectRef aBounds)
void move (in long aX, in long aY)
void show ()
void hide ()
boolean requestWindowClose ()
void open (in nsISupports aState)
 Attach the content viewer to its DOM window and docshell.
void clearHistoryEntry ()
 Clears the current history entry.

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

Detailed Description

A document viewer is a kind of content viewer that uses NGLayout to manage the presentation of the content.

Definition at line 54 of file nsIDocumentViewer.h.


Member Function Documentation

Clears the current history entry.

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

void nsIContentViewer::close ( in nsISHEntry  historyEntry) [inherited]

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.

Here is the caller graph for this function:

NS_IMETHOD nsIDocumentViewer::CreateDocumentViewerUsing ( nsPresContext aPresContext,
nsIDocumentViewer **  aResult 
) [pure virtual]

Implemented in DocumentViewerImpl.

Here is the caller graph for this function:

void nsIContentViewer::getBounds ( in nsRectRef  aBounds) [inherited]
NS_IMETHOD nsIDocumentViewer::GetDocument ( nsIDocument **  aResult) [pure virtual]

Implemented in DocumentViewerImpl.

Here is the caller graph for this function:

Implemented in DocumentViewerImpl.

Implemented in DocumentViewerImpl.

Here is the caller graph for this function:

void nsIContentViewer::hide ( ) [inherited]
void nsIContentViewer::init ( in nsIWidgetPtr  aParentWidget,
in nsIDeviceContextPtr  aDeviceContext,
[const ] in nsRectRef  aBounds 
) [inherited]
void nsIContentViewer::loadComplete ( in unsigned long  aStatus) [inherited]
void nsIContentViewer::loadStart ( in nsISupports  aDoc) [inherited]
void nsIContentViewer::move ( in long  aX,
in long  aY 
) [inherited]
void nsIContentViewer::open ( in nsISupports  aState) [inherited]

Attach the content viewer to its DOM window and docshell.

Parameters:
aStateA state object that might be useful in attaching the DOM window.
void nsIContentViewer::pageHide ( in boolean  isUnload) [inherited]
void nsIContentViewer::setBounds ( [const ] in nsRectRef  aBounds) [inherited]
NS_IMETHOD nsIDocumentViewer::SetUAStyleSheet ( nsIStyleSheet aUAStyleSheet) [pure virtual]

Implemented in DocumentViewerImpl.

void nsIContentViewer::show ( ) [inherited]
void nsIContentViewer::stop ( ) [inherited]

Member Data Documentation

attribute nsISupports nsIContentViewer::container [inherited]

Definition at line 25 of file nsIContentViewer.idl.

Definition at line 58 of file nsIContentViewer.idl.

Definition at line 74 of file nsIContentViewer.idl.

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

Definition at line 67 of file nsIContentViewer.idl.

Definition at line 76 of file nsIContentViewer.idl.


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