|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/><meta http-equiv="X-UA-Compatible" content="IE=9"/><meta name="generator" content="Doxygen 1.8.9.1"/><title>Xerces-C++: DOMTreeWalker Class Reference</title><link href="tabs.css" rel="stylesheet" type="text/css"/><script type="text/javascript" src="jquery.js"></script><script type="text/javascript" src="dynsections.js"></script><link href="doxygen.css" rel="stylesheet" type="text/css" /></head><body><div id="top"><!-- do not remove this div, it is closed by doxygen! --><div id="titlearea"><table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Xerces-C++  <span id="projectnumber">3.1.2</span> </div> </td> </tr> </tbody></table></div><!-- end header part --><!-- Generated by Doxygen 1.8.9.1 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</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> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div></div><!-- top --><div class="header"> <div class="summary"><a href="classDOMTreeWalker-members.html">List of all members</a> </div> <div class="headertitle"><div class="title">DOMTreeWalker Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div></div><!--header--><div class="contents">
<p><code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></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). <a href="classDOMTreeWalker.html#details">More...</a></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:a20eec42e6041f533fee393f3a7a216e1"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMTreeWalker.html#a20eec42e6041f533fee393f3a7a216e1">~DOMTreeWalker</a> ()</td></tr><tr class="memdesc:a20eec42e6041f533fee393f3a7a216e1"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a20eec42e6041f533fee393f3a7a216e1">More...</a><br /></td></tr><tr class="separator:a20eec42e6041f533fee393f3a7a216e1"><td class="memSeparator" colspan="2"> </td></tr><tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 2</div></td></tr><tr class="memitem:a4f56d8b912b3a81cf6ed340868c45fab"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classDOMNode.html">DOMNode</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMTreeWalker.html#a4f56d8b912b3a81cf6ed340868c45fab">getRoot</a> ()=0</td></tr><tr class="memdesc:a4f56d8b912b3a81cf6ed340868c45fab"><td class="mdescLeft"> </td><td class="mdescRight">The <code>root</code> node of the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code>, as specified when it was created. <a href="#a4f56d8b912b3a81cf6ed340868c45fab">More...</a><br /></td></tr><tr class="separator:a4f56d8b912b3a81cf6ed340868c45fab"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:aee0da5c908108d8c336ca58bf183ecf1"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classDOMNodeFilter.html#ac1946b252d8fa2ef980280cd94790bf3">DOMNodeFilter::ShowType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMTreeWalker.html#aee0da5c908108d8c336ca58bf183ecf1">getWhatToShow</a> ()=0</td></tr><tr class="memdesc:aee0da5c908108d8c336ca58bf183ecf1"><td class="mdescLeft"> </td><td class="mdescRight">This attribute determines which node types are presented via the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code>. <a href="#aee0da5c908108d8c336ca58bf183ecf1">More...</a><br /></td></tr><tr class="separator:aee0da5c908108d8c336ca58bf183ecf1"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a07b3562342a65c37ac9d0465a81a45e0"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classDOMNodeFilter.html">DOMNodeFilter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMTreeWalker.html#a07b3562342a65c37ac9d0465a81a45e0">getFilter</a> ()=0</td></tr><tr class="memdesc:a07b3562342a65c37ac9d0465a81a45e0"><td class="mdescLeft"> </td><td class="mdescRight">Return The filter used to screen nodes. <a href="#a07b3562342a65c37ac9d0465a81a45e0">More...</a><br /></td></tr><tr class="separator:a07b3562342a65c37ac9d0465a81a45e0"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:aff66d5b94a168e71e5e4a519b82034f5"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMTreeWalker.html#aff66d5b94a168e71e5e4a519b82034f5">getExpandEntityReferences</a> ()=0</td></tr><tr class="memdesc:aff66d5b94a168e71e5e4a519b82034f5"><td class="mdescLeft"> </td><td class="mdescRight">The value of this flag determines whether the children of entity reference nodes are visible to the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code>. <a href="#aff66d5b94a168e71e5e4a519b82034f5">More...</a><br /></td></tr><tr class="separator:aff66d5b94a168e71e5e4a519b82034f5"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:acbb2df243b57253839796b8fcc66b462"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classDOMNode.html">DOMNode</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMTreeWalker.html#acbb2df243b57253839796b8fcc66b462">getCurrentNode</a> ()=0</td></tr><tr class="memdesc:acbb2df243b57253839796b8fcc66b462"><td class="mdescLeft"> </td><td class="mdescRight">Return the node at which the <a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a> is currently positioned. <a href="#acbb2df243b57253839796b8fcc66b462">More...</a><br /></td></tr><tr class="separator:acbb2df243b57253839796b8fcc66b462"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:ad822e6cf9ef0d6ecd4354fe185e46165"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classDOMNode.html">DOMNode</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMTreeWalker.html#ad822e6cf9ef0d6ecd4354fe185e46165">parentNode</a> ()=0</td></tr><tr class="memdesc:ad822e6cf9ef0d6ecd4354fe185e46165"><td class="mdescLeft"> </td><td class="mdescRight">Moves to and returns the closest visible ancestor node of the current node. <a href="#ad822e6cf9ef0d6ecd4354fe185e46165">More...</a><br /></td></tr><tr class="separator:ad822e6cf9ef0d6ecd4354fe185e46165"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:ab968e34ebd5ff5e593c884ec48cc18f6"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classDOMNode.html">DOMNode</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMTreeWalker.html#ab968e34ebd5ff5e593c884ec48cc18f6">firstChild</a> ()=0</td></tr><tr class="memdesc:ab968e34ebd5ff5e593c884ec48cc18f6"><td class="mdescLeft"> </td><td class="mdescRight">Moves the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code> to the first visible child of the current node, and returns the new node. <a href="#ab968e34ebd5ff5e593c884ec48cc18f6">More...</a><br /></td></tr><tr class="separator:ab968e34ebd5ff5e593c884ec48cc18f6"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a0de315340972a05da962f59c5e32fd4e"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classDOMNode.html">DOMNode</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMTreeWalker.html#a0de315340972a05da962f59c5e32fd4e">lastChild</a> ()=0</td></tr><tr class="memdesc:a0de315340972a05da962f59c5e32fd4e"><td class="mdescLeft"> </td><td class="mdescRight">Moves the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code> to the last visible child of the current node, and returns the new node. <a href="#a0de315340972a05da962f59c5e32fd4e">More...</a><br /></td></tr><tr class="separator:a0de315340972a05da962f59c5e32fd4e"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a2542bdbd110d053b33e453e594470f06"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classDOMNode.html">DOMNode</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMTreeWalker.html#a2542bdbd110d053b33e453e594470f06">previousSibling</a> ()=0</td></tr><tr class="memdesc:a2542bdbd110d053b33e453e594470f06"><td class="mdescLeft"> </td><td class="mdescRight">Moves the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code> to the previous sibling of the current node, and returns the new node. <a href="#a2542bdbd110d053b33e453e594470f06">More...</a><br /></td></tr><tr class="separator:a2542bdbd110d053b33e453e594470f06"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:aa8ae5811b367027912964a558b391d80"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classDOMNode.html">DOMNode</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMTreeWalker.html#aa8ae5811b367027912964a558b391d80">nextSibling</a> ()=0</td></tr><tr class="memdesc:aa8ae5811b367027912964a558b391d80"><td class="mdescLeft"> </td><td class="mdescRight">Moves the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code> to the next sibling of the current node, and returns the new node. <a href="#aa8ae5811b367027912964a558b391d80">More...</a><br /></td></tr><tr class="separator:aa8ae5811b367027912964a558b391d80"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a013c5eb3f5fb89b3d3186eff4af1d96a"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classDOMNode.html">DOMNode</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMTreeWalker.html#a013c5eb3f5fb89b3d3186eff4af1d96a">previousNode</a> ()=0</td></tr><tr class="memdesc:a013c5eb3f5fb89b3d3186eff4af1d96a"><td class="mdescLeft"> </td><td class="mdescRight">Moves the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code> to the previous visible node in document order relative to the current node, and returns the new node. <a href="#a013c5eb3f5fb89b3d3186eff4af1d96a">More...</a><br /></td></tr><tr class="separator:a013c5eb3f5fb89b3d3186eff4af1d96a"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a598bedd4cfdf9969c57f193585bd23fa"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classDOMNode.html">DOMNode</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMTreeWalker.html#a598bedd4cfdf9969c57f193585bd23fa">nextNode</a> ()=0</td></tr><tr class="memdesc:a598bedd4cfdf9969c57f193585bd23fa"><td class="mdescLeft"> </td><td class="mdescRight">Moves the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code> to the next visible node in document order relative to the current node, and returns the new node. <a href="#a598bedd4cfdf9969c57f193585bd23fa">More...</a><br /></td></tr><tr class="separator:a598bedd4cfdf9969c57f193585bd23fa"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a6bda5f24db2b462a054d1ede9186f153"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMTreeWalker.html#a6bda5f24db2b462a054d1ede9186f153">setCurrentNode</a> (<a class="el" href="classDOMNode.html">DOMNode</a> *currentNode)=0</td></tr><tr class="memdesc:a6bda5f24db2b462a054d1ede9186f153"><td class="mdescLeft"> </td><td class="mdescRight">The node at which the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code> is currently positioned. <a href="#a6bda5f24db2b462a054d1ede9186f153">More...</a><br /></td></tr><tr class="separator:a6bda5f24db2b462a054d1ede9186f153"><td class="memSeparator" colspan="2"> </td></tr><tr><td colspan="2"><div class="groupHeader">Non-standard Extension</div></td></tr><tr class="memitem:abdd08d5f5ff5f6ec352017069e3043f9"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMTreeWalker.html#abdd08d5f5ff5f6ec352017069e3043f9">release</a> ()=0</td></tr><tr class="memdesc:abdd08d5f5ff5f6ec352017069e3043f9"><td class="mdescLeft"> </td><td class="mdescRight">Called to indicate that this TreeWalker is no longer in use and that the implementation may relinquish any resources associated with it. <a href="#abdd08d5f5ff5f6ec352017069e3043f9">More...</a><br /></td></tr><tr class="separator:abdd08d5f5ff5f6ec352017069e3043f9"><td class="memSeparator" colspan="2"> </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:a5ffd572e2abf8d75e1f1541f28216fef"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMTreeWalker.html#a5ffd572e2abf8d75e1f1541f28216fef">DOMTreeWalker</a> ()</td></tr><tr class="separator:a5ffd572e2abf8d75e1f1541f28216fef"><td class="memSeparator" colspan="2"> </td></tr><tr class="memitem:a40b3476b1a8bcfb595f00f0ae173c62d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMTreeWalker.html#a40b3476b1a8bcfb595f00f0ae173c62d">DOMTreeWalker</a> (const <a class="el" href="classDOMTreeWalker.html">DOMTreeWalker</a> &)</td></tr><tr class="separator:a40b3476b1a8bcfb595f00f0ae173c62d"><td class="memSeparator" colspan="2"> </td></tr></table><a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2><div class="textblock"><p><code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></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). </p><p>Any function which performs navigation using a <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code> will automatically support any view defined by a <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code>. </p><p>Omitting 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><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></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" title="Filters are objects that know how to "filter out" nodes. ">DOMNodeFilter</a></code> that skips all nodes except for <a class="el" href="classDOMText.html" title="The DOMText interface inherits from DOMCharacterData and represents the textual content (termed chara...">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. </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 & Destructor Documentation</h2><a class="anchor" id="a5ffd572e2abf8d75e1f1541f28216fef"></a><div class="memitem"><div class="memproto"><table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">DOMTreeWalker::DOMTreeWalker </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"><span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr></table></div><div class="memdoc">
</div></div><a class="anchor" id="a40b3476b1a8bcfb595f00f0ae173c62d"></a><div class="memitem"><div class="memproto"><table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">DOMTreeWalker::DOMTreeWalker </td> <td>(</td> <td class="paramtype">const <a class="el" href="classDOMTreeWalker.html">DOMTreeWalker</a> & </td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"><span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr></table></div><div class="memdoc">
</div></div><a class="anchor" id="a20eec42e6041f533fee393f3a7a216e1"></a><div class="memitem"><div class="memproto"><table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual DOMTreeWalker::~DOMTreeWalker </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"><span class="mlabels"><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="ab968e34ebd5ff5e593c884ec48cc18f6"></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="classDOMNode.html">DOMNode</a>* DOMTreeWalker::firstChild </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>Moves the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code> to the first visible child of the current node, and returns the new node. </p><p>If the current node has no visible children, returns <code>null</code>, and retains the current node. </p><dl class="section return"><dt>Returns</dt><dd>The new node, or <code>null</code> if the current node has no visible children in the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code>'s logical view.</dd></dl><dl class="section since"><dt>Since</dt><dd>DOM Level 2 </dd></dl>
</div></div><a class="anchor" id="acbb2df243b57253839796b8fcc66b462"></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="classDOMNode.html">DOMNode</a>* DOMTreeWalker::getCurrentNode </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 node at which the <a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a> is currently positioned. </p><dl class="section since"><dt>Since</dt><dd>DOM Level 2 </dd></dl>
</div></div><a class="anchor" id="aff66d5b94a168e71e5e4a519b82034f5"></a><div class="memitem"><div class="memproto"><table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual bool DOMTreeWalker::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>The value of this flag determines whether the children of entity reference nodes are visible to the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code>. </p><p>If 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 /> 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="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</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="a07b3562342a65c37ac9d0465a81a45e0"></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="classDOMNodeFilter.html">DOMNodeFilter</a>* DOMTreeWalker::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>Return The filter used to screen nodes. </p><dl class="section since"><dt>Since</dt><dd>DOM Level 2 </dd></dl>
</div></div><a class="anchor" id="a4f56d8b912b3a81cf6ed340868c45fab"></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="classDOMNode.html">DOMNode</a>* DOMTreeWalker::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="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</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="aee0da5c908108d8c336ca58bf183ecf1"></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="classDOMNodeFilter.html#ac1946b252d8fa2ef980280cd94790bf3">DOMNodeFilter::ShowType</a> DOMTreeWalker::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>This attribute determines which node types are presented via the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code>. </p><p>The available set of constants is defined in the <code><a class="el" href="classDOMNodeFilter.html" title="Filters are objects that know how to "filter out" 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="a0de315340972a05da962f59c5e32fd4e"></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="classDOMNode.html">DOMNode</a>* DOMTreeWalker::lastChild </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>Moves the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code> to the last visible child of the current node, and returns the new node. </p><p>If the current node has no visible children, returns <code>null</code>, and retains the current node. </p><dl class="section return"><dt>Returns</dt><dd>The new node, or <code>null</code> if the current node has no children in the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code>'s logical view.</dd></dl><dl class="section since"><dt>Since</dt><dd>DOM Level 2 </dd></dl>
</div></div><a class="anchor" id="a598bedd4cfdf9969c57f193585bd23fa"></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="classDOMNode.html">DOMNode</a>* DOMTreeWalker::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>Moves the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code> to the next visible node in document order relative to the current node, and returns the new node. </p><p>If the current node has no next node, or if the search for nextNode attempts to step upward from the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code>'s <code>root</code> node, returns <code>null</code>, and retains the current node. </p><dl class="section return"><dt>Returns</dt><dd>The new node, or <code>null</code> if the current node has no next node in the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code>'s logical view.</dd></dl><dl class="section since"><dt>Since</dt><dd>DOM Level 2 </dd></dl>
</div></div><a class="anchor" id="aa8ae5811b367027912964a558b391d80"></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="classDOMNode.html">DOMNode</a>* DOMTreeWalker::nextSibling </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>Moves the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code> to the next sibling of the current node, and returns the new node. </p><p>If the current node has no visible next sibling, returns <code>null</code>, and retains the current node. </p><dl class="section return"><dt>Returns</dt><dd>The new node, or <code>null</code> if the current node has no next sibling. in the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code>'s logical view.</dd></dl><dl class="section since"><dt>Since</dt><dd>DOM Level 2 </dd></dl>
</div></div><a class="anchor" id="ad822e6cf9ef0d6ecd4354fe185e46165"></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="classDOMNode.html">DOMNode</a>* DOMTreeWalker::parentNode </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>Moves to and returns the closest visible ancestor node of the current node. </p><p>If the search for <code>parentNode</code> attempts to step upward from the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></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>. </p><dl class="section return"><dt>Returns</dt><dd>The new parent node, or <code>null</code> if the current node has no parent in the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code>'s logical view.</dd></dl><dl class="section since"><dt>Since</dt><dd>DOM Level 2 </dd></dl>
</div></div><a class="anchor" id="a013c5eb3f5fb89b3d3186eff4af1d96a"></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="classDOMNode.html">DOMNode</a>* DOMTreeWalker::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>Moves the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code> to the previous visible node in document order relative to the current node, and returns the new node. </p><p>If the current node has no previous node, or if the search for <code>previousNode</code> attempts to step upward from the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code>'s <code>root</code> node, returns <code>null</code>, and retains the current node. </p><dl class="section return"><dt>Returns</dt><dd>The new node, or <code>null</code> if the current node has no previous node in the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code>'s logical view.</dd></dl><dl class="section since"><dt>Since</dt><dd>DOM Level 2 </dd></dl>
</div></div><a class="anchor" id="a2542bdbd110d053b33e453e594470f06"></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="classDOMNode.html">DOMNode</a>* DOMTreeWalker::previousSibling </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>Moves the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code> to the previous sibling of the current node, and returns the new node. </p><p>If the current node has no visible previous sibling, returns <code>null</code>, and retains the current node. </p><dl class="section return"><dt>Returns</dt><dd>The new node, or <code>null</code> if the current node has no previous sibling. in the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code>'s logical view.</dd></dl><dl class="section since"><dt>Since</dt><dd>DOM Level 2 </dd></dl>
</div></div><a class="anchor" id="abdd08d5f5ff5f6ec352017069e3043f9"></a><div class="memitem"><div class="memproto"><table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void DOMTreeWalker::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 TreeWalker is no longer in use and that the implementation may relinquish any resources associated with it. </p><p>Access to a released object will lead to unexpected result. </p>
</div></div><a class="anchor" id="a6bda5f24db2b462a054d1ede9186f153"></a><div class="memitem"><div class="memproto"><table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual void DOMTreeWalker::setCurrentNode </td> <td>(</td> <td class="paramtype"><a class="el" href="classDOMNode.html">DOMNode</a> * </td> <td class="paramname"><em>currentNode</em></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 node at which the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></code> is currently positioned. </p><p><br />Alterations to the DOM tree may cause the current node to no longer be accepted by the <code><a class="el" href="classDOMTreeWalker.html" title="DOMTreeWalker objects are used to navigate a document tree or subtree using the view of the document ...">DOMTreeWalker</a></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. </p><dl class="exception"><dt>Exceptions</dt><dd> <table class="exception"> <tr><td class="paramname"><a class="el" href="classDOMException.html">DOMException</a></td><td>NOT_SUPPORTED_ERR: Raised if an attempt is made to set <code>currentNode</code> to <code>null</code>.</td></tr> </table> </dd></dl><dl class="section since"><dt>Since</dt><dd>DOM Level 2 </dd></dl>
</div></div><hr/>The documentation for this class was generated from the following file:<ul><li><a class="el" href="DOMTreeWalker_8hpp_source.html">DOMTreeWalker.hpp</a></li></ul></div><!-- contents --><!-- start footer part --><hr class="footer"/><address class="footer"><small>Generated on Wed Mar 18 2015 10:43:38 for Xerces-C++ by  <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1</small></address></body></html>
|
