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

Revision 358, 24.6 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>DOMDocumentTraversal 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>DOMDocumentTraversal Class Reference</h1><code>DOMDocumentTraversal</code> contains methods that create <code>DOMNodeIterators</code> and <code>DOMTreeWalkers</code> to traverse a node and its children in document order (depth first, pre-order traversal, which is equivalent to the order in which the start tags occur in the text representation of the document).
45<a href="#_details">More...</a>
46<p>
47Inheritance diagram for DOMDocumentTraversal:<p><center><img src="classDOMDocumentTraversal__inherit__graph.gif" border="0" usemap="#DOMDocumentTraversal__inherit__map" alt="Inheritance graph"></center>
48<map name="DOMDocumentTraversal__inherit__map">
49<area href="classDOMDocument.html" shape="rect" coords="35,105,139,87" alt="">
50</map>
51<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classDOMDocumentTraversal-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
52<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
53<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
54<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classDOMDocumentTraversal.html#z40_0">~DOMDocumentTraversal</a> ()</td></tr>
55<tr><td>&nbsp;</td><td><font size=-1><em>Destructor.</em> <a href="#z40_0">More...</a><em></em></font><br><br></td></tr>
56<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 2</div></td></tr>
57<tr><td nowrap align=right valign=top>virtual <a class="el" href="classDOMNodeIterator.html">DOMNodeIterator</a> *&nbsp;</td><td valign=bottom><a class="el" href="classDOMDocumentTraversal.html#z41_0">createNodeIterator</a> (<a class="el" href="classDOMNode.html">DOMNode</a> *root, unsigned long whatToShow, <a class="el" href="classDOMNodeFilter.html">DOMNodeFilter</a> *filter, bool entityReferenceExpansion)=0</td></tr>
58<tr><td>&nbsp;</td><td><font size=-1><em>Creates a NodeIterator object.</em> <a href="#z41_0">More...</a><em></em></font><br><br></td></tr>
59<tr><td nowrap align=right valign=top>virtual <a class="el" href="classDOMTreeWalker.html">DOMTreeWalker</a> *&nbsp;</td><td valign=bottom><a class="el" href="classDOMDocumentTraversal.html#z41_1">createTreeWalker</a> (<a class="el" href="classDOMNode.html">DOMNode</a> *root, unsigned long whatToShow, <a class="el" href="classDOMNodeFilter.html">DOMNodeFilter</a> *filter, bool entityReferenceExpansion)=0</td></tr>
60<tr><td>&nbsp;</td><td><font size=-1><em>Creates a TreeWalker object.</em> <a href="#z41_1">More...</a><em></em></font><br><br></td></tr>
61<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
62<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
63<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classDOMDocumentTraversal.html#z38_0">DOMDocumentTraversal</a> ()</td></tr>
64</table>
65<hr><a name="_details"></a><h2>Detailed Description</h2>
66<code>DOMDocumentTraversal</code> contains methods that create <code>DOMNodeIterators</code> and <code>DOMTreeWalkers</code> to traverse a node and its children in document order (depth first, pre-order traversal, which is equivalent to the order in which the start tags occur in the text representation of the document).
67<p>
68In DOMs which support the Traversal feature, <code>DOMDocumentTraversal</code> will be implemented by the same objects that implement the <a class="el" href="classDOMDocument.html">DOMDocument</a> interface.
69<p>
70See 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>
71Since: </b><dd>
72DOM Level 2 </dl>
73<p>
74<hr><h2>Constructor &amp; Destructor Documentation</h2>
75<a name="z38_0" doxytag="DOMDocumentTraversal::DOMDocumentTraversal"></a><p>
76<table width="100%" cellpadding="2" cellspacing="0" border="0">
77  <tr>
78    <td class="md">
79      <table cellpadding="0" cellspacing="0" border="0">
80        <tr>
81          <td class="md" nowrap valign="top"> DOMDocumentTraversal::DOMDocumentTraversal </td>
82          <td class="md" valign="top">(&nbsp;</td>
83          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
84          <td class="md" valign="top">)&nbsp;</td>
85          <td class="md" nowrap><code> [protected]</code></td>
86        </tr>
87
88      </table>
89    </td>
90  </tr>
91</table>
92<table cellspacing=5 cellpadding=0 border=0>
93  <tr>
94    <td>
95      &nbsp;
96    </td>
97    <td>
98
99<p>
100    </td>
101  </tr>
102</table>
103<a name="z40_0" doxytag="DOMDocumentTraversal::~DOMDocumentTraversal"></a><p>
104<table width="100%" cellpadding="2" cellspacing="0" border="0">
105  <tr>
106    <td class="md">
107      <table cellpadding="0" cellspacing="0" border="0">
108        <tr>
109          <td class="md" nowrap valign="top"> virtual DOMDocumentTraversal::~DOMDocumentTraversal </td>
110          <td class="md" valign="top">(&nbsp;</td>
111          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
112          <td class="md" valign="top">)&nbsp;</td>
113          <td class="md" nowrap><code> [virtual]</code></td>
114        </tr>
115
116      </table>
117    </td>
118  </tr>
119</table>
120<table cellspacing=5 cellpadding=0 border=0>
121  <tr>
122    <td>
123      &nbsp;
124    </td>
125    <td>
126
127<p>
128Destructor.
129<p>
130    </td>
131  </tr>
132</table>
133<hr><h2>Member Function Documentation</h2>
134<a name="z41_0" doxytag="DOMDocumentTraversal::createNodeIterator"></a><p>
135<table width="100%" cellpadding="2" cellspacing="0" border="0">
136  <tr>
137    <td class="md">
138      <table cellpadding="0" cellspacing="0" border="0">
139        <tr>
140          <td class="md" nowrap valign="top"> virtual <a class="el" href="classDOMNodeIterator.html">DOMNodeIterator</a>* DOMDocumentTraversal::createNodeIterator </td>
141          <td class="md" valign="top">(&nbsp;</td>
142          <td class="md" nowrap valign="top"><a class="el" href="classDOMNode.html">DOMNode</a> *&nbsp;</td>
143          <td class="mdname" nowrap>&nbsp; <em>root</em>, </td>
144        </tr>
145        <tr>
146          <td></td>
147          <td></td>
148          <td class="md" nowrap>unsigned long&nbsp;</td>
149          <td class="mdname" nowrap>&nbsp; <em>whatToShow</em>, </td>
150        </tr>
151        <tr>
152          <td></td>
153          <td></td>
154          <td class="md" nowrap><a class="el" href="classDOMNodeFilter.html">DOMNodeFilter</a> *&nbsp;</td>
155          <td class="mdname" nowrap>&nbsp; <em>filter</em>, </td>
156        </tr>
157        <tr>
158          <td></td>
159          <td></td>
160          <td class="md" nowrap>bool&nbsp;</td>
161          <td class="mdname" nowrap>&nbsp; <em>entityReferenceExpansion</em></td>
162        </tr>
163        <tr>
164          <td></td>
165          <td class="md">)&nbsp;</td>
166          <td class="md" colspan="2"><code> [pure virtual]</code></td>
167        </tr>
168
169      </table>
170    </td>
171  </tr>
172</table>
173<table cellspacing=5 cellpadding=0 border=0>
174  <tr>
175    <td>
176      &nbsp;
177    </td>
178    <td>
179
180<p>
181Creates a NodeIterator object.
182<p>
183(DOM2)
184<p>
185NodeIterators are used to step through a set of nodes, e.g. the set of nodes in a NodeList, the document subtree governed by a particular node, the results of a query, or any other set of nodes. The set of nodes to be iterated is determined by the implementation of the NodeIterator. DOM Level 2 specifies a single NodeIterator implementation for document-order traversal of a document subtree. Instances of these iterators are created by calling <code>DOMDocumentTraversal.createNodeIterator()</code>.
186<p>
187To produce a view of the document that has entity references expanded and does not expose the entity reference node itself, use the <code>whatToShow</code> flags to hide the entity reference node and set expandEntityReferences to true when creating the iterator. To produce a view of the document that has entity reference nodes but no entity expansion, use the <code>whatToShow</code> flags to show the entity reference node and set expandEntityReferences to false.<dl compact><dt><b>
188Parameters: </b><dd>
189<table border=0 cellspacing=2 cellpadding=0>
190<tr><td valign=top><em>root</em>&nbsp;</td><td>
191The root node of the DOM tree </td></tr>
192<tr><td valign=top><em>whatToShow</em>&nbsp;</td><td>
193This attribute determines which node types are presented via the iterator. </td></tr>
194<tr><td valign=top><em>filter</em>&nbsp;</td><td>
195The filter used to screen nodes </td></tr>
196<tr><td valign=top><em>entityReferenceExpansion</em>&nbsp;</td><td>
197The value of this flag determines whether the children of entity reference nodes are visible to the iterator. If false, they will be skipped over. </td></tr>
198</table>
199</dl><dl compact><dt><b>
200Since: </b><dd>
201DOM Level 2 </dl>    </td>
202  </tr>
203</table>
204<a name="z41_1" doxytag="DOMDocumentTraversal::createTreeWalker"></a><p>
205<table width="100%" cellpadding="2" cellspacing="0" border="0">
206  <tr>
207    <td class="md">
208      <table cellpadding="0" cellspacing="0" border="0">
209        <tr>
210          <td class="md" nowrap valign="top"> virtual <a class="el" href="classDOMTreeWalker.html">DOMTreeWalker</a>* DOMDocumentTraversal::createTreeWalker </td>
211          <td class="md" valign="top">(&nbsp;</td>
212          <td class="md" nowrap valign="top"><a class="el" href="classDOMNode.html">DOMNode</a> *&nbsp;</td>
213          <td class="mdname" nowrap>&nbsp; <em>root</em>, </td>
214        </tr>
215        <tr>
216          <td></td>
217          <td></td>
218          <td class="md" nowrap>unsigned long&nbsp;</td>
219          <td class="mdname" nowrap>&nbsp; <em>whatToShow</em>, </td>
220        </tr>
221        <tr>
222          <td></td>
223          <td></td>
224          <td class="md" nowrap><a class="el" href="classDOMNodeFilter.html">DOMNodeFilter</a> *&nbsp;</td>
225          <td class="mdname" nowrap>&nbsp; <em>filter</em>, </td>
226        </tr>
227        <tr>
228          <td></td>
229          <td></td>
230          <td class="md" nowrap>bool&nbsp;</td>
231          <td class="mdname" nowrap>&nbsp; <em>entityReferenceExpansion</em></td>
232        </tr>
233        <tr>
234          <td></td>
235          <td class="md">)&nbsp;</td>
236          <td class="md" colspan="2"><code> [pure virtual]</code></td>
237        </tr>
238
239      </table>
240    </td>
241  </tr>
242</table>
243<table cellspacing=5 cellpadding=0 border=0>
244  <tr>
245    <td>
246      &nbsp;
247    </td>
248    <td>
249
250<p>
251Creates a TreeWalker object.
252<p>
253(DOM2)
254<p>
255TreeWalker objects are used to navigate a document tree or subtree using the view of the document defined by its whatToShow flags and any filters that are defined for the TreeWalker. Any function which performs navigation using a TreeWalker will automatically support any view defined by a TreeWalker.
256<p>
257Omitting nodes from the logical view of a subtree can result in a structure that is substantially different from the same subtree in the complete, unfiltered document. Nodes that are siblings in the TreeWalker view may be children of different, widely separated nodes in the original view. For instance, consider a Filter that skips all nodes except for <a class="el" href="classDOMText.html">DOMText</a> nodes and the root node of a document. In the logical view that results, all text nodes will be siblings and appear as direct children of the root node, no matter how deeply nested the structure of the original document.
258<p>
259To produce a view of the document that has entity references expanded and does not expose the entity reference node itself, use the whatToShow flags to hide the entity reference node and set <code>expandEntityReferences</code> to true when creating the TreeWalker. To produce a view of the document that has entity reference nodes but no entity expansion, use the <code>whatToShow</code> flags to show the entity reference node and set <code>expandEntityReferences</code> to false<dl compact><dt><b>
260Parameters: </b><dd>
261<table border=0 cellspacing=2 cellpadding=0>
262<tr><td valign=top><em>root</em>&nbsp;</td><td>
263The root node of the DOM tree </td></tr>
264<tr><td valign=top><em>whatToShow</em>&nbsp;</td><td>
265This attribute determines which node types are presented via the tree-walker. </td></tr>
266<tr><td valign=top><em>filter</em>&nbsp;</td><td>
267The filter used to screen nodes </td></tr>
268<tr><td valign=top><em>entityReferenceExpansion</em>&nbsp;</td><td>
269The value of this flag determines whether the children of entity reference nodes are visible to the tree-walker. If false, they will be skipped over. </td></tr>
270</table>
271</dl><dl compact><dt><b>
272Since: </b><dd>
273DOM Level 2 </dl>    </td>
274  </tr>
275</table>
276<hr>The documentation for this class was generated from the following file:<ul>
277<li><a class="el" href="DOMDocumentTraversal_8hpp-source.html">DOMDocumentTraversal.hpp</a></ul>
278    </FONT></TD></TR></TABLE><BR>
279</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>
280              Copyright &copy; 1994-2004 The Apache Software Foundation.
281              All Rights Reserved.
282            </I></FONT></TD></TR></TABLE></BODY></HTML>
Note: See TracBrowser for help on using the repository browser.