Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIXULWindow Interface Reference

import "nsIXULWindow.idl";

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

List of all members.

Public Member Functions

nsIDocShellTreeItem getContentShellById (in wstring ID)
 The content shell specified by the supplied id.
void addChildWindow (in nsIXULWindow aChild)
 Tell this window that it has picked up a child XUL window.
void removeChildWindow (in nsIXULWindow aChild)
 Tell this window that it has lost a child XUL window.
void center (in nsIXULWindow aRelative, in boolean aScreen, in boolean aAlert)
 Move the window to a centered position.
void showModal ()
 Shows the window as a modal window.
nsIXULWindow createNewWindow (in PRInt32 aChromeFlags, in nsIAppShell aAppShell)
 Create a new window.

Public Attributes

readonly attribute nsIDocShell docShell
 The docshell owning the XUL for this window.
attribute boolean intrinsicallySized
 Indicates if this window is instrinsically sized.
readonly attribute
nsIDocShellTreeItem 
primaryContentShell
 The primary content shell.
const unsigned long lowestZ = 0
const unsigned long loweredZ = 4
const unsigned long normalZ = 5
const unsigned long raisedZ = 6
const unsigned long highestZ = 9
attribute unsigned long zLevel
attribute PRUint32 contextFlags
 contextFlags are from nsIWindowCreator2
attribute PRUint32 chromeFlags
attribute nsIXULBrowserWindow XULBrowserWindow

Detailed Description

Definition at line 55 of file nsIXULWindow.idl.


Member Function Documentation

Tell this window that it has picked up a child XUL window.

Parameters:
aChildthe child window being added
void nsIXULWindow::center ( in nsIXULWindow  aRelative,
in boolean  aScreen,
in boolean  aAlert 
)

Move the window to a centered position.

Parameters:
aRelativethe window relative to which the window is moved. See screen parameter for details. if null, the window is centered relative to the main screen.
aScreenPR_TRUE to center the window relative to the screen containing aRelative. PR_FALSE to center it relative to aRelative itself.
aAlertPR_TRUE to move the window to an alert position, generally centered horizontally and 1/3 down from the top.

Create a new window.

Parameters:
aChromeFlagssee nsIWebBrowserChrome
Returns:
the newly minted window

The content shell specified by the supplied id.

Note that this is a docshell tree item and therefore can not be assured of what object it is. It could be an editor, a docshell, or a browser object. Or down the road any other object that supports being a DocShellTreeItem Query accordingly to determine the capabilities.

Tell this window that it has lost a child XUL window.

Parameters:
aChildthe child window being removed

Shows the window as a modal window.

That is, ensures that it is visible and runs a local event loop, exiting only once the window has been closed.


Member Data Documentation

Definition at line 131 of file nsIXULWindow.idl.

contextFlags are from nsIWindowCreator2

Definition at line 129 of file nsIXULWindow.idl.

The docshell owning the XUL for this window.

Definition at line 60 of file nsIXULWindow.idl.

Definition at line 122 of file nsIXULWindow.idl.

Indicates if this window is instrinsically sized.

Definition at line 65 of file nsIXULWindow.idl.

Definition at line 119 of file nsIXULWindow.idl.

Definition at line 118 of file nsIXULWindow.idl.

Definition at line 120 of file nsIXULWindow.idl.

The primary content shell.

Note that this is a docshell tree item and therefore can not be assured of what object it is. It could be an editor, a docshell, or a browser object. Or down the road any other object that supports being a DocShellTreeItem Query accordingly to determine the capabilities.

Definition at line 75 of file nsIXULWindow.idl.

Definition at line 121 of file nsIXULWindow.idl.

Definition at line 140 of file nsIXULWindow.idl.

Definition at line 124 of file nsIXULWindow.idl.


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