Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.6

Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

GenerateEvent.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999-2002 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 <xalanc/XSLT/XSLTDefinitions.hpp>
00064 
00065 
00066 
00067 #include <xalanc/XalanDOM/XalanDOMString.hpp>
00068 
00069 
00070 
00071 XALAN_DECLARE_XERCES_CLASS(AttributeList)
00072 
00073 
00074 
00075 XALAN_CPP_NAMESPACE_BEGIN
00076 
00077 
00078 
00079 typedef XERCES_CPP_NAMESPACE_QUALIFIER AttributeList    AttributeListType;
00080 
00081 
00082 
00091 class XALAN_XSLT_EXPORT GenerateEvent
00092 {
00093 public:
00094 
00095     enum EventType
00096     {
00101         EVENTTYPE_STARTDOCUMENT = 1,
00102             
00106         EVENTTYPE_ENDDOCUMENT = 2,
00107         
00111         EVENTTYPE_STARTELEMENT = 3,
00112         
00116         EVENTTYPE_ENDELEMENT = 4,
00117         
00121         EVENTTYPE_CHARACTERS = 5,
00122         
00126         EVENTTYPE_IGNORABLEWHITESPACE = 6,
00127 
00131         EVENTTYPE_PI = 7,
00132 
00136         EVENTTYPE_COMMENT = 8,
00137 
00141         EVENTTYPE_ENTITYREF = 9,
00142 
00146         EVENTTYPE_CDATA = 10
00147     };
00148 
00149 
00155     GenerateEvent(EventType     eventType);
00156     
00164     GenerateEvent(
00165             EventType               eventType,
00166             const XalanDOMChar*     name,
00167             AttributeListType*      atts);
00168 
00176     GenerateEvent(
00177             EventType                   eventType,
00178             const XalanDOMString&       name,
00179             const AttributeListType*    atts = 0);
00180 
00189     GenerateEvent(
00190             EventType                   eventType,
00191             const XalanDOMChar*         ch,
00192             XalanDOMString::size_type   start,
00193             XalanDOMString::size_type   length);
00194     
00202     GenerateEvent(
00203             EventType               eventType,
00204             const XalanDOMChar*     name,
00205             const XalanDOMChar*     data);
00206     
00214     GenerateEvent(
00215             EventType               eventType,
00216             const XalanDOMChar*     data);
00217 
00222     EventType               m_eventType;
00223 
00227     XalanDOMString          m_characters;
00228 
00232     XalanDOMString::size_type   m_start;
00233 
00237     XalanDOMString::size_type   m_length;
00238 
00242     XalanDOMString          m_name;
00243 
00247     XalanDOMString          m_data;
00248 
00252     const AttributeListType*    m_pAtts;
00253 };
00254 
00255 
00256 
00257 XALAN_CPP_NAMESPACE_END
00258 
00259 
00260 
00261 #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++ XSLT Processor Version 1.6
Copyright © 2000, 2001, 2002, 2003 The Apache Software Foundation. All Rights Reserved.