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

Revision 358, 18.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>DOMNodeList 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>DOMNodeList Class Reference</h1>The <code>DOMNodeList</code> interface provides the abstraction of an ordered collection of nodes.
45<a href="#_details">More...</a>
46<p>
47<a href="classDOMNodeList-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="classDOMNodeList.html#z129_0">~DOMNodeList</a> ()</td></tr>
51<tr><td>&nbsp;</td><td><font size=-1><em>Destructor.</em> <a href="#z129_0">More...</a><em></em></font><br><br></td></tr>
52<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 1</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="classDOMNodeList.html#z130_0">item</a> (XMLSize_t index) const=0</td></tr>
54<tr><td>&nbsp;</td><td><font size=-1><em>Returns the <code>index</code> item in the collection.</em> <a href="#z130_0">More...</a><em></em></font><br><br></td></tr>
55<tr><td nowrap align=right valign=top>virtual XMLSize_t&nbsp;</td><td valign=bottom><a class="el" href="classDOMNodeList.html#z130_1">getLength</a> () const=0</td></tr>
56<tr><td>&nbsp;</td><td><font size=-1><em>Returns the number of nodes in the list.</em> <a href="#z130_1">More...</a><em></em></font><br><br></td></tr>
57<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
58<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
59<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classDOMNodeList.html#z127_0">DOMNodeList</a> ()</td></tr>
60</table>
61<hr><a name="_details"></a><h2>Detailed Description</h2>
62The <code>DOMNodeList</code> interface provides the abstraction of an ordered collection of nodes.
63<p>
64DOMNodeLists are created by <a class="el" href="classDOMDocument.html#z28_11">DOMDocument::getElementsByTagName</a>(), <a class="el" href="classDOMNode.html#z113_4">DOMNode::getChildNodes</a>(),
65<p>
66
67<p>
68The items in the <code>DOMNodeList</code> are accessible via an integral index, starting from 0.
69<p>
70DOMNodeLists are "live", in that any changes to the document tree are immediately reflected in any DOMNodeLists that may have been created for that tree.
71<p>
72<hr><h2>Constructor &amp; Destructor Documentation</h2>
73<a name="z127_0" doxytag="DOMNodeList::DOMNodeList"></a><p>
74<table width="100%" cellpadding="2" cellspacing="0" border="0">
75  <tr>
76    <td class="md">
77      <table cellpadding="0" cellspacing="0" border="0">
78        <tr>
79          <td class="md" nowrap valign="top"> DOMNodeList::DOMNodeList </td>
80          <td class="md" valign="top">(&nbsp;</td>
81          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
82          <td class="md" valign="top">)&nbsp;</td>
83          <td class="md" nowrap><code> [protected]</code></td>
84        </tr>
85
86      </table>
87    </td>
88  </tr>
89</table>
90<table cellspacing=5 cellpadding=0 border=0>
91  <tr>
92    <td>
93      &nbsp;
94    </td>
95    <td>
96
97<p>
98    </td>
99  </tr>
100</table>
101<a name="z129_0" doxytag="DOMNodeList::~DOMNodeList"></a><p>
102<table width="100%" cellpadding="2" cellspacing="0" border="0">
103  <tr>
104    <td class="md">
105      <table cellpadding="0" cellspacing="0" border="0">
106        <tr>
107          <td class="md" nowrap valign="top"> virtual DOMNodeList::~DOMNodeList </td>
108          <td class="md" valign="top">(&nbsp;</td>
109          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
110          <td class="md" valign="top">)&nbsp;</td>
111          <td class="md" nowrap><code> [virtual]</code></td>
112        </tr>
113
114      </table>
115    </td>
116  </tr>
117</table>
118<table cellspacing=5 cellpadding=0 border=0>
119  <tr>
120    <td>
121      &nbsp;
122    </td>
123    <td>
124
125<p>
126Destructor.
127<p>
128    </td>
129  </tr>
130</table>
131<hr><h2>Member Function Documentation</h2>
132<a name="z130_1" doxytag="DOMNodeList::getLength"></a><p>
133<table width="100%" cellpadding="2" cellspacing="0" border="0">
134  <tr>
135    <td class="md">
136      <table cellpadding="0" cellspacing="0" border="0">
137        <tr>
138          <td class="md" nowrap valign="top"> virtual XMLSize_t DOMNodeList::getLength </td>
139          <td class="md" valign="top">(&nbsp;</td>
140          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
141          <td class="md" valign="top">)&nbsp;</td>
142          <td class="md" nowrap> const<code> [pure virtual]</code></td>
143        </tr>
144
145      </table>
146    </td>
147  </tr>
148</table>
149<table cellspacing=5 cellpadding=0 border=0>
150  <tr>
151    <td>
152      &nbsp;
153    </td>
154    <td>
155
156<p>
157Returns the number of nodes in the list.
158<p>
159The range of valid child node indices is 0 to <code>length-1</code> inclusive. <dl compact><dt><b>
160Since: </b><dd>
161DOM Level 1 </dl>    </td>
162  </tr>
163</table>
164<a name="z130_0" doxytag="DOMNodeList::item"></a><p>
165<table width="100%" cellpadding="2" cellspacing="0" border="0">
166  <tr>
167    <td class="md">
168      <table cellpadding="0" cellspacing="0" border="0">
169        <tr>
170          <td class="md" nowrap valign="top"> virtual <a class="el" href="classDOMNode.html">DOMNode</a>* DOMNodeList::item </td>
171          <td class="md" valign="top">(&nbsp;</td>
172          <td class="md" nowrap valign="top">XMLSize_t&nbsp;</td>
173          <td class="mdname1" valign="top" nowrap>&nbsp; <em>index</em>          </td>
174          <td class="md" valign="top">)&nbsp;</td>
175          <td class="md" nowrap> const<code> [pure virtual]</code></td>
176        </tr>
177
178      </table>
179    </td>
180  </tr>
181</table>
182<table cellspacing=5 cellpadding=0 border=0>
183  <tr>
184    <td>
185      &nbsp;
186    </td>
187    <td>
188
189<p>
190Returns the <code>index</code> item in the collection.
191<p>
192If <code>index</code> is greater than or equal to the number of nodes in the list, this returns <code>null</code>.<dl compact><dt><b>
193Parameters: </b><dd>
194<table border=0 cellspacing=2 cellpadding=0>
195<tr><td valign=top><em>index</em>&nbsp;</td><td>
196Index into the collection. </td></tr>
197</table>
198</dl><dl compact><dt><b>
199Returns: </b><dd>
200The node at the <code>index</code>th position in the <code>DOMNodeList</code>, or <code>null</code> if that is not a valid index. </dl><dl compact><dt><b>
201Since: </b><dd>
202DOM Level 1 </dl>    </td>
203  </tr>
204</table>
205<hr>The documentation for this class was generated from the following file:<ul>
206<li><a class="el" href="DOMNodeList_8hpp-source.html">DOMNodeList.hpp</a></ul>
207    </FONT></TD></TR></TABLE><BR>
208</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>
209              Copyright &copy; 1994-2004 The Apache Software Foundation.
210              All Rights Reserved.
211            </I></FONT></TD></TR></TABLE></BODY></HTML>
Note: See TracBrowser for help on using the repository browser.