blob: a1bd73e57dfa38eebced639d97955a52f70dca35 [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>FormatterListener.hpp</h1><a href="FormatterListener_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(FORMATTERLISTENER_HEADER_GUARD_1357924680)</font>
<a name="l00017"></a><a class="code" href="FormatterListener_8hpp.html#a0">00017</a> <font class="preprocessor"></font><font class="preprocessor">#define FORMATTERLISTENER_HEADER_GUARD_1357924680</font>
00018 <font class="preprocessor"></font>
00026
00027
00028
00029 <font class="comment">// Base include file. Must be first.</font>
00030 <font class="preprocessor">#include &lt;<a class="code" href="PlatformSupportDefinitions_8hpp.html">xalanc/PlatformSupport/PlatformSupportDefinitions.hpp</a>&gt;</font>
00031
00032
00033
00034 <font class="preprocessor">#include &lt;xercesc/sax/DocumentHandler.hpp&gt;</font>
00035
00036
00037
00038 <font class="preprocessor">#include &lt;<a class="code" href="XalanDOMString_8hpp.html">xalanc/XalanDOM/XalanDOMString.hpp</a>&gt;</font>
00039
00040
00041
00042 XALAN_CPP_NAMESPACE_BEGIN
00043
00044
00045
00046 <font class="keyword">class </font><a class="code" href="classPrefixResolver.html">PrefixResolver</a>;
00047 <font class="keyword">class </font><a class="code" href="classWriter.html">Writer</a>;
00048
00049
00050
<a name="l00051"></a><a class="code" href="FormatterListener_8hpp.html#a2">00051</a> <font class="keyword">typedef</font> XERCES_CPP_NAMESPACE_QUALIFIER Locator LocatorType;
<a name="l00052"></a><a class="code" href="FormatterListener_8hpp.html#a3">00052</a> <font class="keyword">typedef</font> XERCES_CPP_NAMESPACE_QUALIFIER AttributeList AttributeListType;
00053
<a name="l00054"></a><a class="code" href="FormatterListener_8hpp.html#a4">00054</a> <a class="code" href="XSLTInputSource_8hpp.html#a3">XALAN_USING_XERCES</a>(Locator)
00055 <a class="code" href="XSLTInputSource_8hpp.html#a3">XALAN_USING_XERCES</a>(AttributeList)
00056
00057
00062 <font class="keyword">class </font>XALAN_PLATFORMSUPPORT_EXPORT <a class="code" href="classFormatterListener.html">FormatterListener</a> : <font class="keyword">public</font> XERCES_CPP_NAMESPACE_QUALIFIER DocumentHandler
00063 {
00064 <font class="keyword">public</font>:
00065
00066 <font class="keyword">typedef</font> XERCES_CPP_NAMESPACE_QUALIFIER DocumentHandler ParentType;
00067
00068 <font class="comment">// A handy typedef... Must match DocumentHandler's type for characters(), etc...</font>
00069 <font class="keyword">typedef</font> <font class="keywordtype">unsigned</font> <font class="keywordtype">int</font> size_type;
00070
00071 <font class="keyword">enum</font> eFormat
00072 {
00073 OUTPUT_METHOD_NONE = 0,
00074 OUTPUT_METHOD_XML = 1,
00075 OUTPUT_METHOD_HTML = 2,
00076 OUTPUT_METHOD_TEXT = 3,
00077 OUTPUT_METHOD_DOM = 4,
00078 OUTPUT_METHOD_OTHER = 5
00079 };
00080
00081 <font class="keyword">enum</font> eXMLVersion
00082 {
00083 XML_VERSION_1_0 = 0,
00084 XML_VERSION_1_1 = 1
00085 };
00086
00087 <a class="code" href="XSLTResultTarget_8hpp.html#a1">FormatterListener</a>(eFormat theFormat);
00088
00089 <font class="keyword">virtual</font>
00090 ~FormatterListener();
00091
00097 eFormat
00098 getOutputFormat()<font class="keyword"> const</font>
00099 <font class="keyword"> </font>{
00100 <font class="keywordflow">return</font> m_outputFormat;
00101 }
00102
00109 eXMLVersion
00110 getXMLVersion()<font class="keyword"> const</font>
00111 <font class="keyword"> </font>{
00112 <font class="keywordflow">return</font> m_XMLVersion;
00113 }
00114
00120 <font class="keywordtype">bool</font>
00121 isXML1_1Version()<font class="keyword"> const</font>
00122 <font class="keyword"> </font>{
00123 <font class="keywordflow">return</font> ( XML_VERSION_1_1 == m_XMLVersion );
00124 }
00125
00131 <font class="keyword">const</font> <a class="code" href="classPrefixResolver.html">PrefixResolver</a>*
00132 getPrefixResolver()<font class="keyword"> const</font>
00133 <font class="keyword"> </font>{
00134 <font class="keywordflow">return</font> m_prefixResolver;
00135 }
00136
00142 <font class="keywordtype">void</font>
00143 setPrefixResolver(<font class="keyword">const</font> <a class="code" href="classPrefixResolver.html">PrefixResolver</a>* thePrefixResolver)<font class="keyword"></font>
00144 <font class="keyword"> </font>{
00145 m_prefixResolver = thePrefixResolver;
00146 }
00147
00157 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00158 charactersRaw(
00159 <font class="keyword">const</font> XMLCh* <font class="keyword">const</font> chars,
00160 <font class="keyword">const</font> size_type length) = 0;
00161
00168 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00169 comment(<font class="keyword">const</font> XMLCh* <font class="keyword">const</font> data) = 0;
00170
00192 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00193 cdata(
00194 <font class="keyword">const</font> XMLCh* <font class="keyword">const</font> ch,
00195 <font class="keyword">const</font> size_type length) = 0;
00196
00203 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00204 entityReference(<font class="keyword">const</font> XMLCh* <font class="keyword">const</font> name) = 0;
00205
00206
00207 <font class="comment">// These methods are inherited from DocumentHandler ...</font>
00208
00209 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00210 characters(
00211 <font class="keyword">const</font> XMLCh* <font class="keyword">const</font> chars,
00212 <font class="keyword">const</font> size_type length) = 0;
00213
00214 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00215 endDocument() = 0;
00216
00217 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00218 endElement(<font class="keyword">const</font> XMLCh* <font class="keyword">const</font> name) = 0;
00219
00220 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00221 ignorableWhitespace(
00222 <font class="keyword">const</font> XMLCh* <font class="keyword">const</font> chars,
00223 <font class="keyword">const</font> size_type length) = 0;
00224
00225 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00226 processingInstruction(
00227 <font class="keyword">const</font> XMLCh* <font class="keyword">const</font> target,
00228 <font class="keyword">const</font> XMLCh* <font class="keyword">const</font> data) = 0;
00229
00230 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00231 resetDocument() = 0;
00232
00233 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00234 setDocumentLocator(<font class="keyword">const</font> Locator* <font class="keyword">const</font> locator) = 0;
00235
00236 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00237 startDocument() = 0;
00238
00239 <font class="keyword">virtual</font> <font class="keywordtype">void</font>
00240 startElement(
00241 <font class="keyword">const</font> XMLCh* <font class="keyword">const</font> name,
00242 AttributeList&amp; attrs) = 0;
00243
00244 <font class="keyword">virtual</font> <a class="code" href="classWriter.html">Writer</a>*
00245 getWriter() <font class="keyword">const</font>;
00246
00247 <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
00248 getDoctypeSystem() <font class="keyword">const</font>;
00249
00250 <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
00251 getDoctypePublic() <font class="keyword">const</font>;
00252
00253 <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
00254 getEncoding() <font class="keyword">const</font>;
00255
00256 <font class="keyword">virtual</font> <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a>&amp;
00257 getMediaType() <font class="keyword">const</font>;
00258
00259 <font class="keyword">virtual</font> <font class="keywordtype">int</font>
00260 getIndent() <font class="keyword">const</font>;
00261
00262
00263 <font class="comment">// Used when creating PI to work around limitations of</font>
00264 <font class="comment">// our interfaces...</font>
00265 <font class="keyword">static</font> <font class="keyword">const</font> XalanDOMChar s_piTarget[];
00266
00267 <font class="keyword">static</font> <font class="keyword">const</font> XalanDOMChar s_piData[];
00268
00269 <font class="preprocessor">#if defined(XALAN_INLINE_INITIALIZATION)</font>
00270 <font class="preprocessor"></font> <font class="keyword">static</font> <font class="keyword">const</font> XalanDOMString::size_type s_piTargetLength = 5;
00271 <font class="keyword">static</font> <font class="keyword">const</font> XalanDOMString::size_type s_piDataLength = 3;
00272 <font class="preprocessor">#else</font>
00273 <font class="preprocessor"></font> <font class="keyword">static</font> <font class="keyword">const</font> XalanDOMString::size_type s_piTargetLength;
00274 <font class="keyword">static</font> <font class="keyword">const</font> XalanDOMString::size_type s_piDataLength;
00275 <font class="preprocessor">#endif</font>
00276 <font class="preprocessor"></font>
00277
00278 <font class="keyword">protected</font>:
00279
00280 <font class="comment">// Data membmers...</font>
00281 <font class="keyword">const</font> <a class="code" href="classPrefixResolver.html">PrefixResolver</a>* m_prefixResolver;
00282
00283 <font class="keyword">static</font> <font class="keyword">const</font> <a class="code" href="classXalanDOMString.html">XalanDOMString</a> s_emptyString;
00284
00290 <font class="keywordtype">void</font>
00291 setXMLVersion(eXMLVersion theVersion)<font class="keyword"></font>
00292 <font class="keyword"> </font>{
00293 m_XMLVersion = theVersion;
00294 }
00295
00296 <font class="keyword">private</font>:
00297
00298 <font class="comment">// Not implemented...</font>
00299 <a class="code" href="XSLTResultTarget_8hpp.html#a1">FormatterListener</a>(<font class="keyword">const</font> <a class="code" href="classFormatterListener.html">FormatterListener</a>&amp;);
00300
00301 <a class="code" href="classFormatterListener.html">FormatterListener</a>&amp;
00302 operator=(<font class="keyword">const</font> <a class="code" href="classFormatterListener.html">FormatterListener</a>&amp;);
00303
00304 <font class="keywordtype">bool</font>
00305 <a class="code" href="ElemAttributeSet_8hpp.html#a1">operator==</a>(<font class="keyword">const</font> <a class="code" href="classFormatterListener.html">FormatterListener</a>&amp;) <font class="keyword">const</font>;
00306
00307 <font class="comment">// Data membmers...</font>
00308 <font class="keyword">const</font> eFormat m_outputFormat;
00309
00310 eXMLVersion m_XMLVersion;
00311 };
00312
00313
00314
00315 XALAN_CPP_NAMESPACE_END
00316
00317
00318
00319 <font class="preprocessor">#endif // FORMATTERLISTENER_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>