Google Git
Sign in
apache / xalan-site / 1b0c6dd5447f3bc951dcdd0e155aae8fc8efd4de / . / old / xalan-c / apiDocs / classXercesDOMWalker.html
blob: 4af19ba15ff5e2e721695168991e2c272ec4801c [file] [log] [blame]
<HTML><HEAD><TITLE>Xalan-C++ API Documentation</TITLE></HEAD>
<BODY>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center">The Xalan C++ XSLT Processor Version 1.10</h3>
</BODY>
<!-- Generated by Doxygen 1.2.8.1 -->
<center>
<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>
<hr><h1>XercesDOMWalker Class Reference</h1><code>#include &lt;<a class="el" href="XercesDOMWalker_8hpp-source.html">XercesDOMWalker.hpp</a>&gt;</code>
<p>
Inheritance diagram for XercesDOMWalker:<p><center><img src="classXercesDOMWalker__inherit__graph.gif" border="0" usemap="#XercesDOMWalker_inherit_map" alt="Inheritance graph"></center>
<map name="XercesDOMWalker_inherit_map">
<area href="classXercesDocumentWrapper_1_1BuildWrapperTreeWalker.html" shape="rect" coords="6,117,331,93">
<area href="classXercesDOMFormatterWalker.html" shape="rect" coords="355,117,545,93">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXercesDOMWalker-members.html">List of all members.</a><h2>Public Methods</h2>
<ul>
<li><a class="el" href="classXercesDOMWalker.html#a0">XercesDOMWalker</a> ()
<dl class="el"><dd><font size=-1><em>Constructor.</em> <a href="#a0">More...</a><em><br><br></em></font></dl><li>virtual <a class="el" href="classXercesDOMWalker.html#a1">~XercesDOMWalker</a> ()
<li>const <a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a>* <a class="el" href="classXercesDOMWalker.html#a2">traverse</a> (const <a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> *pos)
<dl class="el"><dd><font size=-1><em>Perform a document-order traversal.</em> <a href="#a2">More...</a><em><br><br></em></font></dl><li><a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a>* <a class="el" href="classXercesDOMWalker.html#a3">traverse</a> (<a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> *pos)
<dl class="el"><dd><font size=-1><em>Perform a document-order traversal.</em> <a href="#a3">More...</a><em><br><br></em></font></dl><li>const <a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a>* <a class="el" href="classXercesDOMWalker.html#a4">traverse</a> (const <a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> *pos, const <a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> *parent)
<dl class="el"><dd><font size=-1><em>Perform a document-order traversal stopping at the provided parent node.</em> <a href="#a4">More...</a><em><br><br></em></font></dl><li><a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a>* <a class="el" href="classXercesDOMWalker.html#a5">traverse</a> (<a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> *pos, <a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> *parent)
<dl class="el"><dd><font size=-1><em>Perform a document-order traversal stopping at the provided parent node.</em> <a href="#a5">More...</a><em><br><br></em></font></dl><li>void <a class="el" href="classXercesDOMWalker.html#a6">traverseSubtree</a> (const <a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> *pos)
<dl class="el"><dd><font size=-1><em>Perform a pre-order traversal.</em> <a href="#a6">More...</a><em><br><br></em></font></dl><li>void <a class="el" href="classXercesDOMWalker.html#a7">traverseSubtree</a> (<a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> *pos)
<dl class="el"><dd><font size=-1><em>Perform a document-order traversal.</em> <a href="#a7">More...</a><em><br><br></em></font></dl></ul>
<h2>Protected Methods</h2>
<ul>
<li>virtual bool <a class="el" href="classXercesDOMWalker.html#b0">startNode</a> (const <a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> *node)=0
<dl class="el"><dd><font size=-1><em>Called when first walking a node.</em> <a href="#b0">More...</a><em><br><br></em></font></dl><li>virtual bool <a class="el" href="classXercesDOMWalker.html#b1">startNode</a> (<a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> *node)
<dl class="el"><dd><font size=-1><em>Called when first walking a node.</em> <a href="#b1">More...</a><em><br><br></em></font></dl><li>virtual bool <a class="el" href="classXercesDOMWalker.html#b2">endNode</a> (const <a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> *node)=0
<dl class="el"><dd><font size=-1><em>Called when leaving a node.</em> <a href="#b2">More...</a><em><br><br></em></font></dl><li>virtual bool <a class="el" href="classXercesDOMWalker.html#b3">endNode</a> (<a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> *node)
<dl class="el"><dd><font size=-1><em>Called when leaving a node.</em> <a href="#b3">More...</a><em><br><br></em></font></dl></ul>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="XercesDOMWalker::XercesDOMWalker"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
XercesDOMWalker::XercesDOMWalker (
</b></td>
<td valign="bottom"><b>
)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Constructor.
<p>
</td>
</tr>
</table>
<a name="a1" doxytag="XercesDOMWalker::~XercesDOMWalker"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
XercesDOMWalker::~XercesDOMWalker (
</b></td>
<td valign="bottom"><b>
)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="b3" doxytag="XercesDOMWalker::endNode"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
bool XercesDOMWalker::endNode (
</b></td>
<td valign="bottom"><b>
<a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> * <em>node</em>&nbsp;)<code> [protected, virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Called when leaving a node.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>node</em>
&nbsp;</td><td>
The node
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
return false if traversal should continue, or true if it should not. </dl> </td>
</tr>
</table>
<a name="b2" doxytag="XercesDOMWalker::endNode"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
bool XercesDOMWalker::endNode (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> * <em>node</em>&nbsp;)<code> [protected, pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Called when leaving a node.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>node</em>
&nbsp;</td><td>
The node
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
return false if traversal should continue, or true if it should not. </dl>
<p>
Reimplemented in <a class="el" href="classXercesDocumentWrapper_1_1BuildWrapperTreeWalker.html#b1">XercesDocumentWrapper::BuildWrapperTreeWalker</a>, and <a class="el" href="classXercesDOMFormatterWalker.html#b1">XercesDOMFormatterWalker</a>. </td>
</tr>
</table>
<a name="b1" doxytag="XercesDOMWalker::startNode"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
bool XercesDOMWalker::startNode (
</b></td>
<td valign="bottom"><b>
<a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> * <em>node</em>&nbsp;)<code> [protected, virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Called when first walking a node.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>node</em>
&nbsp;</td><td>
The node
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
return false if traversal should continue, or true if it should not. </dl> </td>
</tr>
</table>
<a name="b0" doxytag="XercesDOMWalker::startNode"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
bool XercesDOMWalker::startNode (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> * <em>node</em>&nbsp;)<code> [protected, pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Called when first walking a node.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>node</em>
&nbsp;</td><td>
The node
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
return false if traversal should continue, or true if it should not. </dl>
<p>
Reimplemented in <a class="el" href="classXercesDocumentWrapper_1_1BuildWrapperTreeWalker.html#b0">XercesDocumentWrapper::BuildWrapperTreeWalker</a>, and <a class="el" href="classXercesDOMFormatterWalker.html#b0">XercesDOMFormatterWalker</a>. </td>
</tr>
</table>
<a name="a5" doxytag="XercesDOMWalker::traverse"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> * XercesDOMWalker::traverse (
</b></td>
<td valign="bottom"><b>
<a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> * <em>pos</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> * <em>parent</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Perform a document-order traversal stopping at the provided parent node.
<p>
Derived classes and stop the traversal by returning true from <a class="el" href="classXercesDOMWalker.html#b0">startNode</a>() or <a class="el" href="classXercesDOMWalker.html#b2">endNode</a>(). If that happens, the function will return the next node in document order. If desired, the caller can start traversing the tree again from that point. Note that terminal nodes will always have <a class="el" href="classXercesDOMWalker.html#b0">startNode</a>() and <a class="el" href="classXercesDOMWalker.html#b2">endNode</a>() called before the traversal terminates.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>pos</em>
&nbsp;</td><td>
The node in the tree with which to start the walk </td></tr>
<tr><td valign=top><em>parent</em>
&nbsp;</td><td>
The parent of pos. Note that for multiple calls that continue the traversal, this node must remain the same.
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
parent if the traversal completes, or the next node if the traversal doesn't complete. </dl> </td>
</tr>
</table>
<a name="a4" doxytag="XercesDOMWalker::traverse"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> * XercesDOMWalker::traverse (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> * <em>pos</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
const <a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> * <em>parent</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Perform a document-order traversal stopping at the provided parent node.
<p>
Derived classes and stop the traversal by returning true from <a class="el" href="classXercesDOMWalker.html#b0">startNode</a>() or <a class="el" href="classXercesDOMWalker.html#b2">endNode</a>(). If that happens, the function will return the next node in document order. If desired, the caller can start traversing the tree again from that point. Note that terminal nodes will always have <a class="el" href="classXercesDOMWalker.html#b0">startNode</a>() and <a class="el" href="classXercesDOMWalker.html#b2">endNode</a>() called before the traversal terminates.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>pos</em>
&nbsp;</td><td>
The node in the tree with which to start the walk </td></tr>
<tr><td valign=top><em>parent</em>
&nbsp;</td><td>
The parent of pos. Note that for multiple calls that continue the traversal, this node must remain the same.
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
parent if the traversal completes, or the next node if the traversal doesn't complete. </dl> </td>
</tr>
</table>
<a name="a3" doxytag="XercesDOMWalker::traverse"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> * XercesDOMWalker::traverse (
</b></td>
<td valign="bottom"><b>
<a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> * <em>pos</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Perform a document-order traversal.
<p>
Derived classes and stop the traversal by returning true from <a class="el" href="classXercesDOMWalker.html#b0">startNode</a>() or <a class="el" href="classXercesDOMWalker.html#b2">endNode</a>(). If that happens, the function will return the next node in document order. If desired, the caller can start traversing the tree again from that point. Note that terminal nodes will always have <a class="el" href="classXercesDOMWalker.html#b0">startNode</a>() and <a class="el" href="classXercesDOMWalker.html#b2">endNode</a>() called before the traversal terminates.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>pos</em>
&nbsp;</td><td>
The node in the tree with which to start the walk
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
0 if the traversal completes, or the next node if the traversal doesn't complete. </dl> </td>
</tr>
</table>
<a name="a2" doxytag="XercesDOMWalker::traverse"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> * XercesDOMWalker::traverse (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> * <em>pos</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Perform a document-order traversal.
<p>
Derived classes and stop the traversal by returning true from <a class="el" href="classXercesDOMWalker.html#b0">startNode</a>() or <a class="el" href="classXercesDOMWalker.html#b2">endNode</a>(). If that happens, the function will return the next node in document order. If desired, the caller can start traversing the tree again from that point. Note that terminal nodes will always have <a class="el" href="classXercesDOMWalker.html#b0">startNode</a>() and <a class="el" href="classXercesDOMWalker.html#b2">endNode</a>() called before the traversal terminates.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>pos</em>
&nbsp;</td><td>
The node in the tree with which to start the walk
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
0 if the traversal completes, or the next node if the traversal doesn't complete. </dl> </td>
</tr>
</table>
<a name="a7" doxytag="XercesDOMWalker::traverseSubtree"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XercesDOMWalker::traverseSubtree (
</b></td>
<td valign="bottom"><b>
<a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> * <em>pos</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Perform a document-order traversal.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>pos</em>
&nbsp;</td><td>
starting node </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a6" doxytag="XercesDOMWalker::traverseSubtree"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XercesDOMWalker::traverseSubtree (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="XercesWrapperTypes_8hpp.html#a11">DOMNodeType</a> * <em>pos</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Perform a pre-order traversal.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>pos</em>
&nbsp;</td><td>
starting node </td></tr>
</table>
</dl> </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XercesDOMWalker_8hpp-source.html">XercesDOMWalker.hpp</a></ul>
<p align="center"><a href="diagramnotes.html">Interpreting class diagrams</a></p>
<p><FONT color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><A href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</A> and
<A href="http://www.research.att.com/sw/tools/graphviz/">GraphViz</A> are used to generate this API documentation from the Xalan-C header files.</I></FONT></p>
<TABLE border="0" cellpadding="0" cellspacing="0" width="820"><TR><TD bgcolor="#0086b2"><IMG height="1" src="../resources/dot.gif" width="1" alt="dot"></TD></TR></TABLE>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" WIDTH="80%">
<TR>
<TD WIDTH="80%" VALIGN="TOP">
<P ALIGN="CENTER"><B>Xalan-C++ XSLT Processor Version 1.10</B><BR>
Copyright &copy; 1999-2004 The Apache Software Foundation. All Rights Reserved.</i></p>
</TD>
</TR>
<TR>
<TD WIDTH="100%">
<P ALIGN="CENTER"><IMG SRC="ApacheLogo.jpg" WIDTH="387" HEIGHT="100" ALIGN="BOTTOM" BORDER="0" ALT="Apache Logo">
</TD>
</TR>
</TABLE>