---

IDOM_NodeFilter Class Reference

List of all members.

Public Types
Enumerators for Node Filter
enum	FilterAction { FILTER_ACCEPT = 1, FILTER_REJECT = 2, FILTER_SKIP = 3 }
enum	ShowType {   SHOW_ALL = 0x0000FFFF, SHOW_ELEMENT = 0x00000001, SHOW_ATTRIBUTE = 0x00000002, SHOW_TEXT = 0x00000004,   SHOW_CDATA_SECTION = 0x00000008, SHOW_ENTITY_REFERENCE = 0x00000010, SHOW_ENTITY = 0x00000020, SHOW_PROCESSING_INSTRUCTION = 0x00000040,   SHOW_COMMENT = 0x00000080, SHOW_DOCUMENT = 0x00000100, SHOW_DOCUMENT_TYPE = 0x00000200, SHOW_DOCUMENT_FRAGMENT = 0x00000400,   SHOW_NOTATION = 0x00000800 }
Public Methods
Test function.
virtual short	acceptNode (const IDOM_Node *node) const=0
Protected Methods
	IDOM_NodeFilter (const IDOM_NodeFilter &other)
IDOM_NodeFilter &	operator= (const IDOM_NodeFilter &other)

---

Detailed Description

Filters are objects that know how to "filter out" nodes. If a IDOM_NodeIterator or IDOM_TreeWalker is given a filter, it applies the filter before it returns the next node.

If the filter says to accept the node, the iterator returns it; otherwise, the iterator looks for the next node and pretends that the node that was rejected was not there.

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

Filters do not need to know how to iterate, nor do they need to know anything about the data structure that is being iterated. 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 iterators, encouraging code reuse.

---

Member Function Documentation

virtual short IDOM_NodeFilter::acceptNode (  const IDOM_Node *    node )  const [pure virtual]

Test whether a specified node is visible in the logical view of a IDOM_TreeWalker or IDOM_NodeIterator. This function will be called by the implementation of IDOM_TreeWalker and IDOM_NodeIterator; it is not intended to be called directly from user code. Parameters: node  The node to check to see if it passes the filter or not. Returns: A constant to determine whether the node is accepted, rejected, or skipped.

---

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

• IDOM_NodeFilter.hpp

---