<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>FormatterToText.hpp</h1><a href="FormatterToText_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <font class="comment">/*</font>
00002 <font class="comment"> * Copyright 1999-2004 The Apache Software Foundation.</font>
00003 <font class="comment"> *</font>
00004 <font class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</font>
00005 <font class="comment"> * you may not use this file except in compliance with the License.</font>
00006 <font class="comment"> * You may obtain a copy of the License at</font>
00007 <font class="comment"> *</font>
00008 <font class="comment"> *     http://www.apache.org/licenses/LICENSE-2.0</font>
00009 <font class="comment"> *</font>
00010 <font class="comment"> * Unless required by applicable law or agreed to in writing, software</font>
00011 <font class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</font>
00012 <font class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</font>
00013 <font class="comment"> * See the License for the specific language governing permissions and</font>
00014 <font class="comment"> * limitations under the License.</font>
00015 <font class="comment"> */</font>
00016 <font class="preprocessor">#if !defined(FORMATTERTOTEXT_HEADER_GUARD_1357924680)</font>
<a name="l00017"></a><a class="code" href="FormatterToText_8hpp.html#a0">00017</a> <font class="preprocessor"></font><font class="preprocessor">#define FORMATTERTOTEXT_HEADER_GUARD_1357924680</font>
00018 <font class="preprocessor"></font>
00019 
00020 
00021 <font class="comment">// Base include file.  Must be first.</font>
00022 <font class="preprocessor">#include &lt;<a class="code" href="XMLSupportDefinitions_8hpp.html">xalanc/XMLSupport/XMLSupportDefinitions.hpp</a>&gt;</font>
00023 
00024 
00025 
00026 <font class="preprocessor">#include &lt;<a class="code" href="XalanDOMString_8hpp.html">xalanc/XalanDOM/XalanDOMString.hpp</a>&gt;</font>
00027 
00028 
00029 
00030 <font class="comment">// Base class header file.</font>
00031 <font class="preprocessor">#include &lt;<a class="code" href="FormatterListener_8hpp.html">xalanc/PlatformSupport/FormatterListener.hpp</a>&gt;</font>
00032 
00033 
00034 
00035 XALAN_CPP_NAMESPACE_BEGIN
00036 
00037 
00038 
00039 <font class="keyword">class </font><a class="code" href="classWriter.html">Writer</a>;
00040 
00041 
00042 
<a name="l00047"></a><a class="code" href="classFormatterToText.html">00047</a> <font class="keyword">class </font>XALAN_XMLSUPPORT_EXPORT <a class="code" href="classFormatterToText.html">FormatterToText</a> : <font class="keyword">public</font> <a class="code" href="classFormatterListener.html">FormatterListener</a>
00048 {
00049 <font class="keyword">public</font>:
00050 
00054     <a class="code" href="classFormatterToText.html#a0">FormatterToText</a>(MemoryManagerType&amp; theManager XALAN_DEFAULT_CONSTRACTOR_MEMORY_MGR);
00055 
00063     <a class="code" href="classFormatterToText.html#a0">FormatterToText</a>(
00064             <a class="code" href="classWriter.html">Writer</a>&amp;             writer,
00065             <font class="keywordtype">bool</font>                normalizeLinefeed = <font class="keyword">true</font>,
00066             <font class="keywordtype">bool</font>                handleIgnorableWhitespace = <font class="keyword">true</font>,
00067             MemoryManagerType&amp;  theManager XALAN_DEFAULT_MEMMGR);
00068 
00077     <a class="code" href="classFormatterToText.html#a0">FormatterToText</a>(
00078             <a class="code" href="classWriter.html">Writer</a>&amp;                 writer,
00079             <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;   encoding,
00080             <font class="keywordtype">bool</font>                    normalizeLinefeed = <font class="keyword">true</font>,
00081             <font class="keywordtype">bool</font>                    handleIgnorableWhitespace = <font class="keyword">true</font>,
00082             MemoryManagerType&amp;      theManager XALAN_DEFAULT_MEMMGR);
00083 
00084     <font class="keyword">static</font> <a class="code" href="classFormatterToText.html">FormatterToText</a>*
00085     <a class="code" href="classFormatterToText.html#d0">create</a>(
00086             MemoryManagerType&amp;      theManager,
00087             <a class="code" href="classWriter.html">Writer</a>&amp;                 writer,
00088             <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;   encoding,
00089             <font class="keywordtype">bool</font>                    normalizeLinefeed = <font class="keyword">true</font>,
00090             <font class="keywordtype">bool</font>                    handleIgnorableWhitespace = <font class="keyword">true</font>);
00091 
00092     <font class="keyword">virtual</font>
00093     <a class="code" href="classFormatterToText.html#a3">~FormatterToText</a>();
00094 
00095     MemoryManagerType&amp;
<a name="l00096"></a><a class="code" href="classFormatterToText.html#a4">00096</a>     <a class="code" href="classFormatterToText.html#a4">getMemoryManager</a>()<font class="keyword"></font>
00097 <font class="keyword">    </font>{
00098         <font class="keywordflow">return</font> m_encoding.<a class="code" href="classXalanDOMString.html#a72">getMemoryManager</a>();
00099     }
00100 
00101     <a class="code" href="classWriter.html">Writer</a>*
<a name="l00102"></a><a class="code" href="classFormatterToText.html#a5">00102</a>     <a class="code" href="classFormatterToText.html#a5">getWriter</a>()<font class="keyword"> const</font>
00103 <font class="keyword">    </font>{
00104         <font class="keywordflow">return</font> m_writer;
00105     }
00106 
00107     <font class="keywordtype">void</font>
<a name="l00108"></a><a class="code" href="classFormatterToText.html#a6">00108</a>     <a class="code" href="classFormatterToText.html#a6">setWriter</a>(<a class="code" href="classWriter.html">Writer</a>*   theWriter)<font class="keyword"></font>
00109 <font class="keyword">    </font>{
00110         m_writer = theWriter;
00111 
00112         update(<font class="keyword">false</font>);
00113     }
00114 
00115     <font class="keywordtype">void</font>
00116     <a class="code" href="classFormatterToText.html#a7">clearEncoding</a>();
00117 
00118     <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
<a name="l00119"></a><a class="code" href="classFormatterToText.html#a8">00119</a>     <a class="code" href="classFormatterToText.html#a8">getEncoding</a>()<font class="keyword"> const</font>
00120 <font class="keyword">    </font>{
00121         <font class="keywordflow">return</font> m_encoding;
00122     }
00123 
00124     <font class="keywordtype">void</font>
<a name="l00125"></a><a class="code" href="classFormatterToText.html#a9">00125</a>     <a class="code" href="classFormatterToText.html#a9">setEncoding</a>(<font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;   theEncoding)<font class="keyword"></font>
00126 <font class="keyword">    </font>{
00127         m_encoding = theEncoding;
00128 
00129         update(<font class="keyword">false</font>);
00130     }
00131 
00132     XalanDOMChar
<a name="l00133"></a><a class="code" href="classFormatterToText.html#a10">00133</a>     <a class="code" href="classFormatterToText.html#a10">getMaxCharacter</a>()<font class="keyword"> const</font>
00134 <font class="keyword">    </font>{
00135         <font class="keywordflow">return</font> m_maxCharacter;
00136     }
00137 
00138     <font class="keywordtype">void</font>
<a name="l00139"></a><a class="code" href="classFormatterToText.html#a11">00139</a>     <a class="code" href="classFormatterToText.html#a11">setMaxCharacter</a>(XalanDOMChar    theMaxChar)<font class="keyword"></font>
00140 <font class="keyword">    </font>{
00141         m_maxCharacter = theMaxChar;
00142     }
00143 
00144     <font class="keywordtype">bool</font>
<a name="l00145"></a><a class="code" href="classFormatterToText.html#a12">00145</a>     <a class="code" href="classFormatterToText.html#a12">getNormalizeLinefeed</a>()<font class="keyword"> const</font>
00146 <font class="keyword">    </font>{
00147         <font class="keywordflow">return</font> m_normalize;
00148     }
00149 
00150     <font class="keywordtype">void</font>
<a name="l00151"></a><a class="code" href="classFormatterToText.html#a13">00151</a>     <a class="code" href="classFormatterToText.html#a13">setNormalizeLinefeed</a>(<font class="keywordtype">bool</font>   fNormalize)<font class="keyword"></font>
00152 <font class="keyword">    </font>{
00153         m_normalize = fNormalize;
00154     }
00155 
00156     <font class="keywordtype">bool</font>
<a name="l00157"></a><a class="code" href="classFormatterToText.html#a14">00157</a>     <a class="code" href="classFormatterToText.html#a14">getHandleIgnorableWhitespace</a>()<font class="keyword"> const</font>
00158 <font class="keyword">    </font>{
00159         <font class="keywordflow">return</font> m_handleIgnorableWhitespace;
00160     }
00161 
00162     <font class="keywordtype">void</font>
<a name="l00163"></a><a class="code" href="classFormatterToText.html#a15">00163</a>     <a class="code" href="classFormatterToText.html#a15">setHandleIgnorableWhitespace</a>(<font class="keywordtype">bool</font>   fHandle)<font class="keyword"></font>
00164 <font class="keyword">    </font>{
00165         m_handleIgnorableWhitespace = fHandle;
00166     }
00167 
00168     <font class="comment">// These methods are inherited from FormatterListener ...</font>
00169 
00170     <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00171     <a class="code" href="classFormatterToText.html#a16">setDocumentLocator</a>(<font class="keyword">const</font> LocatorType* <font class="keyword">const</font>     locator);
00172 
00173     <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00174     <a class="code" href="classFormatterToText.html#a17">startDocument</a>();
00175 
00176     <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00177     <a class="code" href="classFormatterToText.html#a18">endDocument</a>();
00178 
00179     <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00180     <a class="code" href="classFormatterToText.html#a19">startElement</a>(
00181             <font class="keyword">const</font> XMLCh* <font class="keyword">const</font>  name,
00182             AttributeListType&amp;  attrs);
00183 
00184     <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00185     <a class="code" href="classFormatterToText.html#a20">endElement</a>(<font class="keyword">const</font> XMLCh* <font class="keyword">const</font>   name);
00186 
00187     <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00188     <a class="code" href="classFormatterToText.html#a21">characters</a>(
00189             <font class="keyword">const</font> XMLCh* <font class="keyword">const</font>  chars,
00190             <font class="keyword">const</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font>  length);
00191 
00192     <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00193     <a class="code" href="classFormatterToText.html#a22">charactersRaw</a>(
00194             <font class="keyword">const</font> XMLCh* <font class="keyword">const</font>  chars,
00195             <font class="keyword">const</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font>  length);
00196 
00197     <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00198     <a class="code" href="classFormatterToText.html#a23">entityReference</a>(<font class="keyword">const</font> XMLCh* <font class="keyword">const</font>  name);
00199 
00200     <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00201     <a class="code" href="classFormatterToText.html#a24">ignorableWhitespace</a>(
00202             <font class="keyword">const</font> XMLCh* <font class="keyword">const</font>  chars,
00203             <font class="keyword">const</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font>  length);
00204 
00205     <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00206     <a class="code" href="classFormatterToText.html#a25">processingInstruction</a>(
00207             <font class="keyword">const</font> XMLCh* <font class="keyword">const</font>  target,
00208             <font class="keyword">const</font> XMLCh* <font class="keyword">const</font>  data);
00209 
00210     <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00211     <a class="code" href="classFormatterToText.html#a26">resetDocument</a>();
00212 
00213     <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00214     <a class="code" href="classFormatterToText.html#a27">comment</a>(<font class="keyword">const</font> XMLCh* <font class="keyword">const</font>  data);
00215 
00216     <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00217     <a class="code" href="classFormatterToText.html#a28">cdata</a>(
00218             <font class="keyword">const</font> XMLCh* <font class="keyword">const</font>  ch,
00219             <font class="keyword">const</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font>  length);
00220 
00221 <font class="keyword">private</font>:
00222 
00223     <font class="comment">// These are not implemented.</font>
00224     <a class="code" href="classFormatterToText.html#a0">FormatterToText</a>(<font class="keyword">const</font> <a class="code" href="classFormatterToText.html">FormatterToText</a>&amp;);
00225 
00226     <a class="code" href="classFormatterToText.html">FormatterToText</a>&amp;
00227     operator=(<font class="keyword">const</font> <a class="code" href="classFormatterToText.html">FormatterToText</a>&amp;);
00228 
00229     <font class="keywordtype">bool</font>
00230     <a class="code" href="ElemAttributeSet_8hpp.html#a1">operator==</a>(<font class="keyword">const</font> <a class="code" href="classFormatterToText.html">FormatterToText</a>&amp;) <font class="keyword">const</font>;
00231 
00232     <font class="comment">// Utility function to update various member variables</font>
00233     <font class="comment">// when data changes.</font>
00234     <font class="keywordtype">void</font>
00235     update(<font class="keywordtype">bool</font> fNormalizationOnly);
00236 
00237     <font class="comment">// Data members...</font>
00238     <a class="code" href="classWriter.html">Writer</a>*         m_writer;
00239 
00240     XalanDOMChar    m_maxCharacter;
00241 
00242     <a class="code" href="classXalanDOMString.html">XalanDOMString</a>  m_encoding;
00243 
00244     <font class="keywordtype">bool</font>            m_haveEncoding;
00245 
00246     <font class="keywordtype">bool</font>            m_normalize;
00247 
00248     <font class="keywordtype">bool</font>            m_handleIgnorableWhitespace;
00249 
00250     <font class="keyword">const</font> XalanDOMChar*         m_newlineString;
00251 
00252     XalanDOMString::size_type   m_newlineStringLength;
00253 };
00254 
00255 
00256 
00257 XALAN_CPP_NAMESPACE_END
00258 
00259 
00260 
00261 <font class="preprocessor">#endif  // FORMATTERTOTEXT_HEADER_GUARD_1357924680</font>
</font></pre></div><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>