Interface nsIAppWindowType

Hierarchy

Properties

XULBrowserWindow chromeFlags docShell initialOpenWindowInfo intrinsicallySized outerToInnerHeightDifferenceInCSSPixels outerToInnerWidthDifferenceInCSSPixels primaryContentBrowsingContext primaryContentShell primaryRemoteTab zLevel

Methods

AddRef QueryInterface Release addChildWindow assumeChromeFlagsAreFrozen beforeStartLayout center createNewWindow getLiveResizeListeners lockAspectRatio needFastSnaphot remoteTabAdded remoteTabRemoved removeChildWindow showModal

Properties

XULBrowserWindow

XULBrowserWindow: nsIXULBrowserWindow

chromeFlags

chromeFlags: uint32_t

Readonly docShell

docShell: nsIDocShell

The docshell owning the XUL for this window.

Readonly initialOpenWindowInfo

initialOpenWindowInfo: nsIOpenWindowInfo

If the window was opened as a content window, this will return the initial nsIOpenWindowInfo to use.

intrinsicallySized

intrinsicallySized: boolean

Indicates if this window is instrinsically sized.

Readonly outerToInnerHeightDifferenceInCSSPixels

outerToInnerHeightDifferenceInCSSPixels: number

Returns the difference between the inner window size (client size) and the outer window size, in CSS pixels.

Readonly outerToInnerWidthDifferenceInCSSPixels

outerToInnerWidthDifferenceInCSSPixels: number

Readonly primaryContentBrowsingContext

primaryContentBrowsingContext: BrowsingContext

Helper for getting the BrowsingContext from either primaryContentShell or primaryRemoteTab depending on which is available.

Readonly primaryContentShell

primaryContentShell: nsIDocShellTreeItem

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.

Readonly primaryRemoteTab

primaryRemoteTab: nsIRemoteTab

In multiprocess case we may not have primaryContentShell but primaryRemoteTab.

zLevel

zLevel: number

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

addChildWindow

  • Tell this window that it has picked up a child XUL window

    Parameters

    • aChild: nsIAppWindow

      the child window being added

    Returns void

assumeChromeFlagsAreFrozen

  • Begin assuming |chromeFlags| don't change hereafter, and assert if they do change. The state change is one-way and idempotent.

    Returns void

beforeStartLayout

  • Back-door method to make sure some stuff is done when the document is ready for layout, that would cause expensive computation otherwise later.

    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.

    Returns void

center

  • Move the window to a centered position.

    Parameters

    • aRelative: nsIAppWindow

      If not null, the window relative to which the window is moved. See aScreen parameter for details.

    • aScreen: boolean

      PR_TRUE to center the window relative to the screen containing aRelative if aRelative is not null. If aRelative is null then relative to the screen of the opener window if it was initialized by passing it to nsWebShellWindow::Initialize. Failing that relative to the main screen. PR_FALSE to center it relative to aRelative itself.

    • aAlert: boolean

      PR_TRUE to move the window to an alert position, generally centered horizontally and 1/3 down from the top.

    Returns void

createNewWindow

  • Create a new window.

    Returns

    the newly minted window

    Parameters

    • aChromeFlags: int32_t

      see nsIWebBrowserChrome

    • aOpenWindowInfo: nsIOpenWindowInfo

      information about the request for a content window to be opened. Will be null for non-content loads.

    Returns nsIAppWindow

getLiveResizeListeners

  • Returns LiveResizeListenerArray

lockAspectRatio

  • Locks the aspect ratio for a window.

    Parameters

    • aShouldLock: bool

      boolean

    Returns void

needFastSnaphot

  • Request fast snapshot at RenderCompositor of WebRender. Since readback of Windows DirectComposition is very slow.

    Returns void

remoteTabAdded

  • Parameters

    • aTab: nsIRemoteTab
    • aPrimary: boolean

    Returns void

remoteTabRemoved

  • Parameters

    • aTab: nsIRemoteTab

    Returns void

removeChildWindow

  • Tell this window that it has lost a child XUL window

    Parameters

    • aChild: nsIAppWindow

      the child window being removed

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

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc