Interface nsIAppShellServiceType

Hierarchy

Properties

applicationProvidedHiddenWindow hasHiddenWindow hiddenDOMWindow hiddenWindow

Methods

AddRef QueryInterface Release createHiddenWindow createTopLevelWindow createWindowlessBrowser destroyHiddenWindow registerTopLevelWindow setScreenId startEventLoopLagTracking stopEventLoopLagTracking unregisterTopLevelWindow

Properties

Readonly applicationProvidedHiddenWindow

applicationProvidedHiddenWindow: boolean

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.

Readonly hasHiddenWindow

hasHiddenWindow: boolean

Whether the hidden window has been lazily created.

Readonly hiddenDOMWindow

hiddenDOMWindow: mozIDOMWindowProxy

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

Param

the hidden window. Do not unhide hidden window. Do not taunt hidden window.

Readonly hiddenWindow

hiddenWindow: nsIAppWindow

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

Param

the hidden window. Do not unhide hidden window. Do not taunt hidden window.

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

createHiddenWindow

  • Returns void

createTopLevelWindow

  • Parameters

    • aParent: nsIAppWindow
    • aUrl: nsIURI
    • aChromeMask: uint32_t
    • aInitialWidth: number
    • aInitialHeight: number

    Returns nsIAppWindow

createWindowlessBrowser

  • This is the constructor for creating an invisible DocShell. It is used to simulate DOM windows without an actual physical representation.

    Parameters

    • aIsChrome: bool

      Set true if you want to use it for chrome content.

    • aChromeMask: uint32_t

      Used to specify chrome flags that should be set on the window. See nsIWebBrowserChrome for flag definitions.

    Returns nsIWindowlessBrowser

destroyHiddenWindow

  • Returns void

registerTopLevelWindow

  • 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.

    Note

    When this method is successful, it fires the global notification "xul-window-registered"

    Parameters

    • aWindow: nsIAppWindow

      the window to register

    Returns void

setScreenId

  • B2G multi-screen support. When open another top-level window on b2g, a screen ID is needed for identifying which screen this window is opened to.

    Parameters

    • aScreenId: uint32_t

      Differentiate screens of windows. It is platform- specific due to the hardware limitation for now.

    Returns void

startEventLoopLagTracking

  • Start/stop tracking lags in the event loop. If the event loop gets unresponsive, a "event-loop-lag" notification is sent. Note that calling startEventLoopLagTracking when tracking is already enabled has no effect.

    Returns

    true if tracking succeeded.

    Returns bool

stopEventLoopLagTracking

  • Returns void

unregisterTopLevelWindow

  • 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: nsIAppWindow

      you see the pattern

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc