class DOM_TreeWalker

DOM_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 DOM_TreeWalker

Inheritance:


Public

Constructors and assignment operator
DOM_TreeWalker ()
Default constructor
DOM_TreeWalker (const DOM_TreeWalker &other)
Copy constructor
DOM_TreeWalker& operator = (const DOM_TreeWalker &other)
Assignment operator
DOM_TreeWalker& operator = (const DOM_NullPtr *val)
Assignment operator
Destructor.
~DOM_TreeWalker ()
Destructor for DOM_TreeWalker
Detaching functions.
void detach ()
Detaches the iterator from the set which it iterated over, releasing any computational resources and placing the iterator in the INVALID state
Equality and Inequality operators.
bool operator == (const DOM_TreeWalker & other) const
The equality operator
bool operator == (const DOM_NullPtr *other) const
Compare with a pointer
bool operator != (const DOM_TreeWalker & other) const
The inequality operator
bool operator != (const DOM_NullPtr * other) const
Compare with a pointer
Get functions.
unsigned long getWhatToShow ()
Return which node types are presented via the DOM_TreeWalker
DOM_NodeFilter* getFilter ()
Return The filter used to screen nodes
bool getExpandEntityReferences ()
Return the expandEntityReferences flag
DOM_Node getCurrentNode ()
Return the node at which the DOM_TreeWalker is currently positioned
DOM_Node parentNode ()
Moves to and returns the closest visible ancestor node of the current node
DOM_Node firstChild ()
Moves the DOM_TreeWalker to the first child of the current node, and returns the new node
DOM_Node lastChild ()
Moves the DOM_TreeWalker to the last child of the current node, and returns the new node
DOM_Node previousSibling ()
Moves the DOM_TreeWalker to the previous sibling of the current node, and returns the new node
DOM_Node nextSibling ()
Moves the DOM_TreeWalker to the next sibling of the current node, and returns the new node
DOM_Node previousNode ()
Moves the DOM_TreeWalker to the previous visible node in document order relative to the current node, and returns the new node
DOM_Node nextNode ()
Moves the DOM_TreeWalker to the next visible node in document order relative to the current node, and returns the new node
Set functions.
void setCurrentNode (DOM_Node currentNode)
Set the node at which the DOM_TreeWalker is currently positioned

Documentation

DOM_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 DOM_TreeWalker. Any function which performs navigation using a DOM_TreeWalker will automatically support any view defined by a DOM_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 DOM_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.

"Experimental - subject to change"

Constructors and assignment operator

DOM_TreeWalker()
Default constructor

DOM_TreeWalker(const DOM_TreeWalker &other)
Copy constructor.
Parameters:
other - The object to be copied.

DOM_TreeWalker& operator = (const DOM_TreeWalker &other)
Assignment operator.
Parameters:
other - The object to be copied.

DOM_TreeWalker& operator = (const DOM_NullPtr *val)
Assignment operator. This overloaded variant is provided for the sole purpose of setting a DOM_NodeIterator to null.
Parameters:
val. - Only a value of 0, or null, is allowed.

Destructor.

~DOM_TreeWalker()
Destructor for DOM_TreeWalker

Equality and Inequality operators.

bool operator == (const DOM_TreeWalker & other) const
The equality operator.
Returns:
s True if both DOM_TreeWalkers refer to the same actual node, or are both null; return false otherwise.
Parameters:
other - The object reference with which this object is compared

bool operator == (const DOM_NullPtr *other) const
Compare with a pointer. Intended only to allow a convenient comparison with null.

bool operator != (const DOM_TreeWalker & other) const
The inequality operator. See operator ==.

bool operator != (const DOM_NullPtr * other) const
Compare with a pointer. Intended only to allow a convenient comparison with null.

Get functions.

unsigned long getWhatToShow()
Return which node types are presented via the DOM_TreeWalker. These constants are defined in the DOM_NodeFilter interface.

"Experimental - subject to change"

DOM_NodeFilter* getFilter()
Return The filter used to screen nodes.

"Experimental - subject to change"

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

"Experimental - subject to change"

DOM_Node getCurrentNode()
Return the node at which the DOM_TreeWalker is currently positioned.

"Experimental - subject to change"

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

"Experimental - subject to change"

DOM_Node firstChild()
Moves the DOM_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.

"Experimental - subject to change"

DOM_Node lastChild()
Moves the DOM_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.

"Experimental - subject to change"

DOM_Node previousSibling()
Moves the DOM_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.

"Experimental - subject to change"

DOM_Node nextSibling()
Moves the DOM_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.

"Experimental - subject to change"

DOM_Node previousNode()
Moves the DOM_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 DOM_TreeWalker's root node, returns null, and retains the current node.

"Experimental - subject to change"

DOM_Node nextNode()
Moves the DOM_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 DOM_TreeWalker's root node, returns null, and retains the current node.

"Experimental - subject to change"

Set functions.

void setCurrentNode(DOM_Node currentNode)
Set the node at which the DOM_TreeWalker is currently positioned.

"Experimental - subject to change"

Detaching functions.

void detach()
Detaches the iterator from the set which it iterated over, releasing any computational resources and placing the iterator in the INVALID state. After detach has been invoked, calls to nextNode or previousNode will raise the exception INVALID_STATE_ERR.

"Experimental - subject to change"


This class has no child classes.

alphabetic index hierarchy of classes


Xerces-C XML Parser for C++ Version 1.1
Copyright © 2000 The Apache Software Foundation. All Rights Reserved.

generated by doc++