All Frameworks Class Hierarchy This Framework Previous Next Indexes
XMLParser Interface CATIDOMNodeFilter
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIDOMNodeFilter
Usage: you can freely reimplement this interface.
interface CATIDOMNodeFilter
Interface for filters objects that know how to "filter out" nodes.
If a
CATIDOMNodeIterator or
CATIDOMTreeWalker is given a
CATIDOMNodeFilter, 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.
CATIDOMNodeFilter is just an interface that users can implement to provide their own filters.
CATIDOMNodeFilter 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
o AcceptNode
public virtual HRESULT AcceptNode( | const CATIDOMNode_var& | iNode, |
| FilterAction& | oAccepted) = 0 |
-
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
CATIDOMTreeWalker and
CATIDOMNodeIterator ; 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
o FilterAction
-
enum FilterAction {
FILTER_ACCEPT,
FILTER_REJECT,
FILTER_SKIP
}
Constants returned by
AcceptNode
- Parameters:
-
- FILTER_ACCEPT
- Accept the node. Navigation methods defined for
CATIDOMNodeIterator or
CATIDOMTreeWalker will return this node.
- FILTER_REJECT
- Reject the node. Navigation methods defined for
CATIDOMNodeIterator or
CATIDOMTreeWalker will not return this node. For
CATIDOMTreeWalker, the children of this node will also be rejected. NodeIterators treat this as a
synonym for FILTER_SKIP.
- FILTER_SKIP
- Skip this single node. Navigation methods defined for
CATIDOMNodeIterator or
CATIDOMTreeWalker will not return this node. For both
CATIDOMNodeIterator and
CATIDOMTreeWalker, the children of this node will still be considered.
This object is included in the file: CATIDOMNodeFilter.h
If needed, your Imakefile.mk should include the module: CATXMLParserItf