nsIDocShellTreeItem Interface Reference

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

import "nsIDocShellTreeItem.idl";

Inheritance diagram for nsIDocShellTreeItem:

Collaboration diagram for nsIDocShellTreeItem:

List of all members.

Public Member Functions
boolean	nameEquals (in wstring name)
	Compares the provided name against the item's name and returns the appropriate result.
nsIDocShellTreeItem	findItemWithName (in wstring name, in nsISupports aRequestor, in nsIDocShellTreeItem aOriginalRequestor)
void	setTreeOwner (in nsIDocShellTreeOwner treeOwner)
Public Attributes
attribute wstring	name
const long	typeChrome = 0
const long	typeContent = 1
const long	typeContentWrapper = 2
const long	typeChromeWrapper = 3
const long	typeAll = 0x7FFFFFFF
attribute long	itemType
readonly attribute nsIDocShellTreeItem	parent
readonly attribute nsIDocShellTreeItem	sameTypeParent
readonly attribute nsIDocShellTreeItem	rootTreeItem
readonly attribute nsIDocShellTreeItem	sameTypeRootTreeItem
readonly attribute nsIDocShellTreeOwner	treeOwner

---

Detailed Description

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.

---

Member Function Documentation

nsIDocShellTreeItem nsIDocShellTreeItem::findItemWithName	(	in wstring	name,
		in nsISupports	aRequestor,
		in nsIDocShellTreeItem	aOriginalRequestor
	)

boolean nsIDocShellTreeItem::nameEquals

(

in wstring

name

)

Compares the provided name against the item's name and returns the appropriate result.

Returns:

PR_TRUE if names match; PR_FALSE otherwise.

void nsIDocShellTreeItem::setTreeOwner

(

in nsIDocShellTreeOwner

treeOwner

)

---

Member Data Documentation

attribute long nsIDocShellTreeItem::itemType

attribute wstring nsIDocShellTreeItem::name

readonly attribute nsIDocShellTreeItem nsIDocShellTreeItem::parent

readonly attribute nsIDocShellTreeItem nsIDocShellTreeItem::rootTreeItem

readonly attribute nsIDocShellTreeItem nsIDocShellTreeItem::sameTypeParent

readonly attribute nsIDocShellTreeItem nsIDocShellTreeItem::sameTypeRootTreeItem

readonly attribute nsIDocShellTreeOwner nsIDocShellTreeItem::treeOwner

const long nsIDocShellTreeItem::typeAll = 0x7FFFFFFF

const long nsIDocShellTreeItem::typeChrome = 0

const long nsIDocShellTreeItem::typeChromeWrapper = 3

const long nsIDocShellTreeItem::typeContent = 1

const long nsIDocShellTreeItem::typeContentWrapper = 2

---

The documentation for this interface was generated from the following file:

• nsIDocShellTreeItem.idl