| <HTML><HEAD><SCRIPT language="JavaScript" src="../resources/script.js" type="text/javascript"></SCRIPT><TITLE>Xerces-C++: DOMDocumentTraversal 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> | |
| <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> | |
| <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR> | |
| <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> | |
| <A href="../charter.html" onMouseOut="rolloverOff('side-charter');" onMouseOver="rolloverOn('side-charter');"><IMG alt="Charter" border="0" height="12" hspace="0" name="side-charter" onLoad="rolloverLoad('side-charter','../graphics/charter-label-2.jpg','../graphics/charter-label-3.jpg');" src="../graphics/charter-label-3.jpg" vspace="0" width="120"></A><BR> | |
| <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> | |
| <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR> | |
| <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> | |
| <A href="http://xerces.apache.org/xerces-c/download.cgi" onMouseOut="rolloverOff('side-ext-20');" onMouseOver="rolloverOn('side-ext-20');"><IMG alt="Download" border="0" height="12" hspace="0" name="side-ext-20" onLoad="rolloverLoad('side-ext-20','../graphics/ext-20-label-2.jpg','../graphics/ext-20-label-3.jpg');" src="../graphics/ext-20-label-3.jpg" vspace="0" width="120"></A><BR> | |
| <A href="../build.html" onMouseOut="rolloverOff('side-build');" onMouseOver="rolloverOn('side-build');"><IMG alt="Build Instructions" 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> | |
| <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR> | |
| <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> | |
| <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> | |
| <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> | |
| <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR> | |
| <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> | |
| <A href="../ApacheDOMC++Binding.html" onMouseOut="rolloverOff('side-ext-88');" onMouseOver="rolloverOn('side-ext-88');"><IMG alt="DOM C++ Binding" border="0" height="12" hspace="0" name="side-ext-88" onLoad="rolloverLoad('side-ext-88','../graphics/ext-88-label-2.jpg','../graphics/ext-88-label-3.jpg');" src="../graphics/ext-88-label-3.jpg" vspace="0" width="120"></A><BR> | |
| <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> | |
| <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR> | |
| <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> | |
| <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> | |
| <A href="../mailing-lists.html" onMouseOut="rolloverOff('side-mailing-lists');" onMouseOver="rolloverOn('side-mailing-lists');"><IMG alt="Mailing Lists" border="0" height="12" hspace="0" name="side-mailing-lists" onLoad="rolloverLoad('side-mailing-lists','../graphics/mailing-lists-label-2.jpg','../graphics/mailing-lists-label-3.jpg');" src="../graphics/mailing-lists-label-3.jpg" vspace="0" width="120"></A><BR> | |
| <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR> | |
| <A href="../source-repository.html" onMouseOut="rolloverOff('side-source-repository');" onMouseOver="rolloverOn('side-source-repository');"><IMG alt="Source Repository" border="0" height="12" hspace="0" name="side-source-repository" onLoad="rolloverLoad('side-source-repository','../graphics/source-repository-label-2.jpg','../graphics/source-repository-label-3.jpg');" src="../graphics/source-repository-label-3.jpg" vspace="0" width="120"></A><BR> | |
| <A href="../applications.html" onMouseOut="rolloverOff('side-applications');" onMouseOver="rolloverOn('side-applications');"><IMG alt="Applications" border="0" height="12" hspace="0" name="side-applications" onLoad="rolloverLoad('side-applications','../graphics/applications-label-2.jpg','../graphics/applications-label-3.jpg');" src="../graphics/applications-label-3.jpg" vspace="0" width="120"></A><BR> | |
| <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> | |
| <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"> </TD><TD width="484"><FONT color="#000000" face="arial,helvetica,sanserif"> | |
| <P> | |
| <!-- Generated by Doxygen 1.5.3 --> | |
| <div class="tabs"> | |
| <ul> | |
| <li><a href="index.html"><span>Main Page</span></a></li> | |
| <li class="current"><a href="classes.html"><span>Classes</span></a></li> | |
| <li><a href="files.html"><span>Files</span></a></li> | |
| <li><a href="pages.html"><span>Related Pages</span></a></li> | |
| </ul> | |
| </div> | |
| <div class="tabs"> | |
| <ul> | |
| <li><a href="classes.html"><span>Alphabetical List</span></a></li> | |
| <li><a href="annotated.html"><span>Class List</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> | |
| <h1>DOMDocumentTraversal Class Reference</h1><!-- doxytag: class="DOMDocumentTraversal" --><code><a class="el" href="classDOMDocumentTraversal.html" title="DOMDocumentTraversal contains methods that create DOMNodeIterators and DOMTreeWalkers...">DOMDocumentTraversal</a></code> contains methods that create <code>DOMNodeIterators</code> and <code>DOMTreeWalkers</code> to traverse a node and its children in document order (depth first, pre-order traversal, which is equivalent to the order in which the start tags occur in the text representation of the document). | |
| <a href="#_details">More...</a> | |
| <p> | |
| <div class="dynheader"> | |
| Inheritance diagram for DOMDocumentTraversal:</div> | |
| <div class="dynsection"> | |
| <p><center><img src="classDOMDocumentTraversal__inherit__graph.png" border="0" usemap="#DOMDocumentTraversal__inherit__map" alt="Inheritance graph"></center> | |
| <map name="DOMDocumentTraversal__inherit__map"> | |
| <area shape="rect" href="classDOMDocument.html" title="The DOMDocument interface represents the entire XML document." alt="" coords="33,84,156,111"></map> | |
| <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> | |
| <p> | |
| <a href="classDOMDocumentTraversal-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> | |
| <tr><td></td></tr> | |
| <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> | |
| <tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr> | |
| <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMDocumentTraversal.html#ded5e2bbc9f03adc30a268837b103ba6">~DOMDocumentTraversal</a> ()</td></tr> | |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ded5e2bbc9f03adc30a268837b103ba6"></a><br></td></tr> | |
| <tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 2</div></td></tr> | |
| <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classDOMNodeIterator.html">DOMNodeIterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMDocumentTraversal.html#0484db2559d56373b446b593a4b6413a">createNodeIterator</a> (<a class="el" href="classDOMNode.html">DOMNode</a> *root, unsigned long whatToShow, <a class="el" href="classDOMNodeFilter.html">DOMNodeFilter</a> *filter, bool entityReferenceExpansion)=0</td></tr> | |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a NodeIterator object. <a href="#0484db2559d56373b446b593a4b6413a"></a><br></td></tr> | |
| <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classDOMTreeWalker.html">DOMTreeWalker</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMDocumentTraversal.html#015d00facc0b45410689fea7bd9d6128">createTreeWalker</a> (<a class="el" href="classDOMNode.html">DOMNode</a> *root, unsigned long whatToShow, <a class="el" href="classDOMNodeFilter.html">DOMNodeFilter</a> *filter, bool entityReferenceExpansion)=0</td></tr> | |
| <tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a TreeWalker object. <a href="#015d00facc0b45410689fea7bd9d6128"></a><br></td></tr> | |
| <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> | |
| <tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr> | |
| <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDOMDocumentTraversal.html#1a351a955247ad7ec60e9424f500f6ce">DOMDocumentTraversal</a> ()</td></tr> | |
| </table> | |
| <hr><a name="_details"></a><h2>Detailed Description</h2> | |
| <code><a class="el" href="classDOMDocumentTraversal.html" title="DOMDocumentTraversal contains methods that create DOMNodeIterators and DOMTreeWalkers...">DOMDocumentTraversal</a></code> contains methods that create <code>DOMNodeIterators</code> and <code>DOMTreeWalkers</code> to traverse a node and its children in document order (depth first, pre-order traversal, which is equivalent to the order in which the start tags occur in the text representation of the document). | |
| <p> | |
| In DOMs which support the Traversal feature, <code><a class="el" href="classDOMDocumentTraversal.html" title="DOMDocumentTraversal contains methods that create DOMNodeIterators and DOMTreeWalkers...">DOMDocumentTraversal</a></code> will be implemented by the same objects that implement the <a class="el" href="classDOMDocument.html" title="The DOMDocument interface represents the entire XML document.">DOMDocument</a> interface. <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>. <dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 2 </dd></dl> | |
| <hr><h2>Constructor & Destructor Documentation</h2> | |
| <a class="anchor" name="1a351a955247ad7ec60e9424f500f6ce"></a><!-- doxytag: member="DOMDocumentTraversal::DOMDocumentTraversal" ref="1a351a955247ad7ec60e9424f500f6ce" args="()" --> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname">DOMDocumentTraversal::DOMDocumentTraversal </td> | |
| <td>(</td> | |
| <td class="paramname"> </td> | |
| <td> ) </td> | |
| <td width="100%"><code> [protected]</code></td> | |
| </tr> | |
| </table> | |
| </div> | |
| <div class="memdoc"> | |
| <p> | |
| </div> | |
| </div><p> | |
| <a class="anchor" name="ded5e2bbc9f03adc30a268837b103ba6"></a><!-- doxytag: member="DOMDocumentTraversal::~DOMDocumentTraversal" ref="ded5e2bbc9f03adc30a268837b103ba6" args="()" --> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname">virtual DOMDocumentTraversal::~DOMDocumentTraversal </td> | |
| <td>(</td> | |
| <td class="paramname"> </td> | |
| <td> ) </td> | |
| <td width="100%"><code> [virtual]</code></td> | |
| </tr> | |
| </table> | |
| </div> | |
| <div class="memdoc"> | |
| <p> | |
| Destructor. | |
| <p> | |
| </div> | |
| </div><p> | |
| <hr><h2>Member Function Documentation</h2> | |
| <a class="anchor" name="0484db2559d56373b446b593a4b6413a"></a><!-- doxytag: member="DOMDocumentTraversal::createNodeIterator" ref="0484db2559d56373b446b593a4b6413a" args="(DOMNode *root, unsigned long whatToShow, DOMNodeFilter *filter, bool entityReferenceExpansion)=0" --> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname">virtual <a class="el" href="classDOMNodeIterator.html">DOMNodeIterator</a>* DOMDocumentTraversal::createNodeIterator </td> | |
| <td>(</td> | |
| <td class="paramtype"><a class="el" href="classDOMNode.html">DOMNode</a> * </td> | |
| <td class="paramname"> <em>root</em>, </td> | |
| </tr> | |
| <tr> | |
| <td class="paramkey"></td> | |
| <td></td> | |
| <td class="paramtype">unsigned long </td> | |
| <td class="paramname"> <em>whatToShow</em>, </td> | |
| </tr> | |
| <tr> | |
| <td class="paramkey"></td> | |
| <td></td> | |
| <td class="paramtype"><a class="el" href="classDOMNodeFilter.html">DOMNodeFilter</a> * </td> | |
| <td class="paramname"> <em>filter</em>, </td> | |
| </tr> | |
| <tr> | |
| <td class="paramkey"></td> | |
| <td></td> | |
| <td class="paramtype">bool </td> | |
| <td class="paramname"> <em>entityReferenceExpansion</em></td><td> </td> | |
| </tr> | |
| <tr> | |
| <td></td> | |
| <td>)</td> | |
| <td></td><td></td><td width="100%"><code> [pure virtual]</code></td> | |
| </tr> | |
| </table> | |
| </div> | |
| <div class="memdoc"> | |
| <p> | |
| Creates a NodeIterator object. | |
| <p> | |
| (DOM2)<p> | |
| NodeIterators are used to step through a set of nodes, e.g. the set of nodes in a NodeList, the document subtree governed by a particular node, 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 NodeIterator. DOM Level 2 specifies a single NodeIterator implementation for document-order traversal of a document subtree. Instances of these iterators are created by calling <code><a class="el" href="classDOMDocumentTraversal.html#0484db2559d56373b446b593a4b6413a" title="Creates a NodeIterator object.">DOMDocumentTraversal.createNodeIterator()</a></code>.<p> | |
| 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 expandEntityReferences to true when creating the iterator. 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 expandEntityReferences to false.<p> | |
| <dl compact><dt><b>Parameters:</b></dt><dd> | |
| <table border="0" cellspacing="2" cellpadding="0"> | |
| <tr><td valign="top"></td><td valign="top"><em>root</em> </td><td>The root node of the DOM tree </td></tr> | |
| <tr><td valign="top"></td><td valign="top"><em>whatToShow</em> </td><td>This attribute determines which node types are presented via the iterator. </td></tr> | |
| <tr><td valign="top"></td><td valign="top"><em>filter</em> </td><td>The filter used to screen nodes </td></tr> | |
| <tr><td valign="top"></td><td valign="top"><em>entityReferenceExpansion</em> </td><td>The value of this flag determines whether the children of entity reference nodes are visible to the iterator. If false, they will be skipped over. </td></tr> | |
| </table> | |
| </dl> | |
| <dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 2 </dd></dl> | |
| </div> | |
| </div><p> | |
| <a class="anchor" name="015d00facc0b45410689fea7bd9d6128"></a><!-- doxytag: member="DOMDocumentTraversal::createTreeWalker" ref="015d00facc0b45410689fea7bd9d6128" args="(DOMNode *root, unsigned long whatToShow, DOMNodeFilter *filter, bool entityReferenceExpansion)=0" --> | |
| <div class="memitem"> | |
| <div class="memproto"> | |
| <table class="memname"> | |
| <tr> | |
| <td class="memname">virtual <a class="el" href="classDOMTreeWalker.html">DOMTreeWalker</a>* DOMDocumentTraversal::createTreeWalker </td> | |
| <td>(</td> | |
| <td class="paramtype"><a class="el" href="classDOMNode.html">DOMNode</a> * </td> | |
| <td class="paramname"> <em>root</em>, </td> | |
| </tr> | |
| <tr> | |
| <td class="paramkey"></td> | |
| <td></td> | |
| <td class="paramtype">unsigned long </td> | |
| <td class="paramname"> <em>whatToShow</em>, </td> | |
| </tr> | |
| <tr> | |
| <td class="paramkey"></td> | |
| <td></td> | |
| <td class="paramtype"><a class="el" href="classDOMNodeFilter.html">DOMNodeFilter</a> * </td> | |
| <td class="paramname"> <em>filter</em>, </td> | |
| </tr> | |
| <tr> | |
| <td class="paramkey"></td> | |
| <td></td> | |
| <td class="paramtype">bool </td> | |
| <td class="paramname"> <em>entityReferenceExpansion</em></td><td> </td> | |
| </tr> | |
| <tr> | |
| <td></td> | |
| <td>)</td> | |
| <td></td><td></td><td width="100%"><code> [pure virtual]</code></td> | |
| </tr> | |
| </table> | |
| </div> | |
| <div class="memdoc"> | |
| <p> | |
| Creates a TreeWalker object. | |
| <p> | |
| (DOM2)<p> | |
| TreeWalker objects are used to navigate a document tree or subtree using the view of the document defined by its whatToShow flags and any filters that are defined for the TreeWalker. Any function which performs navigation using a TreeWalker will automatically support any view defined by a TreeWalker.<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 TreeWalker view may be children of different, widely separated nodes in the original view. For instance, consider a Filter that skips all nodes except for <a class="el" href="classDOMText.html" title="The DOMText interface inherits from DOMCharacterData and represents the textual content...">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> | |
| To produce a view of the document that has entity references expanded and does not expose the entity reference node itself, use the whatToShow flags to hide the entity reference node and set <code>expandEntityReferences</code> to true when creating the TreeWalker. 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 compact><dt><b>Parameters:</b></dt><dd> | |
| <table border="0" cellspacing="2" cellpadding="0"> | |
| <tr><td valign="top"></td><td valign="top"><em>root</em> </td><td>The root node of the DOM tree </td></tr> | |
| <tr><td valign="top"></td><td valign="top"><em>whatToShow</em> </td><td>This attribute determines which node types are presented via the tree-walker. </td></tr> | |
| <tr><td valign="top"></td><td valign="top"><em>filter</em> </td><td>The filter used to screen nodes </td></tr> | |
| <tr><td valign="top"></td><td valign="top"><em>entityReferenceExpansion</em> </td><td>The value of this flag determines whether the children of entity reference nodes are visible to the tree-walker. If false, they will be skipped over. </td></tr> | |
| </table> | |
| </dl> | |
| <dl class="since" compact><dt><b>Since:</b></dt><dd>DOM Level 2 </dd></dl> | |
| </div> | |
| </div><p> | |
| <hr>The documentation for this class was generated from the following file:<ul> | |
| <li><a class="el" href="DOMDocumentTraversal_8hpp-source.html">DOMDocumentTraversal.hpp</a></ul> | |
| </FONT></TD></TR></TABLE><BR> | |
| </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> | |
| Copyright © 1994-2004 The Apache Software Foundation. | |
| All Rights Reserved. | |
| </I></FONT></TD></TR></TABLE></BODY></HTML> |