source: NonGTP/Xerces/xerces/doc/html/apiDocs/classDOMNodeFilter.html @ 358

Revision 358, 29.1 KB checked in by bittner, 19 years ago (diff)

xerces added
Line 
1<HTML><HEAD><SCRIPT language="JavaScript" src="../resources/script.js" type="text/javascript"></SCRIPT><TITLE>DOMNodeFilter class Reference</TITLE><link href="XercesApi.css" rel="stylesheet" type="text/css"></HEAD><BODY alink="#ff0000" bgcolor="#ffffff" leftmargin="4" link="#0000ff" marginheight="4" marginwidth="4" text="#000000" topmargin="4" vlink="#0000aa"><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD align="left" height="60" rowspan="3" valign="top" width="135"><IMG border="0" height="60" hspace="0" src="../resources/logo.gif" vspace="0" width="135"></TD><TD align="left" colspan="4" height="5" valign="top" width="456"><IMG border="0" height="5" hspace="0" src="../resources/line.gif" vspace="0" width="456"></TD><TD align="left" height="60" rowspan="3" valign="top" width="29"><IMG border="0" height="60" hspace="0" src="../resources/right.gif" vspace="0" width="29"></TD></TR><TR><TD align="left" bgcolor="#0086b2" colspan="4" height="35" valign="top" width="456"><IMG alt="" border="0" height="35" hspace="0" src="../graphics/api-header.jpg" vspace="0" width="456"></TD></TR><TR><TD align="left" height="20" valign="top" width="168"><IMG border="0" height="20" hspace="0" src="../resources/bottom.gif" vspace="0" width="168"></TD><TD align="left" height="20" valign="top" width="96"><A href="http://xml.apache.org/" onMouseOut="rolloverOff('xml');" onMouseOver="rolloverOn('xml');" target="new"><IMG alt="http://xml.apache.org/" border="0" height="20" hspace="0" name="xml" onLoad="rolloverLoad('xml','../resources/button-xml-hi.gif','../resources/button-xml-lo.gif');" src="../resources/button-xml-lo.gif" vspace="0" width="96"></A></TD><TD align="left" height="20" valign="top" width="96"><A href="http://www.apache.org/" onMouseOut="rolloverOff('asf');" onMouseOver="rolloverOn('asf');" target="new"><IMG alt="http://www.apache.org/" border="0" height="20" hspace="0" name="asf" onLoad="rolloverLoad('asf','../resources/button-asf-hi.gif','../resources/button-asf-lo.gif');" src="../resources/button-asf-lo.gif" vspace="0" width="96"></A></TD><TD align="left" height="20" valign="top" width="96"><A href="http://www.w3.org/" onMouseOut="rolloverOff('w3c');" onMouseOver="rolloverOn('w3c');" target="new"><IMG alt="http://www.w3.org/" border="0" height="20" hspace="0" name="w3c" onLoad="rolloverLoad('w3c','../resources/button-w3c-hi.gif','../resources/button-w3c-lo.gif');" src="../resources/button-w3c-lo.gif" vspace="0" width="96"></A></TD></TR></TABLE><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD align="left" valign="top" width="120"><IMG border="0" height="14" hspace="0" src="../resources/join.gif" vspace="0" width="120"><BR>
2  <A href="../../index.html" onMouseOut="rolloverOff('side-ext-2');" onMouseOver="rolloverOn('side-ext-2');"><IMG alt="Home" border="0" height="12" hspace="0" name="side-ext-2" onLoad="rolloverLoad('side-ext-2','../graphics/ext-2-label-2.jpg','../graphics/ext-2-label-3.jpg');" src="../graphics/ext-2-label-3.jpg" vspace="0" width="120"></A><BR>
3
4  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
5
6  <A href="../index.html" onMouseOut="rolloverOff('side-index');" onMouseOver="rolloverOn('side-index');"><IMG alt="Readme" border="0" height="12" hspace="0" name="side-index" onLoad="rolloverLoad('side-index','../graphics/index-label-2.jpg','../graphics/index-label-3.jpg');" src="../graphics/index-label-3.jpg" vspace="0" width="120"></A><BR>
7  <A href="../releases.html" onMouseOut="rolloverOff('side-releases');" onMouseOver="rolloverOn('side-releases');"><IMG alt="Release Info" border="0" height="12" hspace="0" name="side-releases" onLoad="rolloverLoad('side-releases','../graphics/releases-label-2.jpg','../graphics/releases-label-3.jpg');" src="../graphics/releases-label-3.jpg" vspace="0" width="120"></A><BR>
8  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
9  <A href="../install.html" onMouseOut="rolloverOff('side-install');" onMouseOver="rolloverOn('side-install');"><IMG alt="Installation" border="0" height="12" hspace="0" name="side-install" onLoad="rolloverLoad('side-install','../graphics/install-label-2.jpg','../graphics/install-label-3.jpg');" src="../graphics/install-label-3.jpg" vspace="0" width="120"></A><BR>
10  <A href="http://xml.apache.org/dist/xerces-c/" onMouseOut="rolloverOff('side-ext-18');" onMouseOver="rolloverOn('side-ext-18');"><IMG alt="Download" border="0" height="12" hspace="0" name="side-ext-18" onLoad="rolloverLoad('side-ext-18','../graphics/ext-18-label-2.jpg','../graphics/ext-18-label-3.jpg');" src="../graphics/ext-18-label-3.jpg" vspace="0" width="120"></A><BR>
11  <A href="../build.html" onMouseOut="rolloverOff('side-build');" onMouseOver="rolloverOn('side-build');"><IMG alt="Build" border="0" height="12" hspace="0" name="side-build" onLoad="rolloverLoad('side-build','../graphics/build-label-2.jpg','../graphics/build-label-3.jpg');" src="../graphics/build-label-3.jpg" vspace="0" width="120"></A><BR>
12
13  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
14  <A href="../faqs.html" onMouseOut="rolloverOff('side-faqs');" onMouseOver="rolloverOn('side-faqs');"><IMG alt="FAQs" border="0" height="12" hspace="0" name="side-faqs" onLoad="rolloverLoad('side-faqs','../graphics/faqs-label-2.jpg','../graphics/faqs-label-3.jpg');" src="../graphics/faqs-label-3.jpg" vspace="0" width="120"></A><BR> 
15  <A href="../samples.html" onMouseOut="rolloverOff('side-samples');" onMouseOver="rolloverOn('side-samples');"><IMG alt="Samples" border="0" height="12" hspace="0" name="side-samples" onLoad="rolloverLoad('side-samples','../graphics/samples-label-2.jpg','../graphics/samples-label-3.jpg');" src="../graphics/samples-label-3.jpg" vspace="0" width="120"></A><BR>
16  <A href="../api.html" onMouseOut="rolloverOff('side-api');" onMouseOver="rolloverOn('side-api');"><IMG alt="API Docs" border="0" height="12" hspace="0" name="side-api" onLoad="rolloverLoad('side-api','../graphics/api-label-2.jpg','../graphics/api-label-3.jpg');" src="../graphics/api-label-3.jpg" vspace="0" width="120"></A><BR> 
17
18  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR> 
19  <A href="../ApacheDOMC++Binding.html" onMouseOut="rolloverOff('side-ext-68');" onMouseOver="rolloverOn('side-ext-68');"><IMG alt="DOM C++ Binding" border="0" height="12" hspace="0" name="side-ext-68" onLoad="rolloverLoad('side-ext-68','../graphics/ext-68-label-2.jpg','../graphics/ext-68-label-3.jpg');" src="../graphics/ext-68-label-3.jpg" vspace="0" width="120"></A><BR>
20
21  <A href="../program.html" onMouseOut="rolloverOff('side-program');" onMouseOver="rolloverOn('side-program');"><IMG alt="Programming" border="0" height="12" hspace="0" name="side-program" onLoad="rolloverLoad('side-program','../graphics/program-label-2.jpg','../graphics/program-label-3.jpg');" src="../graphics/program-label-3.jpg" vspace="0" width="120"></A><BR>
22  <A href="../migrate.html" onMouseOut="rolloverOff('side-migrate');" onMouseOver="rolloverOn('side-migrate');"><IMG alt="Migration Guide" border="0" height="12" hspace="0" name="side-migrate" onLoad="rolloverLoad('side-migrate','../graphics/migrate-label-2.jpg','../graphics/migrate-label-3.jpg');" src="../graphics/migrate-label-3.jpg" vspace="0" width="120"></A><BR>
23
24  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
25
26  <A href="../feedback.html" onMouseOut="rolloverOff('side-feedback');" onMouseOver="rolloverOn('side-feedback');"><IMG alt="Feedback" border="0" height="12" hspace="0" name="side-feedback" onLoad="rolloverLoad('side-feedback','../graphics/feedback-label-2.jpg','../graphics/feedback-label-3.jpg');" src="../graphics/feedback-label-3.jpg" vspace="0" width="120"></A><BR>
27  <A href="../bug-report.html" onMouseOut="rolloverOff('side-bug-report');" onMouseOver="rolloverOn('side-bug-report');"><IMG alt="Bug-Reporting" border="0" height="12" hspace="0" name="side-bug-report" onLoad="rolloverLoad('side-bug-report','../graphics/bug-report-label-2.jpg','../graphics/bug-report-label-3.jpg');" src="../graphics/bug-report-label-3.jpg" vspace="0" width="120"></A><BR> 
28  <A href="../pdf.html" onMouseOut="rolloverOff('side-pdf');" onMouseOver="rolloverOn('side-pdf');"><IMG alt="PDF Document" border="0" height="12" hspace="0" name="side-pdf" onLoad="rolloverLoad('side-pdf','../graphics/pdf-label-2.jpg','../graphics/pdf-label-3.jpg');" src="../graphics/pdf-label-3.jpg" vspace="0" width="120"></A><BR>
29
30  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
31
32  <A href="http://xml.apache.org/websrc/cvsweb.cgi/xml-xerces/c/" onMouseOut="rolloverOff('side-ext-100');" onMouseOver="rolloverOn('side-ext-100');"><IMG alt="CVS Repository" border="0" height="12" hspace="0" name="side-ext-100" onLoad="rolloverLoad('side-ext-100','../graphics/ext-100-label-2.jpg','../graphics/ext-100-label-3.jpg');" src="../graphics/ext-100-label-3.jpg" vspace="0" width="120"></A><BR>
33
34  <A href="http://marc.theaimsgroup.com/?l=xerces-c-dev" onMouseOut="rolloverOff('side-ext-102');" onMouseOver="rolloverOn('side-ext-102');"><IMG alt="Mail Archive" border="0" height="12" hspace="0" name="side-ext-102" onLoad="rolloverLoad('side-ext-102','../graphics/ext-102-label-2.jpg','../graphics/ext-102-label-3.jpg');" src="../graphics/ext-102-label-3.jpg" vspace="0" width="120"></A><BR>
35
36
37<IMG border="0" height="14" hspace="0" src="../resources/close.gif" vspace="0" width="120"><BR></TD><TD align="left" valign="top" width="500"><TABLE border="0" cellpadding="3" cellspacing="0"><TR><TD>
38    <TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="#FFFFFF" colspan="2" width="494"><TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="#039acc" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#039acc" height="1" width="492"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#039acc" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#0086b2" width="492"><FONT color="#ffffff" face="arial,helvetica,sanserif" size="+1"><IMG border="0" height="2" hspace="0" src="../resources/void.gif" vspace="0" width="2"><B>API Docs for SAX and DOM</B></FONT></TD><TD bgcolor="#017299" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#017299" height="1" width="492"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#017299" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR></TABLE></TD></TR><TR><TD width="10">&nbsp;</TD><TD width="484"><FONT color="#000000" face="arial,helvetica,sanserif">
39
40            <P>
41<!-- Generated by Doxygen 1.2.14 -->
42<center>
43<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
44<hr><h1>DOMNodeFilter  Class Reference</h1>Filters are objects that know how to "filter out" nodes.
45<a href="#_details">More...</a>
46<p>
47Inheritance diagram for DOMNodeFilter:<p><center><img src="classDOMNodeFilter__inherit__graph.gif" border="0" usemap="#DOMNodeFilter__inherit__map" alt="Inheritance graph"></center>
48<map name="DOMNodeFilter__inherit__map">
49<area href="classDOMWriterFilter.html" shape="rect" coords="7,105,116,87" alt="">
50</map>
51<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classDOMNodeFilter-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
52<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
53<tr><td colspan="2"><div class="groupHeader">Public Contants</div></td></tr>
54<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="classDOMNodeFilter.html#z120_0">FilterAction</a> { <a class="el" href="classDOMNodeFilter.html#z120_0s0">FILTER_ACCEPT</a> =  1,
55<a class="el" href="classDOMNodeFilter.html#z120_0s1">FILTER_REJECT</a> =  2,
56<a class="el" href="classDOMNodeFilter.html#z120_0s2">FILTER_SKIP</a> =  3
57 }</td></tr>
58<tr><td>&nbsp;</td><td><font size=-1><em>Constants returned by acceptNode.</em> <a href="#z120_0">More...</a><em></em></font><br><br></td></tr>
59<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom><a class="el" href="classDOMNodeFilter.html#z120_1">ShowType</a> { <br>
60&nbsp;&nbsp;<a class="el" href="classDOMNodeFilter.html#z120_1s3">SHOW_ALL</a> =  0x0000FFFF,
61<a class="el" href="classDOMNodeFilter.html#z120_1s4">SHOW_ELEMENT</a> =  0x00000001,
62<a class="el" href="classDOMNodeFilter.html#z120_1s5">SHOW_ATTRIBUTE</a> =  0x00000002,
63<a class="el" href="classDOMNodeFilter.html#z120_1s6">SHOW_TEXT</a> =  0x00000004,
64<br>
65&nbsp;&nbsp;<a class="el" href="classDOMNodeFilter.html#z120_1s7">SHOW_CDATA_SECTION</a> =  0x00000008,
66<a class="el" href="classDOMNodeFilter.html#z120_1s8">SHOW_ENTITY_REFERENCE</a> =  0x00000010,
67<a class="el" href="classDOMNodeFilter.html#z120_1s9">SHOW_ENTITY</a> =  0x00000020,
68<a class="el" href="classDOMNodeFilter.html#z120_1s10">SHOW_PROCESSING_INSTRUCTION</a> =  0x00000040,
69<br>
70&nbsp;&nbsp;<a class="el" href="classDOMNodeFilter.html#z120_1s11">SHOW_COMMENT</a> =  0x00000080,
71<a class="el" href="classDOMNodeFilter.html#z120_1s12">SHOW_DOCUMENT</a> =  0x00000100,
72<a class="el" href="classDOMNodeFilter.html#z120_1s13">SHOW_DOCUMENT_TYPE</a> =  0x00000200,
73<a class="el" href="classDOMNodeFilter.html#z120_1s14">SHOW_DOCUMENT_FRAGMENT</a> =  0x00000400,
74<br>
75&nbsp;&nbsp;<a class="el" href="classDOMNodeFilter.html#z120_1s15">SHOW_NOTATION</a> =  0x00000800
76<br>
77 }</td></tr>
78<tr><td>&nbsp;</td><td><font size=-1><em>Constants for whatToShow.</em> <a href="#z120_1">More...</a><em></em></font><br><br></td></tr>
79<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
80<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
81<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classDOMNodeFilter.html#z119_0">~DOMNodeFilter</a> ()</td></tr>
82<tr><td>&nbsp;</td><td><font size=-1><em>Destructor.</em> <a href="#z119_0">More...</a><em></em></font><br><br></td></tr>
83<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 2</div></td></tr>
84<tr><td nowrap align=right valign=top>virtual short&nbsp;</td><td valign=bottom><a class="el" href="classDOMNodeFilter.html#z121_0">acceptNode</a> (const <a class="el" href="classDOMNode.html">DOMNode</a> *node) const=0</td></tr>
85<tr><td>&nbsp;</td><td><font size=-1><em>Test whether a specified node is visible in the logical view of a <code><a class="el" href="classDOMTreeWalker.html">DOMTreeWalker</a></code> or <code><a class="el" href="classDOMNodeIterator.html">DOMNodeIterator</a></code>.</em> <a href="#z121_0">More...</a><em></em></font><br><br></td></tr>
86<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
87<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
88<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classDOMNodeFilter.html#z117_0">DOMNodeFilter</a> ()</td></tr>
89</table>
90<hr><a name="_details"></a><h2>Detailed Description</h2>
91Filters are objects that know how to "filter out" nodes.
92<p>
93If a <code><a class="el" href="classDOMNodeIterator.html">DOMNodeIterator</a></code> or <code><a class="el" href="classDOMTreeWalker.html">DOMTreeWalker</a></code> is given a <code>DOMNodeFilter</code>, 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.
94<p>
95The DOM does not provide any filters. <code>DOMNodeFilter</code> is just an interface that users can implement to provide their own filters.
96<p>
97<code>DOMNodeFilters</code> 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.
98<p>
99See also the <a href="http://www.w3.org/TR/2000/REC-DOM-Level-2-Traversal-Range-20001113">Document Object Model (DOM) Level 2 Traversal and Range Specification</a>. <dl compact><dt><b>
100Since: </b><dd>
101DOM Level 2 </dl>
102<p>
103<hr><h2>Member Enumeration Documentation</h2>
104<a name="z120_0" doxytag="DOMNodeFilter::FilterAction"></a><p>
105<table width="100%" cellpadding="2" cellspacing="0" border="0">
106  <tr>
107    <td class="md">
108      <table cellpadding="0" cellspacing="0" border="0">
109        <tr>
110          <td class="md" nowrap valign="top"> enum DOMNodeFilter::FilterAction
111      </table>
112    </td>
113  </tr>
114</table>
115<table cellspacing=5 cellpadding=0 border=0>
116  <tr>
117    <td>
118      &nbsp;
119    </td>
120    <td>
121
122<p>
123Constants returned by acceptNode.
124<p>
125
126<p>
127<code>FILTER_ACCEPT:</code> Accept the node. Navigation methods defined for <code><a class="el" href="classDOMNodeIterator.html">DOMNodeIterator</a></code> or <code><a class="el" href="classDOMTreeWalker.html">DOMTreeWalker</a></code> will return this node.
128<p>
129
130<p>
131<code>FILTER_REJECT:</code> Reject the node. Navigation methods defined for <code><a class="el" href="classDOMNodeIterator.html">DOMNodeIterator</a></code> or <code><a class="el" href="classDOMTreeWalker.html">DOMTreeWalker</a></code> will not return this node. For <code><a class="el" href="classDOMTreeWalker.html">DOMTreeWalker</a></code>, the children of this node will also be rejected. <code>DOMNodeIterators</code> treat this as a synonym for <code>FILTER_SKIP.</code>
132<p>
133
134<p>
135<code>FILTER_SKIP:</code> Skip this single node. Navigation methods defined for <code><a class="el" href="classDOMNodeIterator.html">DOMNodeIterator</a></code> or <code><a class="el" href="classDOMTreeWalker.html">DOMTreeWalker</a></code> will not return this node. For both <code><a class="el" href="classDOMNodeIterator.html">DOMNodeIterator</a></code> and <code><a class="el" href="classDOMTreeWalker.html">DOMTreeWalker</a></code>, the children of this node will still be considered.
136<p>
137<dl compact><dt><b>
138Since: </b><dd>
139DOM Level 2 </dl><dl compact><dt><b>
140Enumeration values:</b><dd>
141<table border=0 cellspacing=2 cellpadding=0>
142<tr><td valign=top><em><a name="z120_0s0" doxytag="FILTER_ACCEPT"></a><em>FILTER_ACCEPT</em></em>&nbsp;</td><td>
143</td></tr>
144<tr><td valign=top><em><a name="z120_0s1" doxytag="FILTER_REJECT"></a><em>FILTER_REJECT</em></em>&nbsp;</td><td>
145</td></tr>
146<tr><td valign=top><em><a name="z120_0s2" doxytag="FILTER_SKIP"></a><em>FILTER_SKIP</em></em>&nbsp;</td><td>
147</td></tr>
148</table>
149</dl>
150    </td>
151  </tr>
152</table>
153<a name="z120_1" doxytag="DOMNodeFilter::ShowType"></a><p>
154<table width="100%" cellpadding="2" cellspacing="0" border="0">
155  <tr>
156    <td class="md">
157      <table cellpadding="0" cellspacing="0" border="0">
158        <tr>
159          <td class="md" nowrap valign="top"> enum DOMNodeFilter::ShowType
160      </table>
161    </td>
162  </tr>
163</table>
164<table cellspacing=5 cellpadding=0 border=0>
165  <tr>
166    <td>
167      &nbsp;
168    </td>
169    <td>
170
171<p>
172Constants for whatToShow.
173<p>
174
175<p>
176<code>SHOW_ALL:</code> Show all <code>DOMNode(s)</code>.
177<p>
178
179<p>
180<code>SHOW_ELEMENT:</code> Show <code><a class="el" href="classDOMElement.html">DOMElement</a></code> nodes.
181<p>
182
183<p>
184<code>SHOW_ATTRIBUTE:</code> Show <code><a class="el" href="classDOMAttr.html">DOMAttr</a></code> nodes. This is meaningful only when creating an <code><a class="el" href="classDOMNodeIterator.html">DOMNodeIterator</a></code> or <code><a class="el" href="classDOMTreeWalker.html">DOMTreeWalker</a></code> with an attribute node as its <code>root</code>; in this case, it means that the attribute node will appear in the first position of the iteration or traversal. Since attributes are never children of other nodes, they do not appear when traversing over the document tree.
185<p>
186
187<p>
188<code>SHOW_TEXT:</code> Show <code><a class="el" href="classDOMText.html">DOMText</a></code> nodes.
189<p>
190
191<p>
192<code>SHOW_CDATA_SECTION:</code> Show <code><a class="el" href="classDOMCDATASection.html">DOMCDATASection</a></code> nodes.
193<p>
194
195<p>
196<code>SHOW_ENTITY_REFERENCE:</code> Show <code><a class="el" href="classDOMEntityReference.html">DOMEntityReference</a></code> nodes.
197<p>
198
199<p>
200<code>SHOW_ENTITY:</code> Show <code><a class="el" href="classDOMEntity.html">DOMEntity</a></code> nodes. This is meaningful only when creating an <code><a class="el" href="classDOMNodeIterator.html">DOMNodeIterator</a></code> or <code><a class="el" href="classDOMTreeWalker.html">DOMTreeWalker</a></code> with an <code><a class="el" href="classDOMEntity.html">DOMEntity</a></code> node as its <code>root</code>; in this case, it means that the <code><a class="el" href="classDOMEntity.html">DOMEntity</a></code> node will appear in the first position of the traversal. Since entities are not part of the document tree, they do not appear when traversing over the document tree.
201<p>
202
203<p>
204<code>SHOW_PROCESSING_INSTRUCTION:</code> Show <code><a class="el" href="classDOMProcessingInstruction.html">DOMProcessingInstruction</a></code> nodes.
205<p>
206
207<p>
208<code>SHOW_COMMENT:</code> Show <code><a class="el" href="classDOMComment.html">DOMComment</a></code> nodes.
209<p>
210
211<p>
212<code>SHOW_DOCUMENT:</code> Show <code><a class="el" href="classDOMDocument.html">DOMDocument</a></code> nodes.
213<p>
214
215<p>
216<code>SHOW_DOCUMENT_TYPE:</code> Show <code><a class="el" href="classDOMDocumentType.html">DOMDocumentType</a></code> nodes.
217<p>
218
219<p>
220<code>SHOW_DOCUMENT_FRAGMENT:</code> Show <code><a class="el" href="classDOMDocumentFragment.html">DOMDocumentFragment</a></code> nodes.
221<p>
222
223<p>
224<code>SHOW_NOTATION:</code> Show <code><a class="el" href="classDOMNotation.html">DOMNotation</a></code> nodes. This is meaningful only when creating an <code><a class="el" href="classDOMNodeIterator.html">DOMNodeIterator</a></code> or <code><a class="el" href="classDOMTreeWalker.html">DOMTreeWalker</a></code> with a <code><a class="el" href="classDOMNotation.html">DOMNotation</a></code> node as its <code>root</code>; in this case, it means that the <code><a class="el" href="classDOMNotation.html">DOMNotation</a></code> node will appear in the first position of the traversal. Since notations are not part of the document tree, they do not appear when traversing over the document tree.
225<p>
226<dl compact><dt><b>
227Since: </b><dd>
228DOM Level 2 </dl><dl compact><dt><b>
229Enumeration values:</b><dd>
230<table border=0 cellspacing=2 cellpadding=0>
231<tr><td valign=top><em><a name="z120_1s3" doxytag="SHOW_ALL"></a><em>SHOW_ALL</em></em>&nbsp;</td><td>
232</td></tr>
233<tr><td valign=top><em><a name="z120_1s4" doxytag="SHOW_ELEMENT"></a><em>SHOW_ELEMENT</em></em>&nbsp;</td><td>
234</td></tr>
235<tr><td valign=top><em><a name="z120_1s5" doxytag="SHOW_ATTRIBUTE"></a><em>SHOW_ATTRIBUTE</em></em>&nbsp;</td><td>
236</td></tr>
237<tr><td valign=top><em><a name="z120_1s6" doxytag="SHOW_TEXT"></a><em>SHOW_TEXT</em></em>&nbsp;</td><td>
238</td></tr>
239<tr><td valign=top><em><a name="z120_1s7" doxytag="SHOW_CDATA_SECTION"></a><em>SHOW_CDATA_SECTION</em></em>&nbsp;</td><td>
240</td></tr>
241<tr><td valign=top><em><a name="z120_1s8" doxytag="SHOW_ENTITY_REFERENCE"></a><em>SHOW_ENTITY_REFERENCE</em></em>&nbsp;</td><td>
242</td></tr>
243<tr><td valign=top><em><a name="z120_1s9" doxytag="SHOW_ENTITY"></a><em>SHOW_ENTITY</em></em>&nbsp;</td><td>
244</td></tr>
245<tr><td valign=top><em><a name="z120_1s10" doxytag="SHOW_PROCESSING_INSTRUCTION"></a><em>SHOW_PROCESSING_INSTRUCTION</em></em>&nbsp;</td><td>
246</td></tr>
247<tr><td valign=top><em><a name="z120_1s11" doxytag="SHOW_COMMENT"></a><em>SHOW_COMMENT</em></em>&nbsp;</td><td>
248</td></tr>
249<tr><td valign=top><em><a name="z120_1s12" doxytag="SHOW_DOCUMENT"></a><em>SHOW_DOCUMENT</em></em>&nbsp;</td><td>
250</td></tr>
251<tr><td valign=top><em><a name="z120_1s13" doxytag="SHOW_DOCUMENT_TYPE"></a><em>SHOW_DOCUMENT_TYPE</em></em>&nbsp;</td><td>
252</td></tr>
253<tr><td valign=top><em><a name="z120_1s14" doxytag="SHOW_DOCUMENT_FRAGMENT"></a><em>SHOW_DOCUMENT_FRAGMENT</em></em>&nbsp;</td><td>
254</td></tr>
255<tr><td valign=top><em><a name="z120_1s15" doxytag="SHOW_NOTATION"></a><em>SHOW_NOTATION</em></em>&nbsp;</td><td>
256</td></tr>
257</table>
258</dl>
259    </td>
260  </tr>
261</table>
262<hr><h2>Constructor &amp; Destructor Documentation</h2>
263<a name="z117_0" doxytag="DOMNodeFilter::DOMNodeFilter"></a><p>
264<table width="100%" cellpadding="2" cellspacing="0" border="0">
265  <tr>
266    <td class="md">
267      <table cellpadding="0" cellspacing="0" border="0">
268        <tr>
269          <td class="md" nowrap valign="top"> DOMNodeFilter::DOMNodeFilter </td>
270          <td class="md" valign="top">(&nbsp;</td>
271          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
272          <td class="md" valign="top">)&nbsp;</td>
273          <td class="md" nowrap><code> [protected]</code></td>
274        </tr>
275
276      </table>
277    </td>
278  </tr>
279</table>
280<table cellspacing=5 cellpadding=0 border=0>
281  <tr>
282    <td>
283      &nbsp;
284    </td>
285    <td>
286
287<p>
288    </td>
289  </tr>
290</table>
291<a name="z119_0" doxytag="DOMNodeFilter::~DOMNodeFilter"></a><p>
292<table width="100%" cellpadding="2" cellspacing="0" border="0">
293  <tr>
294    <td class="md">
295      <table cellpadding="0" cellspacing="0" border="0">
296        <tr>
297          <td class="md" nowrap valign="top"> virtual DOMNodeFilter::~DOMNodeFilter </td>
298          <td class="md" valign="top">(&nbsp;</td>
299          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
300          <td class="md" valign="top">)&nbsp;</td>
301          <td class="md" nowrap><code> [virtual]</code></td>
302        </tr>
303
304      </table>
305    </td>
306  </tr>
307</table>
308<table cellspacing=5 cellpadding=0 border=0>
309  <tr>
310    <td>
311      &nbsp;
312    </td>
313    <td>
314
315<p>
316Destructor.
317<p>
318    </td>
319  </tr>
320</table>
321<hr><h2>Member Function Documentation</h2>
322<a name="z121_0" doxytag="DOMNodeFilter::acceptNode"></a><p>
323<table width="100%" cellpadding="2" cellspacing="0" border="0">
324  <tr>
325    <td class="md">
326      <table cellpadding="0" cellspacing="0" border="0">
327        <tr>
328          <td class="md" nowrap valign="top"> virtual short DOMNodeFilter::acceptNode </td>
329          <td class="md" valign="top">(&nbsp;</td>
330          <td class="md" nowrap valign="top">const <a class="el" href="classDOMNode.html">DOMNode</a> *&nbsp;</td>
331          <td class="mdname1" valign="top" nowrap>&nbsp; <em>node</em>          </td>
332          <td class="md" valign="top">)&nbsp;</td>
333          <td class="md" nowrap> const<code> [pure virtual]</code></td>
334        </tr>
335
336      </table>
337    </td>
338  </tr>
339</table>
340<table cellspacing=5 cellpadding=0 border=0>
341  <tr>
342    <td>
343      &nbsp;
344    </td>
345    <td>
346
347<p>
348Test whether a specified node is visible in the logical view of a <code><a class="el" href="classDOMTreeWalker.html">DOMTreeWalker</a></code> or <code><a class="el" href="classDOMNodeIterator.html">DOMNodeIterator</a></code>.
349<p>
350This function will be called by the implementation of <code><a class="el" href="classDOMTreeWalker.html">DOMTreeWalker</a></code> and <code><a class="el" href="classDOMNodeIterator.html">DOMNodeIterator</a></code>; 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.) <dl compact><dt><b>
351Parameters: </b><dd>
352<table border=0 cellspacing=2 cellpadding=0>
353<tr><td valign=top><em>node</em>&nbsp;</td><td>
354The node to check to see if it passes the filter or not. </td></tr>
355</table>
356</dl><dl compact><dt><b>
357Returns: </b><dd>
358A constant to determine whether the node is accepted, rejected, or skipped, as defined above. </dl><dl compact><dt><b>
359Since: </b><dd>
360DOM Level 2 </dl>
361<p>
362Implemented in <a class="el" href="classDOMWriterFilter.html#z181_0">DOMWriterFilter</a>.    </td>
363  </tr>
364</table>
365<hr>The documentation for this class was generated from the following file:<ul>
366<li><a class="el" href="DOMNodeFilter_8hpp-source.html">DOMNodeFilter.hpp</a></ul>
367    </FONT></TD></TR></TABLE><BR>
368</TD></TR></TABLE></TD></TR></TABLE><BR><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD bgcolor="#0086b2"><IMG height="1" src="images/dot.gif" width="1" alt=""></TD></TR><TR><TD align="center"><FONT color="#0086b2" size="-1"><I>
369              Copyright &copy; 1994-2004 The Apache Software Foundation.
370              All Rights Reserved.
371            </I></FONT></TD></TR></TABLE></BODY></HTML>
Note: See TracBrowser for help on using the repository browser.