KDE 3.5 API Reference KHTML
DOM::NodeFilter Class Reference
Filters are objects that know how to "filter out" nodes. More...
#include <dom2_traversal.h>
Public Types | |
| enum | AcceptCode { FILTER_ACCEPT = 1, FILTER_REJECT = 2, FILTER_SKIP = 3 } |
| enum | ShowCode { SHOW_ALL = 0xFFFFFFFF, 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 Member Functions | |
| virtual short | acceptNode (const Node &n) |
| CustomNodeFilter * | customNodeFilter () |
| virtual NodeFilterImpl * | handle () const |
| virtual bool | isNull () const |
| NodeFilter (NodeFilterImpl *i) | |
| NodeFilter (const NodeFilter &other) | |
| NodeFilter () | |
| virtual NodeFilter & | operator= (const NodeFilter &other) |
| void | setCustomNodeFilter (CustomNodeFilter *custom) |
| virtual | ~NodeFilter () |
Static Public Member Functions | |
| static NodeFilter | createCustom (CustomNodeFilter *custom) |
Protected Attributes | |
| NodeFilterImpl * | impl |
Detailed Description
Filters are objects that know how to "filter out" nodes.
If an Iterator or TreeWalker is given a filter, before it returns the next node, it applies the filter. 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.
To create your own custom NodeFilter, define a subclass of CustomNodeFilter which overrides the acceptNode() method and assign an instance of it to the NodeFilter. For more details see the CustomNodeFilter class
Definition at line 184 of file dom2_traversal.h.
Member Enumeration Documentation
The following constants are returned by the acceptNode() method:.
Definition at line 204 of file dom2_traversal.h.
These are the available values for the whatToShow parameter.
They are the same as the set of possible types for Node, and their values are derived by using a bit position corresponding to the value of NodeType for the equivalent node type.
- Enumerator:
Definition at line 217 of file dom2_traversal.h.
Constructor & Destructor Documentation
| NodeFilter::NodeFilter | ( | ) |
Definition at line 133 of file dom2_traversal.cpp.
| NodeFilter::NodeFilter | ( | const NodeFilter & | other | ) |
Definition at line 138 of file dom2_traversal.cpp.
| NodeFilter::NodeFilter | ( | NodeFilterImpl * | i | ) |
Definition at line 144 of file dom2_traversal.cpp.
| NodeFilter::~NodeFilter | ( | ) | [virtual] |
Definition at line 160 of file dom2_traversal.cpp.
Member Function Documentation
| short NodeFilter::acceptNode | ( | const Node & | n | ) | [virtual] |
Test whether a specified node is visible in the logical view of a TreeWalker or NodeIterator.
This function will be called by the implementation of TreeWalker and NodeIterator; it is not intended to be called directly from user code.
- Parameters:
-
n 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, as defined above .
Definition at line 165 of file dom2_traversal.cpp.
| NodeFilter NodeFilter::createCustom | ( | CustomNodeFilter * | custom | ) | [static] |
Definition at line 192 of file dom2_traversal.cpp.
| CustomNodeFilter * NodeFilter::customNodeFilter | ( | ) |
Definition at line 176 of file dom2_traversal.cpp.
| NodeFilterImpl * NodeFilter::handle | ( | ) | const [virtual] |
| bool NodeFilter::isNull | ( | ) | const [virtual] |
Definition at line 187 of file dom2_traversal.cpp.
| NodeFilter & NodeFilter::operator= | ( | const NodeFilter & | other | ) | [virtual] |
Definition at line 150 of file dom2_traversal.cpp.
| void NodeFilter::setCustomNodeFilter | ( | CustomNodeFilter * | custom | ) |
Definition at line 171 of file dom2_traversal.cpp.
Member Data Documentation
NodeFilterImpl* DOM::NodeFilter::impl [protected] |
Definition at line 261 of file dom2_traversal.h.
The documentation for this class was generated from the following files:
