---

IDOM_TreeWalker Class Reference

Inheritance diagram for IDOM_TreeWalker:

List of all members.

Public Methods
Get functions.
virtual IDOM_Node *	getRoot ()=0
virtual unsigned long	getWhatToShow ()=0
virtual IDOM_NodeFilter *	getFilter ()=0
virtual bool	getExpandEntityReferences ()=0
virtual IDOM_Node *	getCurrentNode ()=0
virtual IDOM_Node *	parentNode ()=0
virtual IDOM_Node *	firstChild ()=0
virtual IDOM_Node *	lastChild ()=0
virtual IDOM_Node *	previousSibling ()=0
virtual IDOM_Node *	nextSibling ()=0
virtual IDOM_Node *	previousNode ()=0
virtual IDOM_Node *	nextNode ()=0
Set functions.
virtual void	setCurrentNode (IDOM_Node *currentNode)=0
Protected Methods
	IDOM_TreeWalker (const IDOM_TreeWalker &other)
IDOM_TreeWalker &	operator= (const IDOM_TreeWalker &other)

---

Detailed Description

IDOM_TreeWalker objects are used to navigate a document tree or subtree using the view of the document defined by its whatToShow flags and any filters that are defined for the IDOM_TreeWalker. Any function which performs navigation using a IDOM_TreeWalker will automatically support any view defined by a IDOM_TreeWalker.

Omitting nodes from the logical view of a subtree can result in a structure that is substantially different from the same subtree in the complete, unfiltered document. Nodes that are siblings in the IDOM_TreeWalker view may be children of different, widely separated nodes in the original view. For instance, consider a Filter that skips all nodes except for Text nodes and the root node of a document. In the logical view that results, all text nodes will be siblings and appear as direct children of the root node, no matter how deeply nested the structure of the original document.

---

Member Function Documentation

virtual IDOM_Node* IDOM_TreeWalker::firstChild (    )  [pure virtual]

Moves the IDOM_TreeWalker to the first child of the current node, and returns the new node. If the current node has no children, returns null, and retains the current node.

virtual IDOM_Node* IDOM_TreeWalker::getCurrentNode (    )  [pure virtual]

Return the node at which the IDOM_TreeWalker is currently positioned.

virtual bool IDOM_TreeWalker::getExpandEntityReferences (    )  [pure virtual]

Return the expandEntityReferences flag. The value of this flag determines whether the children of entity reference nodes are visible to the IDOM_TreeWalker. If false, they will be skipped over.

virtual IDOM_NodeFilter* IDOM_TreeWalker::getFilter (    )  [pure virtual]

Return The filter used to screen nodes.

virtual IDOM_Node* IDOM_TreeWalker::getRoot (    )  [pure virtual]

The root node of the TreeWalker, as specified when it was created.

virtual unsigned long IDOM_TreeWalker::getWhatToShow (    )  [pure virtual]

Return which node types are presented via the IDOM_TreeWalker. These constants are defined in the IDOM_NodeFilter interface.

virtual IDOM_Node* IDOM_TreeWalker::lastChild (    )  [pure virtual]

Moves the IDOM_TreeWalker to the last child of the current node, and returns the new node. If the current node has no children, returns null, and retains the current node.

virtual IDOM_Node* IDOM_TreeWalker::nextNode (    )  [pure virtual]

Moves the IDOM_TreeWalker to the next visible node in document order relative to the current node, and returns the new node. If the current node has no next node, or if the search for nextNode attempts to step upward from the IDOM_TreeWalker's root node, returns null, and retains the current node.

virtual IDOM_Node* IDOM_TreeWalker::nextSibling (    )  [pure virtual]

Moves the IDOM_TreeWalker to the next sibling of the current node, and returns the new node. If the current node has no next sibling, returns null, and retains the current node.

virtual IDOM_Node* IDOM_TreeWalker::parentNode (    )  [pure virtual]

Moves to and returns the closest visible ancestor node of the current node. If the search for parentNode attempts to step upward from the IDOM_TreeWalker's root node, or if it fails to find a visible ancestor node, this method retains the current position and returns null.

virtual IDOM_Node* IDOM_TreeWalker::previousNode (    )  [pure virtual]

Moves the IDOM_TreeWalker to the previous visible node in document order relative to the current node, and returns the new node. If the current node has no previous node, or if the search for previousNode attempts to step upward from the IDOM_TreeWalker's root node, returns null, and retains the current node.

virtual IDOM_Node* IDOM_TreeWalker::previousSibling (    )  [pure virtual]

Moves the IDOM_TreeWalker to the previous sibling of the current node, and returns the new node. If the current node has no previous sibling, returns null, and retains the current node.

virtual void IDOM_TreeWalker::setCurrentNode (  IDOM_Node *    currentNode )  [pure virtual]

Set the node at which the IDOM_TreeWalker is currently positioned.

---

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

• IDOM_TreeWalker.hpp

---