blob: 55614bf184c4417433d39c1edb2e2f5a46016217 [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="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<h1>FormatterToText Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="FormatterToText" --><!-- doxytag: inherits="FormatterListener" -->
<p>This class takes SAX events (in addition to some extra events that SAX doesn't handle yet) and produces simple text only.
<a href="#_details">More...</a></p>
<p><code>#include &lt;<a class="el" href="FormatterToText_8hpp_source.html">FormatterToText.hpp</a>&gt;</code></p>
<p>Inherits <a class="el" href="classFormatterListener.html">FormatterListener</a>.</p>
<p>Inherited by StylesheetExecutionContextDefault::FormatterToTextDOMString.</p>
<div class="dynheader">
Collaboration diagram for FormatterToText:</div>
<div class="dyncontent">
<div class="center"><img src="classFormatterToText__coll__graph.png" border="0" usemap="#FormatterToText_coll__map" alt="Collaboration graph"/></div>
<map name="FormatterToText_coll__map" id="FormatterToText_coll__map">
<area shape="rect" id="node2" href="classFormatterListener.html" title="A SAX&#45;based formatter interface for the XSL processor." alt="" coords="129,197,265,227"/><area shape="rect" id="node4" href="classPrefixResolver.html" title="This class defines an interface for classes that resolve namespace prefixes to their URIs..." alt="" coords="5,101,115,131"/><area shape="rect" id="node6" href="classXalanDOMString.html" title="XalanDOMString" alt="" coords="193,101,321,131"/><area shape="rect" id="node8" href="classXalanVector.html" title="XalanVector\&lt; XalanDOMChar \&gt;" alt="" coords="144,5,371,35"/><area shape="rect" id="node10" href="classWriter.html" title="Writer" alt="" coords="416,197,475,227"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classFormatterToText-members.html">List of all members.</a></p>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="el" href="classFormatterToText.html#af230efd7d32f3bb89821daca996197a2">FormatterToText</a> (MemoryManager &amp;theManager=XalanMemMgrs::getDefaultXercesMemMgr())
<dl class="el"><dd class="mdescRight"><a class="el" href="classFormatterToText.html" title="This class takes SAX events (in addition to some extra events that SAX doesn&#39;t handle yet) and pr...">FormatterToText</a> instance constructor. <a href="#af230efd7d32f3bb89821daca996197a2"></a><br/></dl><li><a class="el" href="classFormatterToText.html#ab87f6b155c45862de903cd6374343d15">FormatterToText</a> (<a class="el" href="classWriter.html">Writer</a> &amp;writer, bool normalizeLinefeed=true, bool handleIgnorableWhitespace=true, MemoryManager &amp;theManager=XalanMemMgrs::getDefaultXercesMemMgr())
<dl class="el"><dd class="mdescRight"><a class="el" href="classFormatterToText.html" title="This class takes SAX events (in addition to some extra events that SAX doesn&#39;t handle yet) and pr...">FormatterToText</a> instance constructor. <a href="#ab87f6b155c45862de903cd6374343d15"></a><br/></dl><li><a class="el" href="classFormatterToText.html#acdc958f2260f1803dc5efc55c98cccb8">FormatterToText</a> (<a class="el" href="classWriter.html">Writer</a> &amp;writer, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;encoding, bool normalizeLinefeed=true, bool handleIgnorableWhitespace=true, MemoryManager &amp;theManager=XalanMemMgrs::getDefaultXercesMemMgr())
<dl class="el"><dd class="mdescRight"><a class="el" href="classFormatterToText.html" title="This class takes SAX events (in addition to some extra events that SAX doesn&#39;t handle yet) and pr...">FormatterToText</a> instance constructor. <a href="#acdc958f2260f1803dc5efc55c98cccb8"></a><br/></dl><li>virtual <a class="el" href="classFormatterToText.html#ada0b6337a56603f131687ba2fd2e532c">~FormatterToText</a> ()
<li>MemoryManager &amp; <a class="el" href="classFormatterToText.html#a1eae80f55dd2a90119f1dbc5390c879d">getMemoryManager</a> ()
<li><a class="el" href="classWriter.html">Writer</a> * <a class="el" href="classFormatterToText.html#a213e9326b93fe26e849ecedf32e7dead">getWriter</a> () const
<li>void <a class="el" href="classFormatterToText.html#ad3a7563af225b95b69f9743bf2747de1">setWriter</a> (<a class="el" href="classWriter.html">Writer</a> *theWriter)
<li>void <a class="el" href="classFormatterToText.html#a77e1de5e01905c046f53d186e9f4729d">clearEncoding</a> ()
<li>const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <a class="el" href="classFormatterToText.html#a6f2257e6ea1c3c1e06439df441545349">getEncoding</a> () const
<li>void <a class="el" href="classFormatterToText.html#a24a3712cfd34da946fb98f409d9837b9">setEncoding</a> (const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;theEncoding)
<li>XalanDOMChar <a class="el" href="classFormatterToText.html#a0310eca0ea2f684034729b6452e09f90">getMaxCharacter</a> () const
<li>void <a class="el" href="classFormatterToText.html#a11f9c21dd0b47b8575e38324fb47a564">setMaxCharacter</a> (XalanDOMChar theMaxChar)
<li>bool <a class="el" href="classFormatterToText.html#aadae894c4f613c5d15300e75cf0e6f9c">getNormalizeLinefeed</a> () const
<li>void <a class="el" href="classFormatterToText.html#a0438b14a66b7203b29788b4361843afc">setNormalizeLinefeed</a> (bool fNormalize)
<li>bool <a class="el" href="classFormatterToText.html#abb136da84ba9d613752c70c4db9790ef">getHandleIgnorableWhitespace</a> () const
<li>void <a class="el" href="classFormatterToText.html#a431779ed49d88838a1b02bdeee72063a">setHandleIgnorableWhitespace</a> (bool fHandle)
<li>virtual void <a class="el" href="classFormatterToText.html#a205bf9883dec08be419c51330a3d617f">setDocumentLocator</a> (const Locator *const locator)
<li>virtual void <a class="el" href="classFormatterToText.html#aa3fdd9d2b65a6c1443db12da6cc51d82">startDocument</a> ()
<li>virtual void <a class="el" href="classFormatterToText.html#a6cca5c5bd997a4b67b3557fa4ed9a3c1">endDocument</a> ()
<li>virtual void <a class="el" href="classFormatterToText.html#a8cbbbfc071a697a75bdcfb5965cc772c">startElement</a> (const XMLCh *const name, <a class="el" href="XalanSourceTreeContentHandler_8hpp.html#ab5db67e0ad48b82d8a0476b99c377fdb">AttributeListType</a> &amp;attrs)
<li>virtual void <a class="el" href="classFormatterToText.html#acf398ec55769f8457d442440a5a2f569">endElement</a> (const XMLCh *const name)
<li>virtual void <a class="el" href="classFormatterToText.html#a07a8db57e00b02f0c9cb9f1b6bd4a57b">characters</a> (const XMLCh *const chars, const <a class="el" href="classFormatterListener.html#a4fa8f54ee8831c8be70336c00a8352b1">size_type</a> length)
<li>virtual void <a class="el" href="classFormatterToText.html#a06dc1fcc7c9b58527d6d9ff1ea72f0e3">charactersRaw</a> (const XMLCh *const chars, const <a class="el" href="classFormatterListener.html#a4fa8f54ee8831c8be70336c00a8352b1">size_type</a> length)
<dl class="el"><dd class="mdescRight">Receive notification of character data. <a href="#a06dc1fcc7c9b58527d6d9ff1ea72f0e3"></a><br/></dl><li>virtual void <a class="el" href="classFormatterToText.html#ad81e7310cf075c917b43ea60d3ae274d">entityReference</a> (const XMLCh *const name)
<dl class="el"><dd class="mdescRight">Receive notification of a entityReference. <a href="#ad81e7310cf075c917b43ea60d3ae274d"></a><br/></dl><li>virtual void <a class="el" href="classFormatterToText.html#a692e2c2ca355295cafd97a8ecf6c09d7">ignorableWhitespace</a> (const XMLCh *const chars, const <a class="el" href="classFormatterListener.html#a4fa8f54ee8831c8be70336c00a8352b1">size_type</a> length)
<li>virtual void <a class="el" href="classFormatterToText.html#a920b0e4984f829bb5756af0b884b4b9e">processingInstruction</a> (const XMLCh *const target, const XMLCh *const data)
<li>virtual void <a class="el" href="classFormatterToText.html#a84e275c2e321444412b7e7d66a21f13e">resetDocument</a> ()
<li>virtual void <a class="el" href="classFormatterToText.html#a7a99da29cb9704e569b2ac2993134ac0">comment</a> (const XMLCh *const data)
<dl class="el"><dd class="mdescRight">Called when a Comment is to be constructed. <a href="#a7a99da29cb9704e569b2ac2993134ac0"></a><br/></dl><li>virtual void <a class="el" href="classFormatterToText.html#add4dfd780abf664c9d2de18d3520f3c7">cdata</a> (const XMLCh *const ch, const <a class="el" href="classFormatterListener.html#a4fa8f54ee8831c8be70336c00a8352b1">size_type</a> length)
<dl class="el"><dd class="mdescRight">Receive notification of cdata. <a href="#add4dfd780abf664c9d2de18d3520f3c7"></a><br/></dl></ul>
<h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2>
<ul>
<li>static <a class="el" href="classFormatterToText.html">FormatterToText</a> * <a class="el" href="classFormatterToText.html#a32fed34846abe363fe2171e749796685">create</a> (MemoryManager &amp;theManager, <a class="el" href="classWriter.html">Writer</a> &amp;writer, const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;encoding, bool normalizeLinefeed=true, bool handleIgnorableWhitespace=true)
</ul>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This class takes SAX events (in addition to some extra events that SAX doesn't handle yet) and produces simple text only. </p>
<p>Definition at line <a class="el" href="FormatterToText_8hpp_source.html#l00049">49</a> of file <a class="el" href="FormatterToText_8hpp_source.html">FormatterToText.hpp</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="af230efd7d32f3bb89821daca996197a2"></a><!-- doxytag: member="FormatterToText::FormatterToText" ref="af230efd7d32f3bb89821daca996197a2" args="(MemoryManager &amp;theManager=XalanMemMgrs::getDefaultXercesMemMgr())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FormatterToText::FormatterToText </td>
<td>(</td>
<td class="paramtype">MemoryManager &amp;&nbsp;</td>
<td class="paramname"> <em>theManager</em> = <code>XalanMemMgrs::getDefaultXercesMemMgr()</code></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classFormatterToText.html" title="This class takes SAX events (in addition to some extra events that SAX doesn&#39;t handle yet) and pr...">FormatterToText</a> instance constructor. </p>
</div>
</div>
<a class="anchor" id="ab87f6b155c45862de903cd6374343d15"></a><!-- doxytag: member="FormatterToText::FormatterToText" ref="ab87f6b155c45862de903cd6374343d15" args="(Writer &amp;writer, bool normalizeLinefeed=true, bool handleIgnorableWhitespace=true, MemoryManager &amp;theManager=XalanMemMgrs::getDefaultXercesMemMgr())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FormatterToText::FormatterToText </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWriter.html">Writer</a> &amp;&nbsp;</td>
<td class="paramname"> <em>writer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>normalizeLinefeed</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>handleIgnorableWhitespace</em> = <code>true</code>, </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><a class="el" href="classFormatterToText.html" title="This class takes SAX events (in addition to some extra events that SAX doesn&#39;t handle yet) and pr...">FormatterToText</a> instance constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>writer</em>&nbsp;</td><td>writer for output </td></tr>
<tr><td valign="top"></td><td valign="top"><em>normalizeLindefeed</em>&nbsp;</td><td>Normalize <br/>
or <br/>
(on certain platforms). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>handleIgnorableWhitespace</em>&nbsp;</td><td>If true <a class="el" href="classFormatterToText.html#a692e2c2ca355295cafd97a8ecf6c09d7">ignorableWhitespace()</a> will write data to the <a class="el" href="classWriter.html">Writer</a> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="acdc958f2260f1803dc5efc55c98cccb8"></a><!-- doxytag: member="FormatterToText::FormatterToText" ref="acdc958f2260f1803dc5efc55c98cccb8" args="(Writer &amp;writer, const XalanDOMString &amp;encoding, bool normalizeLinefeed=true, bool handleIgnorableWhitespace=true, MemoryManager &amp;theManager=XalanMemMgrs::getDefaultXercesMemMgr())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FormatterToText::FormatterToText </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWriter.html">Writer</a> &amp;&nbsp;</td>
<td class="paramname"> <em>writer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>encoding</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>normalizeLinefeed</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>handleIgnorableWhitespace</em> = <code>true</code>, </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><a class="el" href="classFormatterToText.html" title="This class takes SAX events (in addition to some extra events that SAX doesn&#39;t handle yet) and pr...">FormatterToText</a> instance constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>writer</em>&nbsp;</td><td>writer for output </td></tr>
<tr><td valign="top"></td><td valign="top"><em>encoding</em>&nbsp;</td><td>character encoding for the writer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>normalizeLindefeed</em>&nbsp;</td><td>Normalize <br/>
or <br/>
on certain platforms. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>handleIgnorableWhitespace</em>&nbsp;</td><td>If true <a class="el" href="classFormatterToText.html#a692e2c2ca355295cafd97a8ecf6c09d7">ignorableWhitespace()</a> will write data to the <a class="el" href="classWriter.html">Writer</a> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ada0b6337a56603f131687ba2fd2e532c"></a><!-- doxytag: member="FormatterToText::~FormatterToText" ref="ada0b6337a56603f131687ba2fd2e532c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual FormatterToText::~FormatterToText </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="add4dfd780abf664c9d2de18d3520f3c7"></a><!-- doxytag: member="FormatterToText::cdata" ref="add4dfd780abf664c9d2de18d3520f3c7" args="(const XMLCh *const ch, const size_type length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void FormatterToText::cdata </td>
<td>(</td>
<td class="paramtype">const XMLCh *const &nbsp;</td>
<td class="paramname"> <em>ch</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classFormatterListener.html#a4fa8f54ee8831c8be70336c00a8352b1">size_type</a>&nbsp;</td>
<td class="paramname"> <em>length</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Receive notification of cdata. </p>
<p>The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity, so that the Locator provides useful information.</p>
<p>The application must not attempt to read from the array outside of the specified range.</p>
<p>Note that some parsers will report whitespace using the <a class="el" href="classFormatterToText.html#a692e2c2ca355295cafd97a8ecf6c09d7">ignorableWhitespace()</a> method rather than this one (validating parsers must do so).</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ch</em>&nbsp;</td><td>pointer to characters from the XML document </td></tr>
<tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>number of characters to read from the array </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>SAXException</em>&nbsp;</td><td></td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classFormatterListener.html#a3dd17e5cbf3adc902dedfc6eb1dd44c9">FormatterListener</a>.</p>
</div>
</div>
<a class="anchor" id="a07a8db57e00b02f0c9cb9f1b6bd4a57b"></a><!-- doxytag: member="FormatterToText::characters" ref="a07a8db57e00b02f0c9cb9f1b6bd4a57b" args="(const XMLCh *const chars, const size_type length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void FormatterToText::characters </td>
<td>(</td>
<td class="paramtype">const XMLCh *const &nbsp;</td>
<td class="paramname"> <em>chars</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classFormatterListener.html#a4fa8f54ee8831c8be70336c00a8352b1">size_type</a>&nbsp;</td>
<td class="paramname"> <em>length</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implements <a class="el" href="classFormatterListener.html#a3ce148868cd9153ca20a3ae4113a7044">FormatterListener</a>.</p>
</div>
</div>
<a class="anchor" id="a06dc1fcc7c9b58527d6d9ff1ea72f0e3"></a><!-- doxytag: member="FormatterToText::charactersRaw" ref="a06dc1fcc7c9b58527d6d9ff1ea72f0e3" args="(const XMLCh *const chars, const size_type length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void FormatterToText::charactersRaw </td>
<td>(</td>
<td class="paramtype">const XMLCh *const &nbsp;</td>
<td class="paramname"> <em>chars</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classFormatterListener.html#a4fa8f54ee8831c8be70336c00a8352b1">size_type</a>&nbsp;</td>
<td class="paramname"> <em>length</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Receive notification of character data. </p>
<p>If available, when the disable-output-escaping attribute is used, output raw text without escaping.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>chars</em>&nbsp;</td><td>pointer to characters from the XML document </td></tr>
<tr><td valign="top"></td><td valign="top"><em>length</em>&nbsp;</td><td>number of characters to read from the array </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>SAXException</em>&nbsp;</td><td></td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classFormatterListener.html#a18ab1aa51b868ead8dc2e4c55aa425a2">FormatterListener</a>.</p>
</div>
</div>
<a class="anchor" id="a77e1de5e01905c046f53d186e9f4729d"></a><!-- doxytag: member="FormatterToText::clearEncoding" ref="a77e1de5e01905c046f53d186e9f4729d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FormatterToText::clearEncoding </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a7a99da29cb9704e569b2ac2993134ac0"></a><!-- doxytag: member="FormatterToText::comment" ref="a7a99da29cb9704e569b2ac2993134ac0" args="(const XMLCh *const data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void FormatterToText::comment </td>
<td>(</td>
<td class="paramtype">const XMLCh *const &nbsp;</td>
<td class="paramname"> <em>data</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when a Comment is to be constructed. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>pointer to comment data </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>SAXException</em>&nbsp;</td><td></td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classFormatterListener.html#a64692100e4e57b2e45d910d4ea05d511">FormatterListener</a>.</p>
</div>
</div>
<a class="anchor" id="a32fed34846abe363fe2171e749796685"></a><!-- doxytag: member="FormatterToText::create" ref="a32fed34846abe363fe2171e749796685" args="(MemoryManager &amp;theManager, Writer &amp;writer, const XalanDOMString &amp;encoding, bool normalizeLinefeed=true, bool handleIgnorableWhitespace=true)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classFormatterToText.html">FormatterToText</a>* FormatterToText::create </td>
<td>(</td>
<td class="paramtype">MemoryManager &amp;&nbsp;</td>
<td class="paramname"> <em>theManager</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classWriter.html">Writer</a> &amp;&nbsp;</td>
<td class="paramname"> <em>writer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>encoding</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>normalizeLinefeed</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>handleIgnorableWhitespace</em> = <code>true</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a6cca5c5bd997a4b67b3557fa4ed9a3c1"></a><!-- doxytag: member="FormatterToText::endDocument" ref="a6cca5c5bd997a4b67b3557fa4ed9a3c1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void FormatterToText::endDocument </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implements <a class="el" href="classFormatterListener.html#a82e9e9315647350cca3b1a17c07c7c3d">FormatterListener</a>.</p>
</div>
</div>
<a class="anchor" id="acf398ec55769f8457d442440a5a2f569"></a><!-- doxytag: member="FormatterToText::endElement" ref="acf398ec55769f8457d442440a5a2f569" args="(const XMLCh *const name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void FormatterToText::endElement </td>
<td>(</td>
<td class="paramtype">const XMLCh *const &nbsp;</td>
<td class="paramname"> <em>name</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implements <a class="el" href="classFormatterListener.html#a0c551e1c370ed2344a2b4314cb4cbecf">FormatterListener</a>.</p>
</div>
</div>
<a class="anchor" id="ad81e7310cf075c917b43ea60d3ae274d"></a><!-- doxytag: member="FormatterToText::entityReference" ref="ad81e7310cf075c917b43ea60d3ae274d" args="(const XMLCh *const name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void FormatterToText::entityReference </td>
<td>(</td>
<td class="paramtype">const XMLCh *const &nbsp;</td>
<td class="paramname"> <em>name</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Receive notification of a entityReference. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>pointer to characters from the XML document </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>SAXException</em>&nbsp;</td><td></td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classFormatterListener.html#a5cc2496d5da4a9c26aafd3d1a8bc8c02">FormatterListener</a>.</p>
</div>
</div>
<a class="anchor" id="a6f2257e6ea1c3c1e06439df441545349"></a><!-- doxytag: member="FormatterToText::getEncoding" ref="a6f2257e6ea1c3c1e06439df441545349" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a>&amp; FormatterToText::getEncoding </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classFormatterListener.html#a8e76a3476bf02fac6282ed2a4a4a101e">FormatterListener</a>.</p>
<p>Definition at line <a class="el" href="FormatterToText_8hpp_source.html#l00121">121</a> of file <a class="el" href="FormatterToText_8hpp_source.html">FormatterToText.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="abb136da84ba9d613752c70c4db9790ef"></a><!-- doxytag: member="FormatterToText::getHandleIgnorableWhitespace" ref="abb136da84ba9d613752c70c4db9790ef" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool FormatterToText::getHandleIgnorableWhitespace </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FormatterToText_8hpp_source.html#l00159">159</a> of file <a class="el" href="FormatterToText_8hpp_source.html">FormatterToText.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0310eca0ea2f684034729b6452e09f90"></a><!-- doxytag: member="FormatterToText::getMaxCharacter" ref="a0310eca0ea2f684034729b6452e09f90" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">XalanDOMChar FormatterToText::getMaxCharacter </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FormatterToText_8hpp_source.html#l00135">135</a> of file <a class="el" href="FormatterToText_8hpp_source.html">FormatterToText.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1eae80f55dd2a90119f1dbc5390c879d"></a><!-- doxytag: member="FormatterToText::getMemoryManager" ref="a1eae80f55dd2a90119f1dbc5390c879d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MemoryManager&amp; FormatterToText::getMemoryManager </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FormatterToText_8hpp_source.html#l00098">98</a> of file <a class="el" href="FormatterToText_8hpp_source.html">FormatterToText.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="aadae894c4f613c5d15300e75cf0e6f9c"></a><!-- doxytag: member="FormatterToText::getNormalizeLinefeed" ref="aadae894c4f613c5d15300e75cf0e6f9c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool FormatterToText::getNormalizeLinefeed </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FormatterToText_8hpp_source.html#l00147">147</a> of file <a class="el" href="FormatterToText_8hpp_source.html">FormatterToText.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a213e9326b93fe26e849ecedf32e7dead"></a><!-- doxytag: member="FormatterToText::getWriter" ref="a213e9326b93fe26e849ecedf32e7dead" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWriter.html">Writer</a>* FormatterToText::getWriter </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classFormatterListener.html#a94ec3c89faa43cc3235889cd632eed9f">FormatterListener</a>.</p>
<p>Definition at line <a class="el" href="FormatterToText_8hpp_source.html#l00104">104</a> of file <a class="el" href="FormatterToText_8hpp_source.html">FormatterToText.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a692e2c2ca355295cafd97a8ecf6c09d7"></a><!-- doxytag: member="FormatterToText::ignorableWhitespace" ref="a692e2c2ca355295cafd97a8ecf6c09d7" args="(const XMLCh *const chars, const size_type length)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void FormatterToText::ignorableWhitespace </td>
<td>(</td>
<td class="paramtype">const XMLCh *const &nbsp;</td>
<td class="paramname"> <em>chars</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classFormatterListener.html#a4fa8f54ee8831c8be70336c00a8352b1">size_type</a>&nbsp;</td>
<td class="paramname"> <em>length</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implements <a class="el" href="classFormatterListener.html#a1ac985a009aabfe9c868857a177ca260">FormatterListener</a>.</p>
</div>
</div>
<a class="anchor" id="a920b0e4984f829bb5756af0b884b4b9e"></a><!-- doxytag: member="FormatterToText::processingInstruction" ref="a920b0e4984f829bb5756af0b884b4b9e" args="(const XMLCh *const target, const XMLCh *const data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void FormatterToText::processingInstruction </td>
<td>(</td>
<td class="paramtype">const XMLCh *const &nbsp;</td>
<td class="paramname"> <em>target</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const XMLCh *const &nbsp;</td>
<td class="paramname"> <em>data</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implements <a class="el" href="classFormatterListener.html#a42cddea41720bd6b6c3c117a6198ef81">FormatterListener</a>.</p>
</div>
</div>
<a class="anchor" id="a84e275c2e321444412b7e7d66a21f13e"></a><!-- doxytag: member="FormatterToText::resetDocument" ref="a84e275c2e321444412b7e7d66a21f13e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void FormatterToText::resetDocument </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implements <a class="el" href="classFormatterListener.html#a76ba87b5c046b23538a26d5b0621010b">FormatterListener</a>.</p>
</div>
</div>
<a class="anchor" id="a205bf9883dec08be419c51330a3d617f"></a><!-- doxytag: member="FormatterToText::setDocumentLocator" ref="a205bf9883dec08be419c51330a3d617f" args="(const Locator *const locator)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void FormatterToText::setDocumentLocator </td>
<td>(</td>
<td class="paramtype">const Locator *const &nbsp;</td>
<td class="paramname"> <em>locator</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implements <a class="el" href="classFormatterListener.html#a646fe8ea374bafd04522fe0bfdee7be1">FormatterListener</a>.</p>
</div>
</div>
<a class="anchor" id="a24a3712cfd34da946fb98f409d9837b9"></a><!-- doxytag: member="FormatterToText::setEncoding" ref="a24a3712cfd34da946fb98f409d9837b9" args="(const XalanDOMString &amp;theEncoding)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FormatterToText::setEncoding </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;&nbsp;</td>
<td class="paramname"> <em>theEncoding</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FormatterToText_8hpp_source.html#l00127">127</a> of file <a class="el" href="FormatterToText_8hpp_source.html">FormatterToText.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a431779ed49d88838a1b02bdeee72063a"></a><!-- doxytag: member="FormatterToText::setHandleIgnorableWhitespace" ref="a431779ed49d88838a1b02bdeee72063a" args="(bool fHandle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FormatterToText::setHandleIgnorableWhitespace </td>
<td>(</td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>fHandle</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FormatterToText_8hpp_source.html#l00165">165</a> of file <a class="el" href="FormatterToText_8hpp_source.html">FormatterToText.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a11f9c21dd0b47b8575e38324fb47a564"></a><!-- doxytag: member="FormatterToText::setMaxCharacter" ref="a11f9c21dd0b47b8575e38324fb47a564" args="(XalanDOMChar theMaxChar)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FormatterToText::setMaxCharacter </td>
<td>(</td>
<td class="paramtype">XalanDOMChar&nbsp;</td>
<td class="paramname"> <em>theMaxChar</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FormatterToText_8hpp_source.html#l00141">141</a> of file <a class="el" href="FormatterToText_8hpp_source.html">FormatterToText.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0438b14a66b7203b29788b4361843afc"></a><!-- doxytag: member="FormatterToText::setNormalizeLinefeed" ref="a0438b14a66b7203b29788b4361843afc" args="(bool fNormalize)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FormatterToText::setNormalizeLinefeed </td>
<td>(</td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>fNormalize</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FormatterToText_8hpp_source.html#l00153">153</a> of file <a class="el" href="FormatterToText_8hpp_source.html">FormatterToText.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad3a7563af225b95b69f9743bf2747de1"></a><!-- doxytag: member="FormatterToText::setWriter" ref="ad3a7563af225b95b69f9743bf2747de1" args="(Writer *theWriter)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void FormatterToText::setWriter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classWriter.html">Writer</a> *&nbsp;</td>
<td class="paramname"> <em>theWriter</em></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="FormatterToText_8hpp_source.html#l00110">110</a> of file <a class="el" href="FormatterToText_8hpp_source.html">FormatterToText.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa3fdd9d2b65a6c1443db12da6cc51d82"></a><!-- doxytag: member="FormatterToText::startDocument" ref="aa3fdd9d2b65a6c1443db12da6cc51d82" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void FormatterToText::startDocument </td>
<td>(</td>
<td class="paramname"></td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implements <a class="el" href="classFormatterListener.html#acf58b52bf6868f9ca0204faa7cad5d3e">FormatterListener</a>.</p>
</div>
</div>
<a class="anchor" id="a8cbbbfc071a697a75bdcfb5965cc772c"></a><!-- doxytag: member="FormatterToText::startElement" ref="a8cbbbfc071a697a75bdcfb5965cc772c" args="(const XMLCh *const name, AttributeListType &amp;attrs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void FormatterToText::startElement </td>
<td>(</td>
<td class="paramtype">const XMLCh *const &nbsp;</td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="XalanSourceTreeContentHandler_8hpp.html#ab5db67e0ad48b82d8a0476b99c377fdb">AttributeListType</a> &amp;&nbsp;</td>
<td class="paramname"> <em>attrs</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="FormatterToText_8hpp_source.html">FormatterToText.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>