mirror/XQuilla
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
XQuilla/docs/dom3-api/classxercesc_1_1DOMNodeIterator.html
King_DuckZ 3552e76c6c v2.3.4
2020-02-17 22:24:47 +01:00

404 lines
26 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XQilla DOM3 API Documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<a style="float:right;" href="http://sourceforge.net/projects/xqilla"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=152021&amp;type=2" border="0" alt="SourceForge.net Logo" /></a>
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacexercesc.html">xercesc</a></li><li class="navelem"><a class="el" href="classxercesc_1_1DOMNodeIterator.html">DOMNodeIterator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="classxercesc_1_1DOMNodeIterator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">xercesc::DOMNodeIterator Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p><code>DOMNodeIterators</code> are used to step through a set of nodes, e.g.
<a href="classxercesc_1_1DOMNodeIterator.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="DOMNodeIterator_8hpp_source.html">DOMNodeIterator.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
<tr class="memitem:a105fa0bd67d282c9f07c6e42c6e979e6"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMNodeIterator.html#a105fa0bd67d282c9f07c6e42c6e979e6">~DOMNodeIterator</a> ()</td></tr>
<tr class="memdesc:a105fa0bd67d282c9f07c6e42c6e979e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <a href="#a105fa0bd67d282c9f07c6e42c6e979e6">More...</a><br/></td></tr>
<tr class="separator:a105fa0bd67d282c9f07c6e42c6e979e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 2</div></td></tr>
<tr class="memitem:a2456566bcf0b85b45e0d363d8b31e077"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMNodeIterator.html#a2456566bcf0b85b45e0d363d8b31e077">getRoot</a> ()=0</td></tr>
<tr class="memdesc:a2456566bcf0b85b45e0d363d8b31e077"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <code>root</code> node of the <code><a class="el" href="classxercesc_1_1DOMNodeIterator.html" title="DOMNodeIterators are used to step through a set of nodes, e.g. ">DOMNodeIterator</a></code>, as specified when it was created. <a href="#a2456566bcf0b85b45e0d363d8b31e077">More...</a><br/></td></tr>
<tr class="separator:a2456566bcf0b85b45e0d363d8b31e077"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afada4dca6194bce8dacdbfeb642700c7"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classxercesc_1_1DOMNodeFilter.html#a321889e59b1aa23cd84e980cbb415c0c">DOMNodeFilter::ShowType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMNodeIterator.html#afada4dca6194bce8dacdbfeb642700c7">getWhatToShow</a> ()=0</td></tr>
<tr class="memdesc:afada4dca6194bce8dacdbfeb642700c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return which node types are presented via the iterator. <a href="#afada4dca6194bce8dacdbfeb642700c7">More...</a><br/></td></tr>
<tr class="separator:afada4dca6194bce8dacdbfeb642700c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2199e825391cbe4f915d68055cbf0f63"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classxercesc_1_1DOMNodeFilter.html">DOMNodeFilter</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMNodeIterator.html#a2199e825391cbe4f915d68055cbf0f63">getFilter</a> ()=0</td></tr>
<tr class="memdesc:a2199e825391cbe4f915d68055cbf0f63"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <code><a class="el" href="classxercesc_1_1DOMNodeFilter.html" title="Filters are objects that know how to &quot;filter out&quot; nodes. ">DOMNodeFilter</a></code> used to screen nodes. <a href="#a2199e825391cbe4f915d68055cbf0f63">More...</a><br/></td></tr>
<tr class="separator:a2199e825391cbe4f915d68055cbf0f63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77413f9c80acb65270794ec51a949102"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMNodeIterator.html#a77413f9c80acb65270794ec51a949102">getExpandEntityReferences</a> ()=0</td></tr>
<tr class="memdesc:a77413f9c80acb65270794ec51a949102"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the expandEntityReferences flag. <a href="#a77413f9c80acb65270794ec51a949102">More...</a><br/></td></tr>
<tr class="separator:a77413f9c80acb65270794ec51a949102"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1390e52c18ba1c69938c4c0e79493b74"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMNodeIterator.html#a1390e52c18ba1c69938c4c0e79493b74">nextNode</a> ()=0</td></tr>
<tr class="memdesc:a1390e52c18ba1c69938c4c0e79493b74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the next node in the set and advances the position of the <code><a class="el" href="classxercesc_1_1DOMNodeIterator.html" title="DOMNodeIterators are used to step through a set of nodes, e.g. ">DOMNodeIterator</a></code> in the set. <a href="#a1390e52c18ba1c69938c4c0e79493b74">More...</a><br/></td></tr>
<tr class="separator:a1390e52c18ba1c69938c4c0e79493b74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa1b89f85962844c9179ddb07de9dea2f"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMNodeIterator.html#aa1b89f85962844c9179ddb07de9dea2f">previousNode</a> ()=0</td></tr>
<tr class="memdesc:aa1b89f85962844c9179ddb07de9dea2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the previous node in the set and moves the position of the <code><a class="el" href="classxercesc_1_1DOMNodeIterator.html" title="DOMNodeIterators are used to step through a set of nodes, e.g. ">DOMNodeIterator</a></code> backwards in the set. <a href="#aa1b89f85962844c9179ddb07de9dea2f">More...</a><br/></td></tr>
<tr class="separator:aa1b89f85962844c9179ddb07de9dea2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab69531f583d05578b832dd39baaaa29d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMNodeIterator.html#ab69531f583d05578b832dd39baaaa29d">detach</a> ()=0</td></tr>
<tr class="memdesc:ab69531f583d05578b832dd39baaaa29d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Detaches the <code><a class="el" href="classxercesc_1_1DOMNodeIterator.html" title="DOMNodeIterators are used to step through a set of nodes, e.g. ">DOMNodeIterator</a></code> from the set which it iterated over, releasing any computational resources and placing the <code><a class="el" href="classxercesc_1_1DOMNodeIterator.html" title="DOMNodeIterators are used to step through a set of nodes, e.g. ">DOMNodeIterator</a></code> in the INVALID state. <a href="#ab69531f583d05578b832dd39baaaa29d">More...</a><br/></td></tr>
<tr class="separator:ab69531f583d05578b832dd39baaaa29d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Non-standard Extension</div></td></tr>
<tr class="memitem:a1d40a76868bd11af332d674931dd3b95"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMNodeIterator.html#a1d40a76868bd11af332d674931dd3b95">release</a> ()=0</td></tr>
<tr class="memdesc:a1d40a76868bd11af332d674931dd3b95"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called to indicate that this NodeIterator is no longer in use and that the implementation may relinquish any resources associated with it. <a href="#a1d40a76868bd11af332d674931dd3b95">More...</a><br/></td></tr>
<tr class="separator:a1d40a76868bd11af332d674931dd3b95"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
<tr class="memitem:ae709d8376b58beb2409d85bf608599af"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMNodeIterator.html#ae709d8376b58beb2409d85bf608599af">DOMNodeIterator</a> ()</td></tr>
<tr class="separator:ae709d8376b58beb2409d85bf608599af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9bf8c06a66a7379b24afd325a4d83250"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1DOMNodeIterator.html#a9bf8c06a66a7379b24afd325a4d83250">DOMNodeIterator</a> (const <a class="el" href="classxercesc_1_1DOMNodeIterator.html">DOMNodeIterator</a> &amp;)</td></tr>
<tr class="separator:a9bf8c06a66a7379b24afd325a4d83250"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><code>DOMNodeIterators</code> are used to step through a set of nodes, e.g. </p>
<p>the set of nodes in a <code><a class="el" href="classxercesc_1_1DOMNodeList.html" title="The DOMNodeList interface provides the abstraction of an ordered collection of nodes. ">DOMNodeList</a></code>, the document subtree governed by a particular <code><a class="el" href="classxercesc_1_1DOMNode.html" title="The DOMNode interface is the primary datatype for the entire Document Object Model. ">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><a class="el" href="classxercesc_1_1DOMNodeIterator.html" title="DOMNodeIterators are used to step through a set of nodes, e.g. ">DOMNodeIterator</a></code>. DOM Level 2 specifies a single <code><a class="el" href="classxercesc_1_1DOMNodeIterator.html" title="DOMNodeIterators are used to step through a set of nodes, e.g. ">DOMNodeIterator</a></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="classxercesc_1_1DOMDocumentTraversal.html" title="DOMDocumentTraversal contains methods that create DOMNodeIterators and DOMTreeWalkers to traverse a n...">DOMDocumentTraversal</a></code><code>.createNodeIterator()</code>. </p>
<p>See 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>. </p>
<dl class="section since"><dt>Since</dt><dd>DOM Level 2 </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ae709d8376b58beb2409d85bf608599af"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">xercesc::DOMNodeIterator::DOMNodeIterator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a9bf8c06a66a7379b24afd325a4d83250"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">xercesc::DOMNodeIterator::DOMNodeIterator </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classxercesc_1_1DOMNodeIterator.html">DOMNodeIterator</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a105fa0bd67d282c9f07c6e42c6e979e6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual xercesc::DOMNodeIterator::~DOMNodeIterator </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ab69531f583d05578b832dd39baaaa29d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void xercesc::DOMNodeIterator::detach </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Detaches the <code><a class="el" href="classxercesc_1_1DOMNodeIterator.html" title="DOMNodeIterators are used to step through a set of nodes, e.g. ">DOMNodeIterator</a></code> from the set which it iterated over, releasing any computational resources and placing the <code><a class="el" href="classxercesc_1_1DOMNodeIterator.html" title="DOMNodeIterators are used to step through a set of nodes, e.g. ">DOMNodeIterator</a></code> in the INVALID state. </p>
<p>After <code>detach</code> has been invoked, calls to <code>nextNode</code> or <code>previousNode</code> will raise the exception INVALID_STATE_ERR. </p>
<dl class="section since"><dt>Since</dt><dd>DOM Level 2 </dd></dl>
</div>
</div>
<a class="anchor" id="a77413f9c80acb65270794ec51a949102"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool xercesc::DOMNodeIterator::getExpandEntityReferences </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the expandEntityReferences flag. </p>
<p>The value of this flag determines whether the children of entity reference nodes are visible to the <code><a class="el" href="classxercesc_1_1DOMNodeIterator.html" title="DOMNodeIterators are used to step through a set of nodes, e.g. ">DOMNodeIterator</a></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/>
<br/>
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><a class="el" href="classxercesc_1_1DOMNodeIterator.html" title="DOMNodeIterators are used to step through a set of nodes, e.g. ">DOMNodeIterator</a></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.</p>
<dl class="section since"><dt>Since</dt><dd>DOM Level 2 </dd></dl>
</div>
</div>
<a class="anchor" id="a2199e825391cbe4f915d68055cbf0f63"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classxercesc_1_1DOMNodeFilter.html">DOMNodeFilter</a>* xercesc::DOMNodeIterator::getFilter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The <code><a class="el" href="classxercesc_1_1DOMNodeFilter.html" title="Filters are objects that know how to &quot;filter out&quot; nodes. ">DOMNodeFilter</a></code> used to screen nodes. </p>
<dl class="section since"><dt>Since</dt><dd>DOM Level 2 </dd></dl>
</div>
</div>
<a class="anchor" id="a2456566bcf0b85b45e0d363d8b31e077"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a>* xercesc::DOMNodeIterator::getRoot </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The <code>root</code> node of the <code><a class="el" href="classxercesc_1_1DOMNodeIterator.html" title="DOMNodeIterators are used to step through a set of nodes, e.g. ">DOMNodeIterator</a></code>, as specified when it was created. </p>
<dl class="section since"><dt>Since</dt><dd>DOM Level 2 </dd></dl>
</div>
</div>
<a class="anchor" id="afada4dca6194bce8dacdbfeb642700c7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classxercesc_1_1DOMNodeFilter.html#a321889e59b1aa23cd84e980cbb415c0c">DOMNodeFilter::ShowType</a> xercesc::DOMNodeIterator::getWhatToShow </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return which node types are presented via the iterator. </p>
<p>This attribute determines which node types are presented via the <code><a class="el" href="classxercesc_1_1DOMNodeIterator.html" title="DOMNodeIterators are used to step through a set of nodes, e.g. ">DOMNodeIterator</a></code>. The available set of constants is defined in the <code><a class="el" href="classxercesc_1_1DOMNodeFilter.html" title="Filters are objects that know how to &quot;filter out&quot; nodes. ">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. </p>
<dl class="section since"><dt>Since</dt><dd>DOM Level 2 </dd></dl>
</div>
</div>
<a class="anchor" id="a1390e52c18ba1c69938c4c0e79493b74"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a>* xercesc::DOMNodeIterator::nextNode </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the next node in the set and advances the position of the <code><a class="el" href="classxercesc_1_1DOMNodeIterator.html" title="DOMNodeIterators are used to step through a set of nodes, e.g. ">DOMNodeIterator</a></code> in the set. </p>
<p>After a <code><a class="el" href="classxercesc_1_1DOMNodeIterator.html" title="DOMNodeIterators are used to step through a set of nodes, e.g. ">DOMNodeIterator</a></code> is created, the first call to <code><a class="el" href="classxercesc_1_1DOMNodeIterator.html#a1390e52c18ba1c69938c4c0e79493b74" title="Returns the next node in the set and advances the position of the DOMNodeIterator in the set...">nextNode()</a></code> returns the first node in the set. </p>
<dl class="section return"><dt>Returns</dt><dd>The next <code><a class="el" href="classxercesc_1_1DOMNode.html" title="The DOMNode interface is the primary datatype for the entire Document Object Model. ">DOMNode</a></code> in the set being iterated over, or <code>null</code> if there are no more members in that set. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classxercesc_1_1DOMException.html">DOMException</a></td><td>INVALID_STATE_ERR: Raised if this method is called after the <code>detach</code> method was invoked. </td></tr>
</table>
</dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>DOM Level 2 </dd></dl>
</div>
</div>
<a class="anchor" id="aa1b89f85962844c9179ddb07de9dea2f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classxercesc_1_1DOMNode.html">DOMNode</a>* xercesc::DOMNodeIterator::previousNode </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the previous node in the set and moves the position of the <code><a class="el" href="classxercesc_1_1DOMNodeIterator.html" title="DOMNodeIterators are used to step through a set of nodes, e.g. ">DOMNodeIterator</a></code> backwards in the set. </p>
<dl class="section return"><dt>Returns</dt><dd>The previous <code><a class="el" href="classxercesc_1_1DOMNode.html" title="The DOMNode interface is the primary datatype for the entire Document Object Model. ">DOMNode</a></code> in the set being iterated over, or <code>null</code> if there are no more members in that set. </dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classxercesc_1_1DOMException.html">DOMException</a></td><td>INVALID_STATE_ERR: Raised if this method is called after the <code>detach</code> method was invoked. </td></tr>
</table>
</dd>
</dl>
<dl class="section since"><dt>Since</dt><dd>DOM Level 2 </dd></dl>
</div>
</div>
<a class="anchor" id="a1d40a76868bd11af332d674931dd3b95"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void xercesc::DOMNodeIterator::release </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called to indicate that this NodeIterator is no longer in use and that the implementation may relinquish any resources associated with it. </p>
<p>(<a class="el" href="classxercesc_1_1DOMNodeIterator.html#a1d40a76868bd11af332d674931dd3b95" title="Called to indicate that this NodeIterator is no longer in use and that the implementation may relinqu...">release()</a> will call <a class="el" href="classxercesc_1_1DOMNodeIterator.html#ab69531f583d05578b832dd39baaaa29d" title="Detaches the DOMNodeIterator from the set which it iterated over, releasing any computational resourc...">detach()</a> where appropriate)</p>
<p>Access to a released object will lead to unexpected result. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="DOMNodeIterator_8hpp_source.html">DOMNodeIterator.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink