Back to index

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

import "nsIAppShellService.idl";

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

List of all members.

Public Member Functions

nsIXULWindow createTopLevelWindow (in nsIXULWindow aParent, in nsIURI aUrl, in PRUint32 aChromeMask, in long aInitialWidth, in long aInitialHeight, in nsIAppShell aAppShell)
void createHiddenWindow (in nsIAppShell aAppShell)
void destroyHiddenWindow ()
void getHiddenWindowAndJSContext (out nsIDOMWindowInternal aHiddenDOMWindow, out JSContext aJSContext)
 Return the (singleton) application hidden window as an nsIDOMWindowInternal, and, the corresponding JavaScript context pointer.
void registerTopLevelWindow (in nsIXULWindow aWindow)
 Add a window to the application's registry of windows.
void unregisterTopLevelWindow (in nsIXULWindow aWindow)
 Remove a window from the application's window registry.
void topLevelWindowIsModal (in nsIXULWindow aWindow, in boolean aModal)
 The appshell service needs to be informed of modal XUL windows currently open.

Public Attributes

const long SIZE_TO_CONTENT = -1
 Create a window, which will be initially invisible.
readonly attribute nsIXULWindow hiddenWindow
 Return the (singleton) application hidden window, automatically created and maintained by this AppShellService.
readonly attribute
nsIDOMWindowInternal 
hiddenDOMWindow
 Return the (singleton) application hidden window, automatically created and maintained by this AppShellService.

Detailed Description

Definition at line 52 of file nsIAppShellService.idl.


Member Function Documentation

nsIXULWindow nsIAppShellService::createTopLevelWindow ( in nsIXULWindow  aParent,
in nsIURI  aUrl,
in PRUint32  aChromeMask,
in long  aInitialWidth,
in long  aInitialHeight,
in nsIAppShell  aAppShell 
)

Return the (singleton) application hidden window as an nsIDOMWindowInternal, and, the corresponding JavaScript context pointer.

This is useful if you'd like to subsequently call OpenDialog on the hidden window. the hidden window QI'd to type nsIDOMWindowInternal the corresponding JavaScript context

Add a window to the application's registry of windows.

These windows are generally shown in the Windows taskbar, and the application knows it can't quit until it's out of registered windows.

Parameters:
aWindowthe window to register
Note:
When this method is successful, it fires the global notification "xul-window-registered"

The appshell service needs to be informed of modal XUL windows currently open.

Call this method as a window becomes modal or as it becomes nonmodal.

Parameters:
aWindowno surprises here
aModaltrue if aWindow is becoming modal false if aWindow is becoming nonmodal (or being closed)

Remove a window from the application's window registry.

Note that this method won't automatically attempt to quit the app when the last window is unregistered. For that, see Quit().

Parameters:
aWindowyou see the pattern

Member Data Documentation

Return the (singleton) application hidden window, automatically created and maintained by this AppShellService.

Parameters:
aResultthe hidden window. Do not unhide hidden window. Do not taunt hidden window.

Definition at line 100 of file nsIAppShellService.idl.

Return the (singleton) application hidden window, automatically created and maintained by this AppShellService.

Parameters:
aResultthe hidden window. Do not unhide hidden window. Do not taunt hidden window.

Definition at line 92 of file nsIAppShellService.idl.

Create a window, which will be initially invisible.

Parameters:
aParentthe parent window. Can be null.
aUrlthe contents of the new window.
aChromeMaskchrome flags affecting the kind of OS border given to the window. see nsIBrowserWindow for bit/flag definitions.
aCallbacksinterface providing C++ hooks for window initialization before the window is made visible. Can be null. Deprecated.
aInitialWidthwidth, in pixels, of the window. Width of window at creation. Can be overridden by the "width" tag in the XUL. Set to NS_SIZETOCONTENT to force the window to wrap to its contents.
aInitialHeightlike aInitialWidth, but subtly different.
aAppShella widget "appshell" (event processor) to associate with the new window
aResultthe newly created window is returned here.

Definition at line 73 of file nsIAppShellService.idl.


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