<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.4</h3>
</BODY>
<!-- Generated by Doxygen 1.1.2 on Mon Sep 16 08:23:50 2002 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
<hr><h1>FormatterToText.hpp</h1><a href="FormatterToText.hpp.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 /*
00002 * The Apache Software License, Version 1.1
00003 *
00004 *
00005 * Copyright (c) 1999 The Apache Software Foundation. All rights
00006 * reserved.
00007 *
00008 * Redistribution and use in source and binary forms, with or without
00009 * modification, are permitted provided that the following conditions
00010 * are met:
00011 *
00012 * 1. Redistributions of source code must retain the above copyright
00013 * notice, this list of conditions and the following disclaimer.
00014 *
00015 * 2. Redistributions in binary form must reproduce the above copyright
00016 * notice, this list of conditions and the following disclaimer in
00017 * the documentation and/or other materials provided with the
00018 * distribution.
00019 *
00020 * 3. The end-user documentation included with the redistribution,
00021 * if any, must include the following acknowledgment:
00022 * "This product includes software developed by the
00023 * Apache Software Foundation (http://www.apache.org/)."
00024 * Alternately, this acknowledgment may appear in the software itself,
00025 * if and wherever such third-party acknowledgments normally appear.
00026 *
00027 * 4. The names "Xalan" and "Apache Software Foundation" must
00028 * not be used to endorse or promote products derived from this
00029 * software without prior written permission. For written
00030 * permission, please contact apache@apache.org.
00031 *
00032 * 5. Products derived from this software may not be called "Apache",
00033 * nor may "Apache" appear in their name, without prior written
00034 * permission of the Apache Software Foundation.
00035 *
00036 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00037 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00038 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00039 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00040 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00041 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00042 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00043 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00044 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00045 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00046 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00047 * SUCH DAMAGE.
00048 * ====================================================================
00049 *
00050 * This software consists of voluntary contributions made by many
00051 * individuals on behalf of the Apache Software Foundation and was
00052 * originally based on software copyright (c) 1999, International
00053 * Business Machines, Inc., http://www.ibm.com. For more
00054 * information on the Apache Software Foundation, please see
00055 * <http://www.apache.org/>.
00056 */
00057 #if !defined(FORMATTERTOTEXT_HEADER_GUARD_1357924680)
<a name="l00058"><a class="code" href="FormatterToText.hpp.html#a0">00058</a></a> #define FORMATTERTOTEXT_HEADER_GUARD_1357924680
00059
00060
00061
00062 // Base include file. Must be first.
00063 #include <XMLSupport/XMLSupportDefinitions.hpp>
00064
00065
00066
00067 #include <XalanDOM/XalanDOMString.hpp>
00068
00069
00070
00071 // Base class header file.
00072 #include <PlatformSupport/FormatterListener.hpp>
00073
00074
00075
00076 class <a class="code" href="class_writer.html">Writer</a>;
00077 class <a class="code" href="class_locator.html">Locator</a>;
00078
00079
00080
<a name="l00085"><a class="code" href="class_formattertotext.html">00085</a></a> class XALAN_XMLSUPPORT_EXPORT <a class="code" href="class_formattertotext.html">FormatterToText</a> : public <a class="code" href="class_formatterlistener.html">FormatterListener</a>
00086 {
00087 public:
00088
00092 <a class="code" href="class_formattertotext.html#a0">FormatterToText</a>();
00093
00101 <a class="code" href="class_formattertotext.html#a0">FormatterToText</a>(
00102 <a class="code" href="class_writer.html">Writer</a>& writer,
00103 bool normalizeLinefeed = true,
00104 bool handleIgnorableWhitespace = true);
00105
00114 <a class="code" href="class_formattertotext.html#a0">FormatterToText</a>(
00115 <a class="code" href="class_writer.html">Writer</a>& writer,
00116 const <a class="code" href="class_xalandomstring.html">XalanDOMString</a>& encoding,
00117 bool normalizeLinefeed = true,
00118 bool handleIgnorableWhitespace = true);
00119
00120 virtual
00121 <a class="code" href="class_formattertotext.html#a3">~FormatterToText</a>();
00122
00123
00124 <a class="code" href="class_writer.html">Writer</a>*
<a name="l00125"><a class="code" href="class_formattertotext.html#a4">00125</a></a> <a class="code" href="class_formattertotext.html#a4">getWriter</a>() const
00126 {
00127 return m_writer;
00128 }
00129
00130 void
<a name="l00131"><a class="code" href="class_formattertotext.html#a5">00131</a></a> <a class="code" href="class_formattertotext.html#a5">setWriter</a>(<a class="code" href="class_writer.html">Writer</a>* theWriter)
00132 {
00133 m_writer = theWriter;
00134
00135 update();
00136 }
00137
00138 void
00139 <a class="code" href="class_formattertotext.html#a6">clearEncoding</a>();
00140
00141 const <a class="code" href="class_xalandomstring.html">XalanDOMString</a>&
<a name="l00142"><a class="code" href="class_formattertotext.html#a7">00142</a></a> <a class="code" href="class_formattertotext.html#a7">getEncoding</a>() const
00143 {
00144 return m_encoding;
00145 }
00146
00147 void
<a name="l00148"><a class="code" href="class_formattertotext.html#a8">00148</a></a> <a class="code" href="class_formattertotext.html#a8">setEncoding</a>(const <a class="code" href="class_xalandomstring.html">XalanDOMString</a>& theEncoding)
00149 {
00150 m_encoding = theEncoding;
00151
00152 update();
00153 }
00154
00155 XalanDOMChar
<a name="l00156"><a class="code" href="class_formattertotext.html#a9">00156</a></a> <a class="code" href="class_formattertotext.html#a9">getMaxCharacter</a>() const
00157 {
00158 return m_maxCharacter;
00159 }
00160
00161 void
<a name="l00162"><a class="code" href="class_formattertotext.html#a10">00162</a></a> <a class="code" href="class_formattertotext.html#a10">setMaxCharacter</a>(XalanDOMChar theMaxChar)
00163 {
00164 m_maxCharacter = theMaxChar;
00165 }
00166
00167 bool
<a name="l00168"><a class="code" href="class_formattertotext.html#a11">00168</a></a> <a class="code" href="class_formattertotext.html#a11">getNormalizeLinefeed</a>() const
00169 {
00170 return m_normalize;
00171 }
00172
00173 void
<a name="l00174"><a class="code" href="class_formattertotext.html#a12">00174</a></a> <a class="code" href="class_formattertotext.html#a12">setNormalizeLinefeed</a>(bool fNormalize)
00175 {
00176 m_normalize = fNormalize;
00177 }
00178
00179 bool
<a name="l00180"><a class="code" href="class_formattertotext.html#a13">00180</a></a> <a class="code" href="class_formattertotext.html#a13">getHandleIgnorableWhitespace</a>() const
00181 {
00182 return m_handleIgnorableWhitespace;
00183 }
00184
00185 void
<a name="l00186"><a class="code" href="class_formattertotext.html#a14">00186</a></a> <a class="code" href="class_formattertotext.html#a14">setHandleIgnorableWhitespace</a>(bool fHandle)
00187 {
00188 m_handleIgnorableWhitespace = fHandle;
00189 }
00190
00191 // These methods are inherited from FormatterListener ...
00192
00193 virtual void
00194 <a class="code" href="class_formatterlistener.html#a15">setDocumentLocator</a>(const <a class="code" href="class_locator.html">Locator</a>* const locator);
00195
00196 virtual void
00197 <a class="code" href="class_formatterlistener.html#a16">startDocument</a>();
00198
00199 virtual void
00200 <a class="code" href="class_formatterlistener.html#a10">endDocument</a>();
00201
00202 virtual void
00203 <a class="code" href="class_formatterlistener.html#a17">startElement</a>(
00204 const XMLCh* const name,
00205 <a class="code" href="class_attributelist.html">AttributeList</a>& attrs);
00206
00207 virtual void
00208 <a class="code" href="class_formatterlistener.html#a11">endElement</a>(const XMLCh* const name);
00209
00210 virtual void
00211 <a class="code" href="class_formatterlistener.html#a9">characters</a>(
00212 const XMLCh* const chars,
00213 const unsigned int length);
00214
00215 virtual void
00216 <a class="code" href="class_formatterlistener.html#a5">charactersRaw</a>(
00217 const XMLCh* const chars,
00218 const unsigned int length);
00219
00220 virtual void
00221 <a class="code" href="class_formatterlistener.html#a8">entityReference</a>(const XMLCh* const name);
00222
00223 virtual void
00224 <a class="code" href="class_formatterlistener.html#a12">ignorableWhitespace</a>(
00225 const XMLCh* const chars,
00226 const unsigned int length);
00227
00228 virtual void
00229 <a class="code" href="class_formatterlistener.html#a13">processingInstruction</a>(
00230 const XMLCh* const target,
00231 const XMLCh* const data);
00232
00233 virtual void
00234 <a class="code" href="class_formatterlistener.html#a14">resetDocument</a>();
00235
00236 virtual void
00237 <a class="code" href="class_formatterlistener.html#a6">comment</a>(const XMLCh* const data);
00238
00239 virtual void
00240 <a class="code" href="class_formatterlistener.html#a7">cdata</a>(
00241 const XMLCh* const ch,
00242 const unsigned int length);
00243
00244 private:
00245
00246 // These are not implemented.
00247 <a class="code" href="class_formattertotext.html#a0">FormatterToText</a>(const <a class="code" href="class_formattertotext.html">FormatterToText</a>&);
00248
00249 <a class="code" href="class_formattertotext.html">FormatterToText</a>&
00250 operator=(const <a class="code" href="class_formattertotext.html">FormatterToText</a>&);
00251
00252 bool
00253 operator==(const <a class="code" href="class_formattertotext.html">FormatterToText</a>&) const;
00254
00255 // Utility function to update various member variables
00256 // when data changes.
00257 void
00258 update();
00259
00260 // Data members...
00261 <a class="code" href="class_writer.html">Writer</a>* m_writer;
00262
00263 XalanDOMChar m_maxCharacter;
00264
00265 <a class="code" href="class_xalandomstring.html">XalanDOMString</a> m_encoding;
00266
00267 bool m_haveEncoding;
00268
00269 bool m_normalize;
00270
00271 bool m_handleIgnorableWhitespace;
00272 };
00273
00274
00275
00276 #endif // FORMATTERTOTEXT_HEADER_GUARD_1357924680
</div></pre><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="images/dot.gif" width="1"></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.4</B><BR>
Copyright © 2000, 2001, 2002 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">
</TD>
</TR>
</TABLE>
