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

Revision 358, 39.5 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>DOMTreeWalker 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>DOMTreeWalker Class Reference</h1><code>DOMTreeWalker</code> objects are used to navigate a document tree or subtree using the view of the document defined by their <code>whatToShow</code> flags and filter (if any).
45<a href="#_details">More...</a>
46<p>
47<a href="classDOMTreeWalker-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="classDOMTreeWalker.html#z161_0">~DOMTreeWalker</a> ()</td></tr>
51<tr><td>&nbsp;</td><td><font size=-1><em>Destructor.</em> <a href="#z161_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="classDOMTreeWalker.html#z162_0">getRoot</a> ()=0</td></tr>
54<tr><td>&nbsp;</td><td><font size=-1><em>The <code>root</code> node of the <code>DOMTreeWalker</code>, as specified when it was created.</em> <a href="#z162_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="classDOMTreeWalker.html#z162_1">getWhatToShow</a> ()=0</td></tr>
56<tr><td>&nbsp;</td><td><font size=-1><em>This attribute determines which node types are presented via the <code>DOMTreeWalker</code>.</em> <a href="#z162_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="classDOMTreeWalker.html#z162_2">getFilter</a> ()=0</td></tr>
58<tr><td>&nbsp;</td><td><font size=-1><em>Return The filter used to screen nodes.</em> <a href="#z162_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="classDOMTreeWalker.html#z162_3">getExpandEntityReferences</a> ()=0</td></tr>
60<tr><td>&nbsp;</td><td><font size=-1><em>The value of this flag determines whether the children of entity reference nodes are visible to the <code>DOMTreeWalker</code>.</em> <a href="#z162_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="classDOMTreeWalker.html#z162_4">getCurrentNode</a> ()=0</td></tr>
62<tr><td>&nbsp;</td><td><font size=-1><em>Return the node at which the DOMTreeWalker is currently positioned.</em> <a href="#z162_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="classDOMTreeWalker.html#z162_5">parentNode</a> ()=0</td></tr>
64<tr><td>&nbsp;</td><td><font size=-1><em>Moves to and returns the closest visible ancestor node of the current node.</em> <a href="#z162_5">More...</a><em></em></font><br><br></td></tr>
65<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="classDOMTreeWalker.html#z162_6">firstChild</a> ()=0</td></tr>
66<tr><td>&nbsp;</td><td><font size=-1><em>Moves the <code>DOMTreeWalker</code> to the first visible child of the current node, and returns the new node.</em> <a href="#z162_6">More...</a><em></em></font><br><br></td></tr>
67<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="classDOMTreeWalker.html#z162_7">lastChild</a> ()=0</td></tr>
68<tr><td>&nbsp;</td><td><font size=-1><em>Moves the <code>DOMTreeWalker</code> to the last visible child of the current node, and returns the new node.</em> <a href="#z162_7">More...</a><em></em></font><br><br></td></tr>
69<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="classDOMTreeWalker.html#z162_8">previousSibling</a> ()=0</td></tr>
70<tr><td>&nbsp;</td><td><font size=-1><em>Moves the <code>DOMTreeWalker</code> to the previous sibling of the current node, and returns the new node.</em> <a href="#z162_8">More...</a><em></em></font><br><br></td></tr>
71<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="classDOMTreeWalker.html#z162_9">nextSibling</a> ()=0</td></tr>
72<tr><td>&nbsp;</td><td><font size=-1><em>Moves the <code>DOMTreeWalker</code> to the next sibling of the current node, and returns the new node.</em> <a href="#z162_9">More...</a><em></em></font><br><br></td></tr>
73<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="classDOMTreeWalker.html#z162_10">previousNode</a> ()=0</td></tr>
74<tr><td>&nbsp;</td><td><font size=-1><em>Moves the <code>DOMTreeWalker</code> to the previous visible node in document order relative to the current node, and returns the new node.</em> <a href="#z162_10">More...</a><em></em></font><br><br></td></tr>
75<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="classDOMTreeWalker.html#z162_11">nextNode</a> ()=0</td></tr>
76<tr><td>&nbsp;</td><td><font size=-1><em>Moves the <code>DOMTreeWalker</code> to the next visible node in document order relative to the current node, and returns the new node.</em> <a href="#z162_11">More...</a><em></em></font><br><br></td></tr>
77<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDOMTreeWalker.html#z162_12">setCurrentNode</a> (<a class="el" href="classDOMNode.html">DOMNode</a> *currentNode)=0</td></tr>
78<tr><td>&nbsp;</td><td><font size=-1><em>The node at which the <code>DOMTreeWalker</code> is currently positioned.</em> <a href="#z162_12">More...</a><em></em></font><br><br></td></tr>
79<tr><td colspan="2"><div class="groupHeader">Non-standard Extension</div></td></tr>
80<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDOMTreeWalker.html#z163_0">release</a> ()=0</td></tr>
81<tr><td>&nbsp;</td><td><font size=-1><em>Called to indicate that this TreeWalker is no longer in use and that the implementation may relinquish any resources associated with it.</em> <a href="#z163_0">More...</a><em></em></font><br><br></td></tr>
82<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
83<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
84<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classDOMTreeWalker.html#z159_0">DOMTreeWalker</a> ()</td></tr>
85</table>
86<hr><a name="_details"></a><h2>Detailed Description</h2>
87<code>DOMTreeWalker</code> objects are used to navigate a document tree or subtree using the view of the document defined by their <code>whatToShow</code> flags and filter (if any).
88<p>
89Any function which performs navigation using a <code>DOMTreeWalker</code> will automatically support any view defined by a <code>DOMTreeWalker</code>.
90<p>
91Omitting 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 <code>DOMTreeWalker</code> view may be children of different, widely separated nodes in the original view. For instance, consider a <code><a class="el" href="classDOMNodeFilter.html">DOMNodeFilter</a></code> 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.
92<p>
93See 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>.
94<p>
95<dl compact><dt><b>
96Since: </b><dd>
97DOM Level 2 </dl>
98<p>
99<hr><h2>Constructor &amp; Destructor Documentation</h2>
100<a name="z159_0" doxytag="DOMTreeWalker::DOMTreeWalker"></a><p>
101<table width="100%" cellpadding="2" cellspacing="0" border="0">
102  <tr>
103    <td class="md">
104      <table cellpadding="0" cellspacing="0" border="0">
105        <tr>
106          <td class="md" nowrap valign="top"> DOMTreeWalker::DOMTreeWalker </td>
107          <td class="md" valign="top">(&nbsp;</td>
108          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
109          <td class="md" valign="top">)&nbsp;</td>
110          <td class="md" nowrap><code> [protected]</code></td>
111        </tr>
112
113      </table>
114    </td>
115  </tr>
116</table>
117<table cellspacing=5 cellpadding=0 border=0>
118  <tr>
119    <td>
120      &nbsp;
121    </td>
122    <td>
123
124<p>
125    </td>
126  </tr>
127</table>
128<a name="z161_0" doxytag="DOMTreeWalker::~DOMTreeWalker"></a><p>
129<table width="100%" cellpadding="2" cellspacing="0" border="0">
130  <tr>
131    <td class="md">
132      <table cellpadding="0" cellspacing="0" border="0">
133        <tr>
134          <td class="md" nowrap valign="top"> virtual DOMTreeWalker::~DOMTreeWalker </td>
135          <td class="md" valign="top">(&nbsp;</td>
136          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
137          <td class="md" valign="top">)&nbsp;</td>
138          <td class="md" nowrap><code> [virtual]</code></td>
139        </tr>
140
141      </table>
142    </td>
143  </tr>
144</table>
145<table cellspacing=5 cellpadding=0 border=0>
146  <tr>
147    <td>
148      &nbsp;
149    </td>
150    <td>
151
152<p>
153Destructor.
154<p>
155    </td>
156  </tr>
157</table>
158<hr><h2>Member Function Documentation</h2>
159<a name="z162_6" doxytag="DOMTreeWalker::firstChild"></a><p>
160<table width="100%" cellpadding="2" cellspacing="0" border="0">
161  <tr>
162    <td class="md">
163      <table cellpadding="0" cellspacing="0" border="0">
164        <tr>
165          <td class="md" nowrap valign="top"> virtual <a class="el" href="classDOMNode.html">DOMNode</a>* DOMTreeWalker::firstChild </td>
166          <td class="md" valign="top">(&nbsp;</td>
167          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
168          <td class="md" valign="top">)&nbsp;</td>
169          <td class="md" nowrap><code> [pure virtual]</code></td>
170        </tr>
171
172      </table>
173    </td>
174  </tr>
175</table>
176<table cellspacing=5 cellpadding=0 border=0>
177  <tr>
178    <td>
179      &nbsp;
180    </td>
181    <td>
182
183<p>
184Moves the <code>DOMTreeWalker</code> to the first visible child of the current node, and returns the new node.
185<p>
186If the current node has no visible children, returns <code>null</code>, and retains the current node. <dl compact><dt><b>
187Returns: </b><dd>
188The new node, or <code>null</code> if the current node has no visible children in the <code>DOMTreeWalker</code>'s logical view.</dl><dl compact><dt><b>
189Since: </b><dd>
190DOM Level 2 </dl>    </td>
191  </tr>
192</table>
193<a name="z162_4" doxytag="DOMTreeWalker::getCurrentNode"></a><p>
194<table width="100%" cellpadding="2" cellspacing="0" border="0">
195  <tr>
196    <td class="md">
197      <table cellpadding="0" cellspacing="0" border="0">
198        <tr>
199          <td class="md" nowrap valign="top"> virtual <a class="el" href="classDOMNode.html">DOMNode</a>* DOMTreeWalker::getCurrentNode </td>
200          <td class="md" valign="top">(&nbsp;</td>
201          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
202          <td class="md" valign="top">)&nbsp;</td>
203          <td class="md" nowrap><code> [pure virtual]</code></td>
204        </tr>
205
206      </table>
207    </td>
208  </tr>
209</table>
210<table cellspacing=5 cellpadding=0 border=0>
211  <tr>
212    <td>
213      &nbsp;
214    </td>
215    <td>
216
217<p>
218Return the node at which the DOMTreeWalker is currently positioned.
219<p>
220<dl compact><dt><b>
221Since: </b><dd>
222DOM Level 2 </dl>    </td>
223  </tr>
224</table>
225<a name="z162_3" doxytag="DOMTreeWalker::getExpandEntityReferences"></a><p>
226<table width="100%" cellpadding="2" cellspacing="0" border="0">
227  <tr>
228    <td class="md">
229      <table cellpadding="0" cellspacing="0" border="0">
230        <tr>
231          <td class="md" nowrap valign="top"> virtual bool DOMTreeWalker::getExpandEntityReferences </td>
232          <td class="md" valign="top">(&nbsp;</td>
233          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
234          <td class="md" valign="top">)&nbsp;</td>
235          <td class="md" nowrap><code> [pure virtual]</code></td>
236        </tr>
237
238      </table>
239    </td>
240  </tr>
241</table>
242<table cellspacing=5 cellpadding=0 border=0>
243  <tr>
244    <td>
245      &nbsp;
246    </td>
247    <td>
248
249<p>
250The value of this flag determines whether the children of entity reference nodes are visible to the <code>DOMTreeWalker</code>.
251<p>
252If false, these children and their descendants will be rejected. Note that this rejection takes precedence over <code>whatToShow</code> and the filter, if any. <br>
253 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>DOMTreeWalker</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.
254<p>
255<dl compact><dt><b>
256Since: </b><dd>
257DOM Level 2 </dl>    </td>
258  </tr>
259</table>
260<a name="z162_2" doxytag="DOMTreeWalker::getFilter"></a><p>
261<table width="100%" cellpadding="2" cellspacing="0" border="0">
262  <tr>
263    <td class="md">
264      <table cellpadding="0" cellspacing="0" border="0">
265        <tr>
266          <td class="md" nowrap valign="top"> virtual <a class="el" href="classDOMNodeFilter.html">DOMNodeFilter</a>* DOMTreeWalker::getFilter </td>
267          <td class="md" valign="top">(&nbsp;</td>
268          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
269          <td class="md" valign="top">)&nbsp;</td>
270          <td class="md" nowrap><code> [pure virtual]</code></td>
271        </tr>
272
273      </table>
274    </td>
275  </tr>
276</table>
277<table cellspacing=5 cellpadding=0 border=0>
278  <tr>
279    <td>
280      &nbsp;
281    </td>
282    <td>
283
284<p>
285Return The filter used to screen nodes.
286<p>
287<dl compact><dt><b>
288Since: </b><dd>
289DOM Level 2 </dl>    </td>
290  </tr>
291</table>
292<a name="z162_0" doxytag="DOMTreeWalker::getRoot"></a><p>
293<table width="100%" cellpadding="2" cellspacing="0" border="0">
294  <tr>
295    <td class="md">
296      <table cellpadding="0" cellspacing="0" border="0">
297        <tr>
298          <td class="md" nowrap valign="top"> virtual <a class="el" href="classDOMNode.html">DOMNode</a>* DOMTreeWalker::getRoot </td>
299          <td class="md" valign="top">(&nbsp;</td>
300          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
301          <td class="md" valign="top">)&nbsp;</td>
302          <td class="md" nowrap><code> [pure virtual]</code></td>
303        </tr>
304
305      </table>
306    </td>
307  </tr>
308</table>
309<table cellspacing=5 cellpadding=0 border=0>
310  <tr>
311    <td>
312      &nbsp;
313    </td>
314    <td>
315
316<p>
317The <code>root</code> node of the <code>DOMTreeWalker</code>, as specified when it was created.
318<p>
319<dl compact><dt><b>
320Since: </b><dd>
321DOM Level 2 </dl>    </td>
322  </tr>
323</table>
324<a name="z162_1" doxytag="DOMTreeWalker::getWhatToShow"></a><p>
325<table width="100%" cellpadding="2" cellspacing="0" border="0">
326  <tr>
327    <td class="md">
328      <table cellpadding="0" cellspacing="0" border="0">
329        <tr>
330          <td class="md" nowrap valign="top"> virtual unsigned long DOMTreeWalker::getWhatToShow </td>
331          <td class="md" valign="top">(&nbsp;</td>
332          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
333          <td class="md" valign="top">)&nbsp;</td>
334          <td class="md" nowrap><code> [pure virtual]</code></td>
335        </tr>
336
337      </table>
338    </td>
339  </tr>
340</table>
341<table cellspacing=5 cellpadding=0 border=0>
342  <tr>
343    <td>
344      &nbsp;
345    </td>
346    <td>
347
348<p>
349This attribute determines which node types are presented via the <code>DOMTreeWalker</code>.
350<p>
351The 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.
352<p>
353<dl compact><dt><b>
354Since: </b><dd>
355DOM Level 2 </dl>    </td>
356  </tr>
357</table>
358<a name="z162_7" doxytag="DOMTreeWalker::lastChild"></a><p>
359<table width="100%" cellpadding="2" cellspacing="0" border="0">
360  <tr>
361    <td class="md">
362      <table cellpadding="0" cellspacing="0" border="0">
363        <tr>
364          <td class="md" nowrap valign="top"> virtual <a class="el" href="classDOMNode.html">DOMNode</a>* DOMTreeWalker::lastChild </td>
365          <td class="md" valign="top">(&nbsp;</td>
366          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
367          <td class="md" valign="top">)&nbsp;</td>
368          <td class="md" nowrap><code> [pure virtual]</code></td>
369        </tr>
370
371      </table>
372    </td>
373  </tr>
374</table>
375<table cellspacing=5 cellpadding=0 border=0>
376  <tr>
377    <td>
378      &nbsp;
379    </td>
380    <td>
381
382<p>
383Moves the <code>DOMTreeWalker</code> to the last visible child of the current node, and returns the new node.
384<p>
385If the current node has no visible children, returns <code>null</code>, and retains the current node. <dl compact><dt><b>
386Returns: </b><dd>
387The new node, or <code>null</code> if the current node has no children in the <code>DOMTreeWalker</code>'s logical view.</dl><dl compact><dt><b>
388Since: </b><dd>
389DOM Level 2 </dl>    </td>
390  </tr>
391</table>
392<a name="z162_11" doxytag="DOMTreeWalker::nextNode"></a><p>
393<table width="100%" cellpadding="2" cellspacing="0" border="0">
394  <tr>
395    <td class="md">
396      <table cellpadding="0" cellspacing="0" border="0">
397        <tr>
398          <td class="md" nowrap valign="top"> virtual <a class="el" href="classDOMNode.html">DOMNode</a>* DOMTreeWalker::nextNode </td>
399          <td class="md" valign="top">(&nbsp;</td>
400          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
401          <td class="md" valign="top">)&nbsp;</td>
402          <td class="md" nowrap><code> [pure virtual]</code></td>
403        </tr>
404
405      </table>
406    </td>
407  </tr>
408</table>
409<table cellspacing=5 cellpadding=0 border=0>
410  <tr>
411    <td>
412      &nbsp;
413    </td>
414    <td>
415
416<p>
417Moves the <code>DOMTreeWalker</code> to the next visible node in document order relative to the current node, and returns the new node.
418<p>
419If the current node has no next node, or if the search for nextNode attempts to step upward from the <code>DOMTreeWalker</code>'s <code>root</code> node, returns <code>null</code>, and retains the current node. <dl compact><dt><b>
420Returns: </b><dd>
421The new node, or <code>null</code> if the current node has no next node in the <code>DOMTreeWalker</code>'s logical view.</dl><dl compact><dt><b>
422Since: </b><dd>
423DOM Level 2 </dl>    </td>
424  </tr>
425</table>
426<a name="z162_9" doxytag="DOMTreeWalker::nextSibling"></a><p>
427<table width="100%" cellpadding="2" cellspacing="0" border="0">
428  <tr>
429    <td class="md">
430      <table cellpadding="0" cellspacing="0" border="0">
431        <tr>
432          <td class="md" nowrap valign="top"> virtual <a class="el" href="classDOMNode.html">DOMNode</a>* DOMTreeWalker::nextSibling </td>
433          <td class="md" valign="top">(&nbsp;</td>
434          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
435          <td class="md" valign="top">)&nbsp;</td>
436          <td class="md" nowrap><code> [pure virtual]</code></td>
437        </tr>
438
439      </table>
440    </td>
441  </tr>
442</table>
443<table cellspacing=5 cellpadding=0 border=0>
444  <tr>
445    <td>
446      &nbsp;
447    </td>
448    <td>
449
450<p>
451Moves the <code>DOMTreeWalker</code> to the next sibling of the current node, and returns the new node.
452<p>
453If the current node has no visible next sibling, returns <code>null</code>, and retains the current node. <dl compact><dt><b>
454Returns: </b><dd>
455The new node, or <code>null</code> if the current node has no next sibling. in the <code>DOMTreeWalker</code>'s logical view.</dl><dl compact><dt><b>
456Since: </b><dd>
457DOM Level 2 </dl>    </td>
458  </tr>
459</table>
460<a name="z162_5" doxytag="DOMTreeWalker::parentNode"></a><p>
461<table width="100%" cellpadding="2" cellspacing="0" border="0">
462  <tr>
463    <td class="md">
464      <table cellpadding="0" cellspacing="0" border="0">
465        <tr>
466          <td class="md" nowrap valign="top"> virtual <a class="el" href="classDOMNode.html">DOMNode</a>* DOMTreeWalker::parentNode </td>
467          <td class="md" valign="top">(&nbsp;</td>
468          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
469          <td class="md" valign="top">)&nbsp;</td>
470          <td class="md" nowrap><code> [pure virtual]</code></td>
471        </tr>
472
473      </table>
474    </td>
475  </tr>
476</table>
477<table cellspacing=5 cellpadding=0 border=0>
478  <tr>
479    <td>
480      &nbsp;
481    </td>
482    <td>
483
484<p>
485Moves to and returns the closest visible ancestor node of the current node.
486<p>
487If the search for <code>parentNode</code> attempts to step upward from the <code>DOMTreeWalker</code>'s <code>root</code> node, or if it fails to find a visible ancestor node, this method retains the current position and returns <code>null</code>. <dl compact><dt><b>
488Returns: </b><dd>
489The new parent node, or <code>null</code> if the current node has no parent in the <code>DOMTreeWalker</code>'s logical view.</dl><dl compact><dt><b>
490Since: </b><dd>
491DOM Level 2 </dl>    </td>
492  </tr>
493</table>
494<a name="z162_10" doxytag="DOMTreeWalker::previousNode"></a><p>
495<table width="100%" cellpadding="2" cellspacing="0" border="0">
496  <tr>
497    <td class="md">
498      <table cellpadding="0" cellspacing="0" border="0">
499        <tr>
500          <td class="md" nowrap valign="top"> virtual <a class="el" href="classDOMNode.html">DOMNode</a>* DOMTreeWalker::previousNode </td>
501          <td class="md" valign="top">(&nbsp;</td>
502          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
503          <td class="md" valign="top">)&nbsp;</td>
504          <td class="md" nowrap><code> [pure virtual]</code></td>
505        </tr>
506
507      </table>
508    </td>
509  </tr>
510</table>
511<table cellspacing=5 cellpadding=0 border=0>
512  <tr>
513    <td>
514      &nbsp;
515    </td>
516    <td>
517
518<p>
519Moves the <code>DOMTreeWalker</code> to the previous visible node in document order relative to the current node, and returns the new node.
520<p>
521If the current node has no previous node, or if the search for <code>previousNode</code> attempts to step upward from the <code>DOMTreeWalker</code>'s <code>root</code> node, returns <code>null</code>, and retains the current node. <dl compact><dt><b>
522Returns: </b><dd>
523The new node, or <code>null</code> if the current node has no previous node in the <code>DOMTreeWalker</code>'s logical view.</dl><dl compact><dt><b>
524Since: </b><dd>
525DOM Level 2 </dl>    </td>
526  </tr>
527</table>
528<a name="z162_8" doxytag="DOMTreeWalker::previousSibling"></a><p>
529<table width="100%" cellpadding="2" cellspacing="0" border="0">
530  <tr>
531    <td class="md">
532      <table cellpadding="0" cellspacing="0" border="0">
533        <tr>
534          <td class="md" nowrap valign="top"> virtual <a class="el" href="classDOMNode.html">DOMNode</a>* DOMTreeWalker::previousSibling </td>
535          <td class="md" valign="top">(&nbsp;</td>
536          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
537          <td class="md" valign="top">)&nbsp;</td>
538          <td class="md" nowrap><code> [pure virtual]</code></td>
539        </tr>
540
541      </table>
542    </td>
543  </tr>
544</table>
545<table cellspacing=5 cellpadding=0 border=0>
546  <tr>
547    <td>
548      &nbsp;
549    </td>
550    <td>
551
552<p>
553Moves the <code>DOMTreeWalker</code> to the previous sibling of the current node, and returns the new node.
554<p>
555If the current node has no visible previous sibling, returns <code>null</code>, and retains the current node. <dl compact><dt><b>
556Returns: </b><dd>
557The new node, or <code>null</code> if the current node has no previous sibling. in the <code>DOMTreeWalker</code>'s logical view.</dl><dl compact><dt><b>
558Since: </b><dd>
559DOM Level 2 </dl>    </td>
560  </tr>
561</table>
562<a name="z163_0" doxytag="DOMTreeWalker::release"></a><p>
563<table width="100%" cellpadding="2" cellspacing="0" border="0">
564  <tr>
565    <td class="md">
566      <table cellpadding="0" cellspacing="0" border="0">
567        <tr>
568          <td class="md" nowrap valign="top"> virtual void DOMTreeWalker::release </td>
569          <td class="md" valign="top">(&nbsp;</td>
570          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
571          <td class="md" valign="top">)&nbsp;</td>
572          <td class="md" nowrap><code> [pure virtual]</code></td>
573        </tr>
574
575      </table>
576    </td>
577  </tr>
578</table>
579<table cellspacing=5 cellpadding=0 border=0>
580  <tr>
581    <td>
582      &nbsp;
583    </td>
584    <td>
585
586<p>
587Called to indicate that this TreeWalker is no longer in use and that the implementation may relinquish any resources associated with it.
588<p>
589Access to a released object will lead to unexpected result.     </td>
590  </tr>
591</table>
592<a name="z162_12" doxytag="DOMTreeWalker::setCurrentNode"></a><p>
593<table width="100%" cellpadding="2" cellspacing="0" border="0">
594  <tr>
595    <td class="md">
596      <table cellpadding="0" cellspacing="0" border="0">
597        <tr>
598          <td class="md" nowrap valign="top"> virtual void DOMTreeWalker::setCurrentNode </td>
599          <td class="md" valign="top">(&nbsp;</td>
600          <td class="md" nowrap valign="top"><a class="el" href="classDOMNode.html">DOMNode</a> *&nbsp;</td>
601          <td class="mdname1" valign="top" nowrap>&nbsp; <em>currentNode</em>          </td>
602          <td class="md" valign="top">)&nbsp;</td>
603          <td class="md" nowrap><code> [pure virtual]</code></td>
604        </tr>
605
606      </table>
607    </td>
608  </tr>
609</table>
610<table cellspacing=5 cellpadding=0 border=0>
611  <tr>
612    <td>
613      &nbsp;
614    </td>
615    <td>
616
617<p>
618The node at which the <code>DOMTreeWalker</code> is currently positioned.
619<p>
620<br>
621Alterations to the DOM tree may cause the current node to no longer be accepted by the <code>DOMTreeWalker</code>'s associated filter. <code>currentNode</code> may also be explicitly set to any node, whether or not it is within the subtree specified by the <code>root</code> node or would be accepted by the filter and <code>whatToShow</code> flags. Further traversal occurs relative to <code>currentNode</code> even if it is not part of the current view, by applying the filters in the requested direction; if no traversal is possible, <code>currentNode</code> is not changed. <dl compact><dt><b>
622Exceptions: </b><dd>
623<table border=0 cellspacing=2 cellpadding=0>
624<tr><td valign=top><em><a class="el" href="classDOMException.html">DOMException</a></em>&nbsp;</td><td>
625 NOT_SUPPORTED_ERR: Raised if an attempt is made to set <code>currentNode</code> to <code>null</code>.</td></tr>
626</table>
627</dl><dl compact><dt><b>
628Since: </b><dd>
629DOM Level 2 </dl>    </td>
630  </tr>
631</table>
632<hr>The documentation for this class was generated from the following file:<ul>
633<li><a class="el" href="DOMTreeWalker_8hpp-source.html">DOMTreeWalker.hpp</a></ul>
634    </FONT></TD></TR></TABLE><BR>
635</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>
636              Copyright &copy; 1994-2004 The Apache Software Foundation.
637              All Rights Reserved.
638            </I></FONT></TD></TR></TABLE></BODY></HTML>
Note: See TracBrowser for help on using the repository browser.