nsIXULWindow
| IID: | b6c2f9e1-53a0-45f2-a2b8-fe37861fe8a8 |
| Inherits From: | nsISupports |
Constants
| PRUint32 | lowestZ | = 0 |
| PRUint32 | loweredZ | = 4 |
| PRUint32 | normalZ | = 5 |
| PRUint32 | raisedZ | = 6 |
| PRUint32 | highestZ | = 9 |
Properties
PRUint32 chromeFlags
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
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.
nsIXULBrowserWindow XULBrowserWindow
PRUint32 zLevel
Methods
void addChildWindow ( nsIXULWindow child )
[noscript] void applyChromeFlags ( )
void center ( nsIXULWindow relative , PRBool screen , PRBool alert )
nsIXULWindow createNewWindow ( PRInt32 chromeFlags , nsIAppShell appShell )
nsIDocShellTreeItem getContentShellById ( PRUnichar* ID )
void removeChildWindow ( nsIXULWindow child )
void showModal ( )
void addChildWindow ( nsIXULWindow child )
Tell this window that it has picked up a child XUL window
- Arguments:
- child: the child window being added
Back-door method to force application of chrome flags at a particular time. Do NOT call this unless you know what you're doing! In particular, calling this when this XUL window doesn't yet have a document in its docshell could cause problems.
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 , nsIAppShell appShell )
Create a new window.
- Arguments:
- chromeFlags: see nsIWebBrowserChrome
- appShell
- Returns:
- the newly minted window
nsIDocShellTreeItem getContentShellById ( PRUnichar* ID )
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 )
Tell this window that it has lost a child XUL window
- Arguments:
- child: the 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.
References
This interface is the type of the following properties:
nsIAppShellService.hiddenWindow
This interface is passed as an argument to the following methods:
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.
