nsIXULWindow Interface

[scriptable, uuid(b6c2f9e1-53a0-45f2-a2b8-fe37861fe8a8)]

Constants

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

Attributes

attribute nsIXULBrowserWindow XULBrowserWindow

attribute PRUint32 chromeFlags

 contextFlags are from nsIWindowCreator2

attribute PRUint32 contextFlags

 The docshell owning the XUL for this window.

readonly attribute nsIDocShell docShell

 Indicates if this window is instrinsically sized.

attribute boolean intrinsicallySized

 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.

readonly attribute nsIDocShellTreeItem primaryContentShell

attribute unsigned long zLevel

Methods

 Tell this window that it has picked up a child XUL window
 @param aChild the child window being added

void addChildWindow(in nsIXULWindow aChild)

 Move the window to a centered position.
 @param aRelative the window relative to which the window is moved.
                  See screen parameter for details. if null, the
                  window is centered relative to the main screen.
 @param aScreen   PR_TRUE to center the window relative to the screen
                  containing aRelative. PR_FALSE to center it relative
                  to aRelative itself.
 @param aAlert    PR_TRUE to move the window to an alert position,
                  generally centered horizontally and 1/3 down from the top.

void center(in nsIXULWindow aRelative, in boolean aScreen, in boolean aAlert)

 Create a new window.
 @param aChromeFlags see nsIWebBrowserChrome
 @return the newly minted window

nsIXULWindow createNewWindow(in PRInt32 aChromeFlags, in nsIAppShell aAppShell)

 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.

nsIDocShellTreeItem getContentShellById(in wstring ID)

 Tell this window that it has lost a child XUL window
 @param aChild the child window being removed

void removeChildWindow(in nsIXULWindow aChild)

 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.

void showModal()