XMLParserItf Interface CATIDOMNodeFilter

Usage: you can freely reimplement this interface.

interface CATIDOMNodeFilter

Interface for filters objects that know how to "filter out" nodes.
If a or is given a , it applies the filter before it returns the next node. If the filter says to accept the node, the traversal logic returns it; otherwise, traversal looks for the next node and pretends that the node that was rejected was not there.

The DOM does not provide any filters. is just an interface that users can implement to provide their own filters.

instances do not need to know how to traverse from node to node, nor do they need to know anything about the data structure that is being traversed. This makes it very easy to write filters, since the only thing they have to know how to do is evaluate a single node. One filter may be used with a number of different kinds of traversals, encouraging code reuse.

See also the Document Object Model (DOM) Level 2 Traversal and Range Specification.

Method Index

o AcceptNode(CATIDOMNode_var&,FilterAction&)

Tests whether a specified node is visible in the logical view of a CATIDOMTreeWalker or CATIDOMNodeIterator.

Enumerated Type Index

o FilterAction

Constants returned by

Methods

Tests whether a specified node is visible in the logical view of a CATIDOMTreeWalker or CATIDOMNodeIterator. This function will be called by the implementation of and ; it is not normally called directly from user code. (Though you could do so if you wanted to use the same filter to guide your own application logic.)

Parameters:

iNode

The node to check to see if it passes the filter or not.

oAccepted

a constant to determine whether the node is accepted, rejected, or skipped, as defined above.

Enumerated Types