Xalan-C++ API Documentation

The Xalan-C++ XSL Transformer Version 1.0

Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

FormatterListener.hpp

Go to the documentation of this file.
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(FORMATTERLISTENER_HEADER_GUARD_1357924680)
00058 #define FORMATTERLISTENER_HEADER_GUARD_1357924680
00059 
00067 
00068 
00069 
00070 // Base include file.  Must be first.
00071 #include <XMLSupport/XMLSupportDefinitions.hpp>
00072 
00073 
00074 
00075 #include <sax/DocumentHandler.hpp>
00076 
00077 
00078 
00083 class XALAN_XMLSUPPORT_EXPORT FormatterListener : public DocumentHandler
00084 {
00085 public:
00086 
00087     enum eFormat
00088     {
00089         OUTPUT_METHOD_NONE = 0,
00090         OUTPUT_METHOD_XML = 1,
00091         OUTPUT_METHOD_HTML = 2,
00092         OUTPUT_METHOD_TEXT = 3,
00093         OUTPUT_METHOD_DOM = 4,
00094         OUTPUT_METHOD_OTHER = 5
00095     };
00096 
00097     FormatterListener(eFormat   theFormat);
00098 
00099     virtual
00100     ~FormatterListener();
00101 
00102 
00103     eFormat
00104     getOutputFormat() const
00105     {
00106         return m_outputFormat;
00107     }
00108 
00118     virtual void
00119     charactersRaw(
00120             const XMLCh* const  chars,
00121             const unsigned int  length) = 0;
00122 
00129     virtual void
00130     comment(const XMLCh* const  data) = 0;
00131 
00153     virtual void
00154     cdata(
00155             const XMLCh* const  ch,
00156             const unsigned int  length) = 0;
00157 
00164     virtual void
00165     entityReference(const XMLCh* const  name) = 0;
00166 
00167 
00168 // These methods are inherited from DocumentHandler ...
00169 
00170     virtual void
00171     characters(
00172             const XMLCh* const  chars,
00173             const unsigned int  length) = 0;
00174 
00175     virtual void
00176     endDocument() = 0;
00177 
00178     virtual void
00179     endElement(const XMLCh* const   name) = 0;
00180 
00181     virtual void
00182     ignorableWhitespace(
00183             const XMLCh* const  chars,
00184             const unsigned int  length) = 0;
00185 
00186     virtual void
00187     processingInstruction(
00188             const XMLCh* const  target,
00189             const XMLCh* const  data) = 0;
00190 
00191     virtual void
00192     resetDocument() = 0;
00193 
00194     virtual void
00195     setDocumentLocator(const Locator* const     locator) = 0;
00196 
00197     virtual void
00198     startDocument() = 0;
00199 
00200     virtual void
00201     startElement(
00202             const   XMLCh* const    name,
00203             AttributeList&          attrs) = 0;
00204 
00205 private:
00206 
00207     const eFormat   m_outputFormat;
00208 };
00209 
00210 
00211 
00212 #endif  // FORMATTERLISTENER_HEADER_GUARD_1357924680

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSL Transformer Version 1.0
Copyright © 2000 The Apache Software Foundation. All Rights Reserved.