Google Git
Sign in
apache / xalan-site / 74fb702d7feb31dc5929ce81016774187d62264d / . / xalan-c / apiDocs / classFormatterTreeWalker.html
blob: 399776d3949f3bdef5eef293231f2762f2d4703a [file] [log] [blame]
<!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"/>
<title>Xalan-C++ API : Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<!-- The head section is copied from Doxygen 1.7.1 generated default output -->
<body>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center"><a href="../index.html">The Xalan C++ XSLT Processor Version 1.11</a></h3>
<hr/>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;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 class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>FormatterTreeWalker Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="FormatterTreeWalker" --><!-- doxytag: inherits="TreeWalker" -->
<p><code>#include &lt;<a class="el" href="FormatterTreeWalker_8hpp_source.html">FormatterTreeWalker.hpp</a>&gt;</code></p>
<p>Inherits <a class="el" href="classTreeWalker.html">TreeWalker</a>.</p>
<div class="dynheader">
Collaboration diagram for FormatterTreeWalker:</div>
<div class="dyncontent">
<div class="center"><img src="classFormatterTreeWalker__coll__graph.png" border="0" usemap="#FormatterTreeWalker_coll__map" alt="Collaboration graph"/></div>
<map name="FormatterTreeWalker_coll__map" id="FormatterTreeWalker_coll__map">
<area shape="rect" id="node2" href="classTreeWalker.html" title="TreeWalker" alt="" coords="5,197,96,227"/><area shape="rect" id="node4" href="classFormatterListener.html" title="A SAX&#45;based formatter interface for the XSL processor." alt="" coords="120,197,256,227"/><area shape="rect" id="node6" href="classPrefixResolver.html" title="This class defines an interface for classes that resolve namespace prefixes to their URIs..." alt="" coords="63,101,172,131"/><area shape="rect" id="node8" href="classXalanDOMString.html" title="XalanDOMString" alt="" coords="196,101,324,131"/><area shape="rect" id="node10" href="classXalanVector.html" title="XalanVector\&lt; XalanDOMChar \&gt;" alt="" coords="147,5,373,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classFormatterTreeWalker-members.html">List of all members.</a></p>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classFormatterTreeWalker.html#aa714ab110e1916035e97753dce0d837c">FormatterTreeWalker</a> (<a class="el" href="classFormatterListener.html">FormatterListener</a> &amp;formatterListener, MemoryManager &amp;theManager=XalanMemMgrs::getDefaultXercesMemMgr())
<dl class="el"><dd class="mdescRight">Construct a <a class="el" href="classFormatterTreeWalker.html">FormatterTreeWalker</a> instance. <a href="#aa714ab110e1916035e97753dce0d837c"></a><br/></dl><li>virtual <a class="el" href="classFormatterTreeWalker.html#a7b8a2cb46e71103721f0c847cf9ad0a5">~FormatterTreeWalker</a> ()
</ul>
<h2><a name="pro-methods"></a>
Protected Member Functions</h2>
<ul>
<li>virtual bool <a class="el" href="classFormatterTreeWalker.html#afc74061c3fd85d1c49a52e3efa1a7c04">startNode</a> (const <a class="el" href="classXalanNode.html">XalanNode</a> *node)
<dl class="el"><dd class="mdescRight">Called when first walking a node. <a href="#afc74061c3fd85d1c49a52e3efa1a7c04"></a><br/></dl><li>virtual bool <a class="el" href="classFormatterTreeWalker.html#a1e3ce8e7428627975175fc5ef9c87e71">startNode</a> (<a class="el" href="classXalanNode.html">XalanNode</a> *node)
<dl class="el"><dd class="mdescRight">Called when first walking a node. <a href="#a1e3ce8e7428627975175fc5ef9c87e71"></a><br/></dl><li>virtual bool <a class="el" href="classFormatterTreeWalker.html#a2532a0b1473a86b83a7033022e344d98">endNode</a> (const <a class="el" href="classXalanNode.html">XalanNode</a> *node)
<dl class="el"><dd class="mdescRight">Called when leaving a node. <a href="#a2532a0b1473a86b83a7033022e344d98"></a><br/></dl><li>virtual bool <a class="el" href="classFormatterTreeWalker.html#a307db73321ba1d5ad0e730b4b172c1e5">endNode</a> (<a class="el" href="classXalanNode.html">XalanNode</a> *node)
<dl class="el"><dd class="mdescRight">Called when leaving a node. <a href="#a307db73321ba1d5ad0e730b4b172c1e5"></a><br/></dl></ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="FormatterTreeWalker_8hpp_source.html#l00040">40</a> of file <a class="el" href="FormatterTreeWalker_8hpp_source.html">FormatterTreeWalker.hpp</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aa714ab110e1916035e97753dce0d837c"></a><!-- doxytag: member="FormatterTreeWalker::FormatterTreeWalker" ref="aa714ab110e1916035e97753dce0d837c" args="(FormatterListener &amp;formatterListener, MemoryManager &amp;theManager=XalanMemMgrs::getDefaultXercesMemMgr())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FormatterTreeWalker::FormatterTreeWalker </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classFormatterListener.html">FormatterListener</a> &amp;&nbsp;</td>
<td class="paramname"> <em>formatterListener</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">MemoryManager &amp;&nbsp;</td>
<td class="paramname"> <em>theManager</em> = <code>XalanMemMgrs::getDefaultXercesMemMgr()</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a <a class="el" href="classFormatterTreeWalker.html">FormatterTreeWalker</a> instance. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>formatterListener</em>&nbsp;</td><td>implemention of the <a class="el" href="classFormatterListener.html" title="A SAX-based formatter interface for the XSL processor.">FormatterListener</a> operation (toXMLString, digest, ...) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7b8a2cb46e71103721f0c847cf9ad0a5"></a><!-- doxytag: member="FormatterTreeWalker::~FormatterTreeWalker" ref="a7b8a2cb46e71103721f0c847cf9ad0a5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual FormatterTreeWalker::~FormatterTreeWalker </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a2532a0b1473a86b83a7033022e344d98"></a><!-- doxytag: member="FormatterTreeWalker::endNode" ref="a2532a0b1473a86b83a7033022e344d98" args="(const XalanNode *node)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool FormatterTreeWalker::endNode </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXalanNode.html">XalanNode</a> *&nbsp;</td>
<td class="paramname"> <em>node</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when leaving a node. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>node</em>&nbsp;</td><td>The node</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>return false if the walk should continue, or true if it should not. </dd></dl>
<p>Implements <a class="el" href="classTreeWalker.html#a1c7ccec81444662d68ba4ce315fffdc4">TreeWalker</a>.</p>
</div>
</div>
<a class="anchor" id="a307db73321ba1d5ad0e730b4b172c1e5"></a><!-- doxytag: member="FormatterTreeWalker::endNode" ref="a307db73321ba1d5ad0e730b4b172c1e5" args="(XalanNode *node)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool FormatterTreeWalker::endNode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXalanNode.html">XalanNode</a> *&nbsp;</td>
<td class="paramname"> <em>node</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when leaving a node. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>node</em>&nbsp;</td><td>The node</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>return false if the walk should continue, or true if it should not. </dd></dl>
<p>Implements <a class="el" href="classTreeWalker.html#ab5c73e0bdffba1abae8b9572d203c6e4">TreeWalker</a>.</p>
</div>
</div>
<a class="anchor" id="afc74061c3fd85d1c49a52e3efa1a7c04"></a><!-- doxytag: member="FormatterTreeWalker::startNode" ref="afc74061c3fd85d1c49a52e3efa1a7c04" args="(const XalanNode *node)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool FormatterTreeWalker::startNode </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXalanNode.html">XalanNode</a> *&nbsp;</td>
<td class="paramname"> <em>node</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when first walking a node. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>node</em>&nbsp;</td><td>The node</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>return false if the walk should continue, or true if it should not. </dd></dl>
<p>Implements <a class="el" href="classTreeWalker.html#a0830d7c43de92c10554775dbcd59526b">TreeWalker</a>.</p>
</div>
</div>
<a class="anchor" id="a1e3ce8e7428627975175fc5ef9c87e71"></a><!-- doxytag: member="FormatterTreeWalker::startNode" ref="a1e3ce8e7428627975175fc5ef9c87e71" args="(XalanNode *node)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool FormatterTreeWalker::startNode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classXalanNode.html">XalanNode</a> *&nbsp;</td>
<td class="paramname"> <em>node</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when first walking a node. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>node</em>&nbsp;</td><td>The node</td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>return false if the walk should continue, or true if it should not. </dd></dl>
<p>Implements <a class="el" href="classTreeWalker.html#a8b397b497b075c49a1adb4ecf6670f50">TreeWalker</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="FormatterTreeWalker_8hpp_source.html">FormatterTreeWalker.hpp</a></li>
</ul>
</div>
<p align="center"><a href="graph_legend.html">Interpreting class diagrams</a></p>
<p><font color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><a href="http://www.doxygen.org/">Doxygen</a> and
<a href="http://www.graphviz.org/">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="80%">
<tr>
<td width="80%" valign="top">
<p align="center"><b>Xalan-C++ XSLT Processor Version 1.11</b><br/>
Copyright &copy; 1999-2012 The Apache Software Foundation.<br/>
All Rights Reserved.</p>
</td>
</tr>
<tr>
<td width="100%">
<p align="center"><img src="asf_logo_wide.gif" width="268" height="25" align="bottom" border="0" alt="Apache Logo">
</td>
</tr>
</table>
</body>
</html>