nsIDocShellTreeItem
| IID: | 09b54ec1-d98a-49a9-bc95-3219e8b55089 |
| Inherits From: | nsIDocShellTreeNode |
This interface is implemented by the following components:
Constants
| PRInt32 | typeChrome | = 0 |
| PRInt32 | typeContent | = 1 |
| PRInt32 | typeContentWrapper | = 2 |
| PRInt32 | typeChromeWrapper | = 3 |
| PRInt32 | typeAll | = 2147483647 |
Properties
PRInt32 itemType
PRUnichar* name
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.
readonly nsIDocShellTreeItem parent
readonly nsIDocShellTreeItem rootTreeItem
readonly nsIDocShellTreeItem sameTypeParent
readonly nsIDocShellTreeItem sameTypeRootTreeItem
readonly nsIDocShellTreeOwner treeOwner
Methods
nsIDocShellTreeItem findItemWithName ( PRUnichar* name , nsISupports requestor , nsIDocShellTreeItem originalRequestor )
PRBool nameEquals ( PRUnichar* name )
[noscript] void setTreeOwner ( nsIDocShellTreeOwner treeOwner )
nsIDocShellTreeItem findItemWithName ( PRUnichar* name , nsISupports requestor , nsIDocShellTreeItem originalRequestor )
- Arguments:
- name
- requestor
- originalRequestor
PRBool nameEquals ( PRUnichar* name )
Compares the provided name against the item's name and returns the appropriate result.
- Arguments:
- name
- Returns:
PR_TRUEif names match;PR_FALSEotherwise.
void setTreeOwner ( nsIDocShellTreeOwner treeOwner )
- Arguments:
- treeOwner
References
This interface is the type of the following properties:
nsIDocShellTreeItem.parent, nsIDocShellTreeItem.rootTreeItem, nsIDocShellTreeItem.sameTypeParent, nsIDocShellTreeItem.sameTypeRootTreeItem, nsIDocShellTreeOwner.primaryContentShell, nsIXULWindow.primaryContentShell
This interface is passed as an argument to the following methods:
nsIDocShellTreeItem.findItemWithName, nsIDocShellTreeNode.addChild, nsIDocShellTreeNode.findChildWithName, nsIDocShellTreeNode.removeChild, nsIDocShellTreeOwner.contentShellAdded, nsIDocShellTreeOwner.contentShellRemoved, nsIDocShellTreeOwner.findItemWithName, nsIDocShellTreeOwner.sizeShellTo, nsISHEntry.addChildShell, nsPIWindowWatcher.findItemWithName
This interface is returned from the following methods:
nsIDocShellTreeItem.findItemWithName, nsIDocShellTreeNode.findChildWithName, nsIDocShellTreeNode.getChildAt, nsIDocShellTreeOwner.findItemWithName, nsISHEntry.childShellAt, nsIXULWindow.getContentShellById, nsPIWindowWatcher.findItemWithName
Reference documentation is generated from Mozilla's source.