| |
Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members
DOM_TreeWalker Class ReferenceDOM_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.
More...
#include <DOM_TreeWalker.hpp>
List of all members.
Detailed Description
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"
Constructor & Destructor Documentation
|
DOM_TreeWalker::DOM_TreeWalker (
|
)
|
|
|
DOM_TreeWalker::DOM_TreeWalker (
|
const DOM_TreeWalker & other )
|
|
|
|
Copy constructor.
-
Parameters:
-
| other
|
The object to be copied. |
|
|
DOM_TreeWalker::~DOM_TreeWalker (
|
)
|
|
|
|
Destructor for DOM_TreeWalker.
|
|
DOM_TreeWalker::DOM_TreeWalker (
|
TreeWalkerImpl * impl ) [protected]
|
|
Member Function Documentation
|
|
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 DOM_TreeWalker::getCurrentNode (
|
)
|
|
|
|
Return the node at which the DOM_TreeWalker is currently positioned.
"Experimental - subject to change" |
|
bool DOM_TreeWalker::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" |
|
|
Return The filter used to screen nodes.
"Experimental - subject to change" |
|
unsigned long DOM_TreeWalker::getWhatToShow (
|
)
|
|
|
|
Return which node types are presented via the DOM_TreeWalker.
These constants are defined in the DOM_NodeFilter interface.
"Experimental - subject to change" |
|
|
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" |
|
|
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" |
|
DOM_Node DOM_TreeWalker::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" |
|
bool DOM_TreeWalker::operator!= (
|
const DOM_NullPtr * other ) const
|
|
|
|
Compare with a pointer.
Intended only to allow a convenient comparison with null. |
|
bool DOM_TreeWalker::operator!= (
|
const DOM_TreeWalker & other ) const
|
|
|
|
The inequality operator.
See operator ==. |
|
DOM_TreeWalker & 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. |
|
|
DOM_TreeWalker & DOM_TreeWalker::operator= (
|
const DOM_TreeWalker & other )
|
|
|
|
Assignment operator.
-
Parameters:
-
| other
|
The object to be copied. |
|
|
bool DOM_TreeWalker::operator== (
|
const DOM_NullPtr * other ) const
|
|
|
|
Compare with a pointer.
Intended only to allow a convenient comparison with null. |
|
bool DOM_TreeWalker::operator== (
|
const DOM_TreeWalker & other ) const
|
|
|
|
The equality operator.
-
Parameters:
-
| other
|
The object reference with which this object is compared |
-
Returns:
-
True if both
DOM_TreeWalkers refer to the same actual node, or are both null; return false otherwise.
|
|
|
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 DOM_TreeWalker::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 DOM_TreeWalker::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" |
|
void DOM_TreeWalker::setCurrentNode (
|
DOM_Node currentNode )
|
|
|
|
Set the node at which the DOM_TreeWalker is currently positioned.
"Experimental - subject to change" |
Friends And Related Function Documentation
class DOM_Document [friend]
|
|
The documentation for this class was generated from the following file:
|
