# khtml Library API Documentation

Overview | Class Hierarchy | Classes | Classes (annotated) | Members | Namespaces | Source Files

# DOM::NodeIterator Class Reference

NodeIterators are used to step through a set of nodes, e.g. More...

`#include <dom2_traversal.h>`

List of all members.

## Public Member Functions

| NodeIterator (const NodeIterator &other)
NodeIterator & | operator= (const NodeIterator &other)
Node | root ()
unsigned long | whatToShow ()
NodeFilter | filter ()
bool | expandEntityReferences ()
Node | nextNode ()
Node | previousNode ()
void | detach ()
NodeIteratorImpl * | handle () const
bool | isNull () const

## Protected Member Functions

| NodeIterator (NodeIteratorImpl *i)

## Protected Attributes

NodeIteratorImpl * | impl

## Friends

class | NodeIteratorImpl
class | Document

## Detailed Description

NodeIterators are used to step through a set of nodes, e.g.

the set of nodes in a NodeList, the document subtree governed by a particular node, the results of a query, or any other set of nodes. The set of nodes to be iterated is determined by the implementation of the NodeIterator. DOM Level 2 specifies a single NodeIterator implementation for document-order traversal of a document subtree. Instances of these iterators are created by calling DocumentTraversal.createNodeIterator().

Any Iterator that returns nodes may implement the `NodeIterator` interface. Users and vendor libraries may also choose to create Iterators that implement the `NodeIterator` interface.

Definition at line 60 of file dom2_traversal.h.

## Member Function Documentation

Node NodeIterator::root | ( |  | ) |

| The root node of the NodeIterator, as specified when it was created. Definition at line 62 of file dom2_traversal.cpp.

unsigned long NodeIterator::whatToShow | ( |  | ) |

| This attribute determines which node types are presented via the iterator. The available set of constants is defined in the NodeFilter interface. Nodes not accepted by whatToShow will be skipped, but their children may still be considered. Note that this skip takes precedence over the filter, if any. Definition at line 68 of file dom2_traversal.cpp.

NodeFilter NodeIterator::filter | ( |  | ) |

| The NodeFilter used to screen nodes. Definition at line 74 of file dom2_traversal.cpp.

bool NodeIterator::expandEntityReferences | ( |  | ) |

The value of this flag determines whether the children of entity reference nodes are visible to the iterator.

If false, they and their descendents will be rejected. Note that this rejection takes precedence over whatToShow and the filter. Also note that this is currently the only situation where NodeIterators may reject a complete subtree rather than skipping individual nodes.

To produce a view of the document that has entity references expanded and does not expose the entity reference node itself, use the whatToShow flags to hide the entity reference node and set expandEntityReferences to true when creating the iterator. To produce a view of the document that has entity reference nodes but no entity expansion, use the whatToShow flags to show the entity reference node and set expandEntityReferences to false.

Definition at line 80 of file dom2_traversal.cpp.

Node NodeIterator::nextNode | ( |  | ) |

Returns the next node in the set and advances the position of the Iterator in the set.

After a NodeIterator is created, the first call to nextNode() returns the first node in the set.

Returns:
  The next `Node` in the set being iterated over, or `null` if there are no more members in that set.

Exceptions:

  | Exceptions | from user code Any exceptions raised by a user-written Filter will propagate through.

Definition at line 86 of file dom2_traversal.cpp.

Node NodeIterator::previousNode | ( |  | ) |

Returns the previous node in the set and moves the position of the Iterator backwards in the set.

Returns:
  The previous `Node` in the set being iterated over, or `null` if there are no more members in that set.

Exceptions:

  | Exceptions | from user code Any exceptions raised by a user-written Filter will propagate through.

Definition at line 98 of file dom2_traversal.cpp.

void NodeIterator::detach | ( |  | ) |

| Detaches the NodeIterator 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. Definition at line 110 of file dom2_traversal.cpp.

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

- dom2_traversal.h
- dom2_traversal.cpp

This file is part of the documentation for khtml Library Version 3.4.1.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat Jun 11 20:33:42 2005 by doxygen 1.4.1 written by Dimitri van Heesch, © 1997-2003