Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIXPBaseWindow Class Reference

BaseWindow for HTML Dialog Boxes and Windows. More...

#include <nsIXPBaseWindow.h>

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

List of all members.

Public Member Functions

NS_IMETHOD Init (nsXPBaseWindowType aType, nsIAppShell *aAppShell, const nsString &aDialogURL, const nsString &aTitle, const nsRect &aBounds, PRUint32 aChromeMask, PRBool aAllowPlugins=PR_TRUE)=0
 Initialize the window or dialog box.
NS_IMETHOD SetLocation (PRInt32 aX, PRInt32 aY)=0
 Set the location the window or dialog box on the screen.
NS_IMETHOD SetDimensions (PRInt32 aWidth, PRInt32 aHeight)=0
 Set the width and height of the window or dialog box in pixels.
NS_IMETHOD GetBounds (nsRect &aResult)=0
NS_IMETHOD GetWindowBounds (nsRect &aResult)=0
NS_IMETHOD SetVisible (PRBool aIsVisible)=0
NS_IMETHOD Close ()=0
NS_IMETHOD SetTitle (const PRUnichar *aTitle)=0
NS_IMETHOD GetTitle (const PRUnichar **aResult)=0
NS_IMETHOD GetDocShell (nsIDocShell *&aResult)=0
NS_IMETHOD LoadURL (const nsString &aURL)=0
NS_IMETHOD GetPresShell (nsIPresShell *&aPresShell)=0
NS_IMETHOD GetDocument (nsIDOMHTMLDocument *&aDocument)=0
NS_IMETHOD AddEventListener (nsIDOMNode *aNode)=0
NS_IMETHOD RemoveEventListener (nsIDOMNode *aNode)=0
NS_IMETHOD AddWindowListener (nsIWindowListener *aWindowListener)=0

Detailed Description

BaseWindow for HTML Dialog Boxes and Windows.

The desciption of the dialog box or window is encoded in a HTML File. The Contents of the HTML file and the current settings for form elements are accessed through the W3C DOM interfaces. Access to the nsIDOM classes is done through C++ rather than JavaScript. However, JavaScript event handlers can be used with the HTML File as well. The BaseWindow contains methods for:

1) loading a HTML file 2) Initializing the default values for form elements. 3) attaching an event listener to process click events. 4) Getting a handle to the HTMLDocumentElement to access nsIDOMElements.

Definition at line 84 of file nsIXPBaseWindow.h.


Member Function Documentation

Implemented in nsXPBaseWindow.

Here is the caller graph for this function:

NS_IMETHOD nsIXPBaseWindow::AddWindowListener ( nsIWindowListener aWindowListener) [pure virtual]

Implemented in nsXPBaseWindow.

NS_IMETHOD nsIXPBaseWindow::Close ( ) [pure virtual]

Implemented in nsXPBaseWindow.

NS_IMETHOD nsIXPBaseWindow::GetBounds ( nsRect aResult) [pure virtual]

Implemented in nsXPBaseWindow.

NS_IMETHOD nsIXPBaseWindow::GetDocShell ( nsIDocShell *&  aResult) [pure virtual]

Implemented in nsXPBaseWindow.

Implemented in nsXPBaseWindow.

Here is the caller graph for this function:

NS_IMETHOD nsIXPBaseWindow::GetPresShell ( nsIPresShell *&  aPresShell) [pure virtual]

Implemented in nsXPBaseWindow.

NS_IMETHOD nsIXPBaseWindow::GetTitle ( const PRUnichar **  aResult) [pure virtual]

Implemented in nsXPBaseWindow.

NS_IMETHOD nsIXPBaseWindow::GetWindowBounds ( nsRect aResult) [pure virtual]

Implemented in nsXPBaseWindow.

NS_IMETHOD nsIXPBaseWindow::Init ( nsXPBaseWindowType  aType,
nsIAppShell aAppShell,
const nsString aDialogURL,
const nsString aTitle,
const nsRect aBounds,
PRUint32  aChromeMask,
PRBool  aAllowPlugins = PR_TRUE 
) [pure virtual]

Initialize the window or dialog box.

Parameters:
aTypesee nsXPBaseWindowType's above
aAppShellapplication shell
aPrefPreferences
aDialogURLURL of HTML file describing the dialog or window
aTitleTitle of the dialog box or window
aBoundsx, y, width, and height of the window or dialog box XXX: aChrome is probably not needed for dialog boxes and windows, this is a holdover from the nsBrowserWindow.
aChromeChrome mask for toolbars and statusbars.
aAllowPluginsif TRUE then plugins can be referenced in the HTML file.

Implemented in nsXPBaseWindow.

NS_IMETHOD nsIXPBaseWindow::LoadURL ( const nsString aURL) [pure virtual]

Implemented in nsXPBaseWindow.

Implemented in nsXPBaseWindow.

Here is the caller graph for this function:

NS_IMETHOD nsIXPBaseWindow::SetDimensions ( PRInt32  aWidth,
PRInt32  aHeight 
) [pure virtual]

Set the width and height of the window or dialog box in pixels.

Parameters:
aWidthwidth of the window or dialog box in pixels.
aHeightheight of the window or dialog box in pixels.

Implemented in nsXPBaseWindow.

NS_IMETHOD nsIXPBaseWindow::SetLocation ( PRInt32  aX,
PRInt32  aY 
) [pure virtual]

Set the location the window or dialog box on the screen.

Parameters:
aXhorizontal location of the upper left corner of the window in pixels from the screen.
aYvertical location of the upper left corner of the window in pixels from the screen.

Implemented in nsXPBaseWindow.

NS_IMETHOD nsIXPBaseWindow::SetTitle ( const PRUnichar aTitle) [pure virtual]

Implemented in nsXPBaseWindow.

NS_IMETHOD nsIXPBaseWindow::SetVisible ( PRBool  aIsVisible) [pure virtual]

Implemented in nsXPBaseWindow.

Here is the caller graph for this function:


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