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

Revision 358, 29.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>DOMNodeIterator 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>DOMNodeIterator Class Reference</h1><code>DOMNodeIterators</code> are used to step through a set of nodes, e.g.
45<a href="#_details">More...</a>
46<p>
47<a href="classDOMNodeIterator-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
48<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
49<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
50<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classDOMNodeIterator.html#z124_0">~DOMNodeIterator</a> ()</td></tr>
51<tr><td>&nbsp;</td><td><font size=-1><em>Destructor.</em> <a href="#z124_0">More...</a><em></em></font><br><br></td></tr>
52<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 2</div></td></tr>
53<tr><td nowrap align=right valign=top>virtual <a class="el" href="classDOMNode.html">DOMNode</a> *&nbsp;</td><td valign=bottom><a class="el" href="classDOMNodeIterator.html#z125_0">getRoot</a> ()=0</td></tr>
54<tr><td>&nbsp;</td><td><font size=-1><em>The <code>root</code> node of the <code>DOMNodeIterator</code>, as specified when it was created.</em> <a href="#z125_0">More...</a><em></em></font><br><br></td></tr>
55<tr><td nowrap align=right valign=top>virtual unsigned long&nbsp;</td><td valign=bottom><a class="el" href="classDOMNodeIterator.html#z125_1">getWhatToShow</a> ()=0</td></tr>
56<tr><td>&nbsp;</td><td><font size=-1><em>Return which node types are presented via the iterator.</em> <a href="#z125_1">More...</a><em></em></font><br><br></td></tr>
57<tr><td nowrap align=right valign=top>virtual <a class="el" href="classDOMNodeFilter.html">DOMNodeFilter</a> *&nbsp;</td><td valign=bottom><a class="el" href="classDOMNodeIterator.html#z125_2">getFilter</a> ()=0</td></tr>
58<tr><td>&nbsp;</td><td><font size=-1><em>The <code><a class="el" href="classDOMNodeFilter.html">DOMNodeFilter</a></code> used to screen nodes.</em> <a href="#z125_2">More...</a><em></em></font><br><br></td></tr>
59<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classDOMNodeIterator.html#z125_3">getExpandEntityReferences</a> ()=0</td></tr>
60<tr><td>&nbsp;</td><td><font size=-1><em>Return the expandEntityReferences flag.</em> <a href="#z125_3">More...</a><em></em></font><br><br></td></tr>
61<tr><td nowrap align=right valign=top>virtual <a class="el" href="classDOMNode.html">DOMNode</a> *&nbsp;</td><td valign=bottom><a class="el" href="classDOMNodeIterator.html#z125_4">nextNode</a> ()=0</td></tr>
62<tr><td>&nbsp;</td><td><font size=-1><em>Returns the next node in the set and advances the position of the <code>DOMNodeIterator</code> in the set.</em> <a href="#z125_4">More...</a><em></em></font><br><br></td></tr>
63<tr><td nowrap align=right valign=top>virtual <a class="el" href="classDOMNode.html">DOMNode</a> *&nbsp;</td><td valign=bottom><a class="el" href="classDOMNodeIterator.html#z125_5">previousNode</a> ()=0</td></tr>
64<tr><td>&nbsp;</td><td><font size=-1><em>Returns the previous node in the set and moves the position of the <code>DOMNodeIterator</code> backwards in the set.</em> <a href="#z125_5">More...</a><em></em></font><br><br></td></tr>
65<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDOMNodeIterator.html#z125_6">detach</a> ()=0</td></tr>
66<tr><td>&nbsp;</td><td><font size=-1><em>Detaches the <code>DOMNodeIterator</code> from the set which it iterated over, releasing any computational resources and placing the <code>DOMNodeIterator</code> in the INVALID state.</em> <a href="#z125_6">More...</a><em></em></font><br><br></td></tr>
67<tr><td colspan="2"><div class="groupHeader">Non-standard Extension</div></td></tr>
68<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDOMNodeIterator.html#z126_0">release</a> ()=0</td></tr>
69<tr><td>&nbsp;</td><td><font size=-1><em>Called to indicate that this NodeIterator is no longer in use and that the implementation may relinquish any resources associated with it.</em> <a href="#z126_0">More...</a><em></em></font><br><br></td></tr>
70<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
71<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
72<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classDOMNodeIterator.html#z122_0">DOMNodeIterator</a> ()</td></tr>
73</table>
74<hr><a name="_details"></a><h2>Detailed Description</h2>
75<code>DOMNodeIterators</code> are used to step through a set of nodes, e.g.
76<p>
77the set of nodes in a <code><a class="el" href="classDOMNodeList.html">DOMNodeList</a></code>, the document subtree governed by a particular <code><a class="el" href="classDOMNode.html">DOMNode</a></code>, 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 <code>DOMNodeIterator</code>. DOM Level 2 specifies a single <code>DOMNodeIterator</code> implementation for document-order traversal of a document subtree. Instances of these <code>DOMNodeIterators</code> are created by calling <code><a class="el" href="classDOMDocumentTraversal.html">DOMDocumentTraversal</a></code><code>.createNodeIterator()</code>.
78<p>
79See 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>
80Since: </b><dd>
81DOM Level 2 </dl>
82<p>
83<hr><h2>Constructor &amp; Destructor Documentation</h2>
84<a name="z122_0" doxytag="DOMNodeIterator::DOMNodeIterator"></a><p>
85<table width="100%" cellpadding="2" cellspacing="0" border="0">
86  <tr>
87    <td class="md">
88      <table cellpadding="0" cellspacing="0" border="0">
89        <tr>
90          <td class="md" nowrap valign="top"> DOMNodeIterator::DOMNodeIterator </td>
91          <td class="md" valign="top">(&nbsp;</td>
92          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
93          <td class="md" valign="top">)&nbsp;</td>
94          <td class="md" nowrap><code> [protected]</code></td>
95        </tr>
96
97      </table>
98    </td>
99  </tr>
100</table>
101<table cellspacing=5 cellpadding=0 border=0>
102  <tr>
103    <td>
104      &nbsp;
105    </td>
106    <td>
107
108<p>
109    </td>
110  </tr>
111</table>
112<a name="z124_0" doxytag="DOMNodeIterator::~DOMNodeIterator"></a><p>
113<table width="100%" cellpadding="2" cellspacing="0" border="0">
114  <tr>
115    <td class="md">
116      <table cellpadding="0" cellspacing="0" border="0">
117        <tr>
118          <td class="md" nowrap valign="top"> virtual DOMNodeIterator::~DOMNodeIterator </td>
119          <td class="md" valign="top">(&nbsp;</td>
120          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
121          <td class="md" valign="top">)&nbsp;</td>
122          <td class="md" nowrap><code> [virtual]</code></td>
123        </tr>
124
125      </table>
126    </td>
127  </tr>
128</table>
129<table cellspacing=5 cellpadding=0 border=0>
130  <tr>
131    <td>
132      &nbsp;
133    </td>
134    <td>
135
136<p>
137Destructor.
138<p>
139    </td>
140  </tr>
141</table>
142<hr><h2>Member Function Documentation</h2>
143<a name="z125_6" doxytag="DOMNodeIterator::detach"></a><p>
144<table width="100%" cellpadding="2" cellspacing="0" border="0">
145  <tr>
146    <td class="md">
147      <table cellpadding="0" cellspacing="0" border="0">
148        <tr>
149          <td class="md" nowrap valign="top"> virtual void DOMNodeIterator::detach </td>
150          <td class="md" valign="top">(&nbsp;</td>
151          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
152          <td class="md" valign="top">)&nbsp;</td>
153          <td class="md" nowrap><code> [pure virtual]</code></td>
154        </tr>
155
156      </table>
157    </td>
158  </tr>
159</table>
160<table cellspacing=5 cellpadding=0 border=0>
161  <tr>
162    <td>
163      &nbsp;
164    </td>
165    <td>
166
167<p>
168Detaches the <code>DOMNodeIterator</code> from the set which it iterated over, releasing any computational resources and placing the <code>DOMNodeIterator</code> in the INVALID state.
169<p>
170After <code>detach</code> has been invoked, calls to <code>nextNode</code> or <code>previousNode</code> will raise the exception INVALID_STATE_ERR. <dl compact><dt><b>
171Since: </b><dd>
172DOM Level 2 </dl>    </td>
173  </tr>
174</table>
175<a name="z125_3" doxytag="DOMNodeIterator::getExpandEntityReferences"></a><p>
176<table width="100%" cellpadding="2" cellspacing="0" border="0">
177  <tr>
178    <td class="md">
179      <table cellpadding="0" cellspacing="0" border="0">
180        <tr>
181          <td class="md" nowrap valign="top"> virtual bool DOMNodeIterator::getExpandEntityReferences </td>
182          <td class="md" valign="top">(&nbsp;</td>
183          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
184          <td class="md" valign="top">)&nbsp;</td>
185          <td class="md" nowrap><code> [pure virtual]</code></td>
186        </tr>
187
188      </table>
189    </td>
190  </tr>
191</table>
192<table cellspacing=5 cellpadding=0 border=0>
193  <tr>
194    <td>
195      &nbsp;
196    </td>
197    <td>
198
199<p>
200Return the expandEntityReferences flag.
201<p>
202The value of this flag determines whether the children of entity reference nodes are visible to the <code>DOMNodeIterator</code>. If false, these children and their descendants will be rejected. Note that this rejection takes precedence over <code>whatToShow</code> and the filter. Also note that this is currently the only situation where <code>DOMNodeIterators</code> may reject a complete subtree rather than skipping individual nodes. <br>
203 <br>
204 To 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 <code>expandEntityReferences</code> to true when creating the <code>DOMNodeIterator</code>. 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.
205<p>
206<dl compact><dt><b>
207Since: </b><dd>
208DOM Level 2 </dl>    </td>
209  </tr>
210</table>
211<a name="z125_2" doxytag="DOMNodeIterator::getFilter"></a><p>
212<table width="100%" cellpadding="2" cellspacing="0" border="0">
213  <tr>
214    <td class="md">
215      <table cellpadding="0" cellspacing="0" border="0">
216        <tr>
217          <td class="md" nowrap valign="top"> virtual <a class="el" href="classDOMNodeFilter.html">DOMNodeFilter</a>* DOMNodeIterator::getFilter </td>
218          <td class="md" valign="top">(&nbsp;</td>
219          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
220          <td class="md" valign="top">)&nbsp;</td>
221          <td class="md" nowrap><code> [pure virtual]</code></td>
222        </tr>
223
224      </table>
225    </td>
226  </tr>
227</table>
228<table cellspacing=5 cellpadding=0 border=0>
229  <tr>
230    <td>
231      &nbsp;
232    </td>
233    <td>
234
235<p>
236The <code><a class="el" href="classDOMNodeFilter.html">DOMNodeFilter</a></code> used to screen nodes.
237<p>
238<dl compact><dt><b>
239Since: </b><dd>
240DOM Level 2 </dl>    </td>
241  </tr>
242</table>
243<a name="z125_0" doxytag="DOMNodeIterator::getRoot"></a><p>
244<table width="100%" cellpadding="2" cellspacing="0" border="0">
245  <tr>
246    <td class="md">
247      <table cellpadding="0" cellspacing="0" border="0">
248        <tr>
249          <td class="md" nowrap valign="top"> virtual <a class="el" href="classDOMNode.html">DOMNode</a>* DOMNodeIterator::getRoot </td>
250          <td class="md" valign="top">(&nbsp;</td>
251          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
252          <td class="md" valign="top">)&nbsp;</td>
253          <td class="md" nowrap><code> [pure virtual]</code></td>
254        </tr>
255
256      </table>
257    </td>
258  </tr>
259</table>
260<table cellspacing=5 cellpadding=0 border=0>
261  <tr>
262    <td>
263      &nbsp;
264    </td>
265    <td>
266
267<p>
268The <code>root</code> node of the <code>DOMNodeIterator</code>, as specified when it was created.
269<p>
270<dl compact><dt><b>
271Since: </b><dd>
272DOM Level 2 </dl>    </td>
273  </tr>
274</table>
275<a name="z125_1" doxytag="DOMNodeIterator::getWhatToShow"></a><p>
276<table width="100%" cellpadding="2" cellspacing="0" border="0">
277  <tr>
278    <td class="md">
279      <table cellpadding="0" cellspacing="0" border="0">
280        <tr>
281          <td class="md" nowrap valign="top"> virtual unsigned long DOMNodeIterator::getWhatToShow </td>
282          <td class="md" valign="top">(&nbsp;</td>
283          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
284          <td class="md" valign="top">)&nbsp;</td>
285          <td class="md" nowrap><code> [pure virtual]</code></td>
286        </tr>
287
288      </table>
289    </td>
290  </tr>
291</table>
292<table cellspacing=5 cellpadding=0 border=0>
293  <tr>
294    <td>
295      &nbsp;
296    </td>
297    <td>
298
299<p>
300Return which node types are presented via the iterator.
301<p>
302This attribute determines which node types are presented via the <code>DOMNodeIterator</code>. The available set of constants is defined in the <code><a class="el" href="classDOMNodeFilter.html">DOMNodeFilter</a></code> interface. Nodes not accepted by <code>whatToShow</code> will be skipped, but their children may still be considered. Note that this skip takes precedence over the filter, if any. <dl compact><dt><b>
303Since: </b><dd>
304DOM Level 2 </dl>    </td>
305  </tr>
306</table>
307<a name="z125_4" doxytag="DOMNodeIterator::nextNode"></a><p>
308<table width="100%" cellpadding="2" cellspacing="0" border="0">
309  <tr>
310    <td class="md">
311      <table cellpadding="0" cellspacing="0" border="0">
312        <tr>
313          <td class="md" nowrap valign="top"> virtual <a class="el" href="classDOMNode.html">DOMNode</a>* DOMNodeIterator::nextNode </td>
314          <td class="md" valign="top">(&nbsp;</td>
315          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
316          <td class="md" valign="top">)&nbsp;</td>
317          <td class="md" nowrap><code> [pure virtual]</code></td>
318        </tr>
319
320      </table>
321    </td>
322  </tr>
323</table>
324<table cellspacing=5 cellpadding=0 border=0>
325  <tr>
326    <td>
327      &nbsp;
328    </td>
329    <td>
330
331<p>
332Returns the next node in the set and advances the position of the <code>DOMNodeIterator</code> in the set.
333<p>
334After a <code>DOMNodeIterator</code> is created, the first call to <code><a class="el" href="classDOMNodeIterator.html#z125_4">nextNode</a>()</code> returns the first node in the set. <dl compact><dt><b>
335Returns: </b><dd>
336The next <code><a class="el" href="classDOMNode.html">DOMNode</a></code> in the set being iterated over, or <code>null</code> if there are no more members in that set. </dl><dl compact><dt><b>
337Exceptions: </b><dd>
338<table border=0 cellspacing=2 cellpadding=0>
339<tr><td valign=top><em><a class="el" href="classDOMException.html">DOMException</a></em>&nbsp;</td><td>
340 INVALID_STATE_ERR: Raised if this method is called after the <code>detach</code> method was invoked. </td></tr>
341</table>
342</dl><dl compact><dt><b>
343Since: </b><dd>
344DOM Level 2 </dl>    </td>
345  </tr>
346</table>
347<a name="z125_5" doxytag="DOMNodeIterator::previousNode"></a><p>
348<table width="100%" cellpadding="2" cellspacing="0" border="0">
349  <tr>
350    <td class="md">
351      <table cellpadding="0" cellspacing="0" border="0">
352        <tr>
353          <td class="md" nowrap valign="top"> virtual <a class="el" href="classDOMNode.html">DOMNode</a>* DOMNodeIterator::previousNode </td>
354          <td class="md" valign="top">(&nbsp;</td>
355          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
356          <td class="md" valign="top">)&nbsp;</td>
357          <td class="md" nowrap><code> [pure virtual]</code></td>
358        </tr>
359
360      </table>
361    </td>
362  </tr>
363</table>
364<table cellspacing=5 cellpadding=0 border=0>
365  <tr>
366    <td>
367      &nbsp;
368    </td>
369    <td>
370
371<p>
372Returns the previous node in the set and moves the position of the <code>DOMNodeIterator</code> backwards in the set.
373<p>
374<dl compact><dt><b>
375Returns: </b><dd>
376The previous <code><a class="el" href="classDOMNode.html">DOMNode</a></code> in the set being iterated over, or <code>null</code> if there are no more members in that set. </dl><dl compact><dt><b>
377Exceptions: </b><dd>
378<table border=0 cellspacing=2 cellpadding=0>
379<tr><td valign=top><em><a class="el" href="classDOMException.html">DOMException</a></em>&nbsp;</td><td>
380 INVALID_STATE_ERR: Raised if this method is called after the <code>detach</code> method was invoked. </td></tr>
381</table>
382</dl><dl compact><dt><b>
383Since: </b><dd>
384DOM Level 2 </dl>    </td>
385  </tr>
386</table>
387<a name="z126_0" doxytag="DOMNodeIterator::release"></a><p>
388<table width="100%" cellpadding="2" cellspacing="0" border="0">
389  <tr>
390    <td class="md">
391      <table cellpadding="0" cellspacing="0" border="0">
392        <tr>
393          <td class="md" nowrap valign="top"> virtual void DOMNodeIterator::release </td>
394          <td class="md" valign="top">(&nbsp;</td>
395          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
396          <td class="md" valign="top">)&nbsp;</td>
397          <td class="md" nowrap><code> [pure virtual]</code></td>
398        </tr>
399
400      </table>
401    </td>
402  </tr>
403</table>
404<table cellspacing=5 cellpadding=0 border=0>
405  <tr>
406    <td>
407      &nbsp;
408    </td>
409    <td>
410
411<p>
412Called to indicate that this NodeIterator is no longer in use and that the implementation may relinquish any resources associated with it.
413<p>
414(<a class="el" href="classDOMNodeIterator.html#z126_0">release</a>() will call <a class="el" href="classDOMNodeIterator.html#z125_6">detach</a>() where appropriate)
415<p>
416Access to a released object will lead to unexpected result.     </td>
417  </tr>
418</table>
419<hr>The documentation for this class was generated from the following file:<ul>
420<li><a class="el" href="DOMNodeIterator_8hpp-source.html">DOMNodeIterator.hpp</a></ul>
421    </FONT></TD></TR></TABLE><BR>
422</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>
423              Copyright &copy; 1994-2004 The Apache Software Foundation.
424              All Rights Reserved.
425            </I></FONT></TD></TR></TABLE></BODY></HTML>
Note: See TracBrowser for help on using the repository browser.