Readonly
browsingBrowsingContext associated with the DocShell.
Readonly
childThe current number of DocShells which are immediate children of the this object.
@deprecated: Prefer using BrowsingContext::Children()
, as this count will
not include out-of-process iframes.
Readonly
domReturns the DOM outer window for the content viewer.
Readonly
itemThe type this item is.
name of the DocShellTreeItem
Readonly
parentParent DocShell.
@deprecated: Use BrowsingContext::GetParent()
instead.
(NOTE: BrowsingContext::GetParent()
will not cross isolation boundaries)
Readonly
rootReturns the root DocShellTreeItem. This is a convience equivalent to getting the parent and its parent until there isn't a parent.
@deprecated: Use BrowsingContext::Top()
instead.
(NOTE: BrowsingContext::Top()
will not cross isolation boundaries)
Readonly
sameThis getter returns the same thing parent does however if the parent is of a different itemType, or if the parent is an
@deprecated: Use BrowsingContext::GetParent()
instead.
Readonly
sameReturns the root DocShellTreeItem of the same type. This is a convience equivalent to getting the parent of the same type and its parent until there isn't a parent.
@deprecated: Use BrowsingContext::Top()
instead.
Readonly
treeThe owner of the DocShell Tree. This interface will be called upon when the docshell has things it needs to tell to the owner of the docshell. Note that docShell tree ownership does not cross tree types. Meaning setting ownership on a chrome tree does not set ownership on the content sub-trees. A given tree's boundaries are identified by the type changes. Trees of different types may be connected, but should not be traversed for things such as ownership.
Note implementers of this interface should NOT effect the lifetime of the parent DocShell by holding this reference as it creates a cycle. Owners when releasing this interface should set the treeOwner to nullptr. Implementers of this interface are guaranteed that when treeOwner is set that the poitner is valid without having to addref.
Further note however when others try to get the interface it should be addref'd before handing it to them.
Optional
aInstancePtr: objectA run time mechanism for interface discovery.
NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.
aInstancePtr must not be null.
[in] A requested interface IID
[out] A pointer to an interface pointer to receive the result.
Add a new child DocShellTreeItem. Adds to the end of the list. Note that this does NOT take a reference to the child. The child stays alive only as long as it's referenced from outside the docshell tree.
NS_ERROR_ILLEGAL_VALUE if child corresponds to the same object as this treenode or an ancestor of this treenode
NS_ERROR_UNEXPECTED if this node is a leaf in the tree.
Return the child at the index requested. This is 0-based.
@deprecated: Prefer using BrowsingContext::Children()
, as this will not
include out-of-process iframes.
NS_ERROR_UNEXPECTED if the index is out of range
Generated using TypeDoc
The nsIDocShellTreeItem supplies the methods that are required of any item that wishes to be able to live within the docshell tree either as a middle node or a leaf.