Interface nsIDocShellTreeOwnerType

Hierarchy

Properties

hasPrimaryContent primaryContentBrowsingContext primaryContentShell primaryRemoteTab tabCount

Methods

AddRef QueryInterface Release contentShellAdded contentShellRemoved getPersistence getPrimaryContentSize getRootShellSize remoteTabAdded remoteTabRemoved setPersistence setPrimaryContentSize setRootShellSize sizeShellTo

Properties

Readonly hasPrimaryContent

hasPrimaryContent: bool

Returns true if there is a primary content shell or a primary remote tab.

Readonly primaryContentBrowsingContext

primaryContentBrowsingContext: BrowsingContext

Get the BrowsingContext associated with either the primary content shell or primary remote tab, depending on which is available.

Readonly primaryContentShell

primaryContentShell: nsIDocShellTreeItem

Returns the Primary Content Shell

Readonly primaryRemoteTab

primaryRemoteTab: nsIRemoteTab

In multiprocess case we may not have primaryContentShell but primaryRemoteTab.

Readonly tabCount

tabCount: number

Gets the number of tabs currently open in our window, assuming this tree owner has such a concept.

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

contentShellAdded

  • Called when a content shell is added to the docshell tree. This is only called for "root" content shells (that is, ones whose parent is a chrome shell).

    Parameters

    • aContentShell: nsIDocShellTreeItem

      the shell being added.

    • aPrimary: boolean

      whether the shell is primary.

    Returns void

contentShellRemoved

  • Called when a content shell is removed from the docshell tree. This is only called for "root" content shells (that is, ones whose parent is a chrome shell). Note that if aContentShell was never added, contentShellRemoved should just do nothing.

    Parameters

    • aContentShell: nsIDocShellTreeItem

      the shell being removed.

    Returns void

getPersistence

  • Gets the current persistence states of the window.

    Parameters

    • aPersistPosition: boolean
    • aPersistSize: boolean
    • aPersistSizeMode: boolean

    Returns void

getPrimaryContentSize

  • Gets the size of the primary content area in device pixels. This should work for both in-process and out-of-process content areas.

    Parameters

    • width: number
    • height: number

    Returns void

getRootShellSize

  • Gets the size of the root docshell in device pixels.

    Parameters

    • width: number
    • height: number

    Returns void

remoteTabAdded

  • Parameters

    • aTab: nsIRemoteTab
    • aPrimary: boolean

    Returns void

remoteTabRemoved

  • Parameters

    • aTab: nsIRemoteTab

    Returns void

setPersistence

  • Sets the persistence of different attributes of the window.

    Parameters

    • aPersistPosition: boolean
    • aPersistSize: boolean
    • aPersistSizeMode: boolean

    Returns void

setPrimaryContentSize

  • Sets the size of the primary content area in device pixels. This should work for both in-process and out-of-process content areas.

    Parameters

    • width: number
    • height: number

    Returns void

setRootShellSize

  • Sets the size of the root docshell in device pixels.

    Parameters

    • width: number
    • height: number

    Returns void

sizeShellTo

  • Tells the tree owner to size its window or parent window in such a way that the shell passed along will be the size specified.

    Parameters

    • shell: nsIDocShellTreeItem
    • cx: number
    • cy: number

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc