Public Member Functions | Public Attributes

nsIAppShellService Interface Reference

import "nsIAppShellService.idl";

Collaboration diagram for nsIAppShellService:

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.

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.
readonly attribute boolean applicationProvidedHiddenWindow
 Return true if the application hidden window was provided by the application.

Member Function Documentation

void nsIAppShellService::createHiddenWindow ( in nsIAppShell  aAppShell  ) 
nsIXULWindow nsIAppShellService::createTopLevelWindow ( in nsIXULWindow  aParent,
in nsIURI  aUrl,
in PRUint32  aChromeMask,
in long  aInitialWidth,
in long  aInitialHeight,
in nsIAppShell  aAppShell 
)
void nsIAppShellService::destroyHiddenWindow (  ) 
void nsIAppShellService::getHiddenWindowAndJSContext ( out nsIDOMWindowInternal  aHiddenDOMWindow,
out JSContext  aJSContext 
)

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

void nsIAppShellService::registerTopLevelWindow ( in nsIXULWindow  aWindow  ) 

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:
aWindow the window to register
Note:
When this method is successful, it fires the global notification "xul-window-registered"
void nsIAppShellService::unregisterTopLevelWindow ( in nsIXULWindow  aWindow  ) 

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:
aWindow you see the pattern

Member Data Documentation

Return true if the application hidden window was provided by the application.

If it wasn't, the default hidden window was used. This will usually be false on all non-mac platforms.

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

Parameters:
aResult the hidden window. Do not unhide hidden window. Do not taunt hidden window.

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

Parameters:
aResult the hidden window. Do not unhide hidden window. Do not taunt hidden window.

Create a window, which will be initially invisible.

Parameters:
aParent the parent window. Can be null.
aUrl the contents of the new window.
aChromeMask chrome flags affecting the kind of OS border given to the window. see nsIBrowserWindow for bit/flag definitions.
aCallbacks interface providing C++ hooks for window initialization before the window is made visible. Can be null. Deprecated.
aInitialWidth width, 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.
aInitialHeight like aInitialWidth, but subtly different.
aAppShell a widget "appshell" (event processor) to associate with the new window
aResult the newly created window is returned here.

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