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  

GenerateEvent.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(XALAN_GenerateEvent_HEADER_GUARD)
00058 #define XALAN_GenerateEvent_HEADER_GUARD 
00059 
00060 
00061 
00062 // Base include file.  Must be first.
00063 #include <XSLT/XSLTDefinitions.hpp>
00064 
00065 
00066 
00067 #include <XalanDOM/XalanDOMString.hpp>
00068 
00069 
00070 
00071 class AttributeList;
00072 
00073 
00074 
00083 class XALAN_XSLT_EXPORT GenerateEvent
00084 {
00085 public:
00086 
00087     enum EventType
00088     {
00093         EVENTTYPE_STARTDOCUMENT = 1,
00094             
00098         EVENTTYPE_ENDDOCUMENT = 2,
00099         
00103         EVENTTYPE_STARTELEMENT = 3,
00104         
00108         EVENTTYPE_ENDELEMENT = 4,
00109         
00113         EVENTTYPE_CHARACTERS = 5,
00114         
00118         EVENTTYPE_IGNORABLEWHITESPACE = 6,
00119 
00123         EVENTTYPE_PI = 7,
00124 
00128         EVENTTYPE_COMMENT = 8,
00129 
00133         EVENTTYPE_ENTITYREF = 9,
00134 
00138         EVENTTYPE_CDATA = 10
00139     };
00140 
00141 
00147     GenerateEvent(EventType     eventType);
00148     
00156     GenerateEvent(
00157             EventType               eventType,
00158             const XalanDOMString&   name,
00159             AttributeList*          atts);
00160     
00169     GenerateEvent(
00170             EventType               eventType,
00171             const XalanDOMChar*     ch,
00172             unsigned int            start,
00173             unsigned int            length);
00174     
00182     GenerateEvent(
00183             EventType               eventType,
00184             const XalanDOMString&   name,
00185             const XalanDOMString&   data);
00186     
00194     GenerateEvent(
00195             EventType               eventType,
00196             const XalanDOMString&   data);
00197 
00202     EventType           m_eventType;
00203 
00204 
00208     XalanDOMString      m_characters;
00209 
00213     unsigned int        m_start;
00214 
00218     unsigned int        m_length;
00219 
00223     XalanDOMString      m_name;
00224 
00228     XalanDOMString      m_data;
00229 
00233     AttributeList*      m_pAtts;
00234 };
00235 
00236 
00237 
00238 #endif  //XALAN_GenerateEvent_HEADER_GUARD

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.