nsIXULWindow

IID:D9CB00E0-CA39-11d3-B029-00A024FFC08C
Inherits From:nsISupports

Constants

PRUint32 lowestZ = 0
PRUint32 loweredZ = 4
PRUint32 normalZ = 5
PRUint32 raisedZ = 6
PRUint32 highestZ = 9

Properties

PRUint32 contextFlags

ContextFlags are from nsIWindowCreator2

readonly nsIDocShell docShell

The docshell owning the XUL for this window.

PRBool intrinsicallySized

Indicates if this window is instrinsically sized.

readonly nsIDocShellTreeItem primaryContentShell

This returns 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.

PRUint32 zLevel


Methods

void addChildWindow ( nsIXULWindow child ) void center ( nsIXULWindow relative , PRBool screen , PRBool alert ) nsIXULWindow createNewWindow ( PRInt32 chromeFlags ) nsIDocShellTreeItem getContentShellById ( PRUnichar* ID ) void removeChildWindow ( nsIXULWindow child ) void showModal ( )

void addChildWindow ( nsIXULWindow child )

Tell this window that it has picked up or lost a child XUL window

Arguments:
child: the child window being added or removed

void center ( nsIXULWindow relative , PRBool screen , PRBool alert )

Move the window to a centered position.

Arguments:
relative: 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.
screen: PR_TRUE to center the window relative to the screen containing relative. PR_FALSE to center it relative to relative itself.
alert: PR_TRUE to move the window to an alert position, generally centered horizontally and 1/3 down from the top.

nsIXULWindow createNewWindow ( PRInt32 chromeFlags )

Create a new window.

Arguments:
chromeFlags: : see nsIWebBrowserChrome
Returns:
the newly minted window

nsIDocShellTreeItem getContentShellById ( PRUnichar* ID )

This returns 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.

Arguments:
ID

void removeChildWindow ( nsIXULWindow child )

Arguments:
child

void showModal ( )

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.


References

This interface is the type of the following properties:

nsIAppShellService.hiddenWindow

This interface is passed as an argument to the following methods:

nsIAppShellService.closeTopLevelWindow, nsIAppShellService.createTopLevelWindow, nsIAppShellService.registerTopLevelWindow, nsIAppShellService.topLevelWindowIsModal, nsIAppShellService.unregisterTopLevelWindow, nsIWindowMediator.calculateZPosition, nsIWindowMediator.getZLevel, nsIWindowMediator.registerWindow, nsIWindowMediator.setZLevel, nsIWindowMediator.setZPosition, nsIWindowMediator.unregisterWindow, nsIWindowMediator.updateWindowTimeStamp, nsIWindowMediator.updateWindowTitle, nsIWindowMediatorListener.onCloseWindow, nsIWindowMediatorListener.onOpenWindow, nsIWindowMediatorListener.onWindowTitleChange, nsIXULWindow.addChildWindow, nsIXULWindow.center, nsIXULWindow.removeChildWindow

This interface is returned from the following methods:

nsIAppShellService.createTopLevelWindow, nsIXULWindow.createNewWindow

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com