ContentHandler.hpp Source File

00001 /*
00002  * Copyright 1999-2000,2004 The Apache Software Foundation.
00003  * 
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  * 
00008  *      http://www.apache.org/licenses/LICENSE-2.0
00009  * 
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 
00017 /*
00018  * $Log: ContentHandler.hpp,v $
00019  * Revision 1.4  2004/09/08 13:56:20  peiyongz
00020  * Apache License Version 2.0
00021  *
00022  * Revision 1.3  2003/03/07 18:10:30  tng
00023  * Return a reference instead of void for operator=
00024  *
00025  * Revision 1.2  2002/11/04 14:55:45  tng
00026  * C++ Namespace Support.
00027  *
00028  * Revision 1.1.1.1  2002/02/01 22:22:09  peiyongz
00029  * sane_include
00030  *
00031  * Revision 1.4  2000/12/14 18:50:05  tng
00032  * Fix API document generation warning: "Warning: end of member group without matching begin"
00033  *
00034  * Revision 1.3  2000/08/09 22:19:29  jpolast
00035  * many conformance & stability changes:
00036  *   - ContentHandler::resetDocument() removed
00037  *   - attrs param of ContentHandler::startDocument() made const
00038  *   - SAXExceptions thrown now have msgs
00039  *   - removed duplicate function signatures that had 'const'
00040  *       [ eg: getContentHander() ]
00041  *   - changed getFeature and getProperty to apply to const objs
00042  *   - setProperty now takes a void* instead of const void*
00043  *   - SAX2XMLReaderImpl does not inherit from SAXParser anymore
00044  *   - Reuse Validator (http://apache.org/xml/features/reuse-validator) implemented
00045  *   - Features & Properties now read-only during parse
00046  *
00047  * Revision 1.2  2000/08/07 18:21:27  jpolast
00048  * change  module to 
00049  *
00050  * Revision 1.1  2000/08/02 18:02:34  jpolast
00051  * initial checkin of sax2 implementation
00052  * submitted by Simon Fell (simon@fell.com)
00053  * and Joe Polastre (jpolast@apache.org)
00054  *
00055  *
00056  */
00057 
00058 
00059 #ifndef CONTENTHANDLER_HPP
00060 #define CONTENTHANDLER_HPP
00061 
00062 #include <xercesc/util/XercesDefs.hpp>
00063 
00064 XERCES_CPP_NAMESPACE_BEGIN
00065 
00066 class Attributes;
00067 class Locator;
00068 
00097 class  ContentHandler
00098 {
00099 public:
00103     ContentHandler()
00104     {
00105     }
00106 
00108     virtual ~ContentHandler()
00109     {
00110     }
00112 
00140     virtual void characters
00141     (
00142         const   XMLCh* const    chars
00143         , const unsigned int    length
00144     ) = 0;
00145 
00158     virtual void endDocument () = 0;
00159 
00174     virtual void endElement
00175     (
00176         const XMLCh* const uri,
00177         const XMLCh* const localname,
00178         const XMLCh* const qname
00179     ) = 0;
00180 
00204     virtual void ignorableWhitespace
00205     (
00206         const   XMLCh* const    chars
00207         , const unsigned int    length
00208     ) = 0;
00209 
00227     virtual void processingInstruction
00228     (
00229         const   XMLCh* const    target
00230         , const XMLCh* const    data
00231     ) = 0;
00232 
00261     virtual void setDocumentLocator(const Locator* const locator) = 0;
00262 
00273     virtual void startDocument() = 0;
00274 
00298     virtual void startElement
00299     (
00300         const   XMLCh* const    uri,
00301         const   XMLCh* const    localname,
00302         const   XMLCh* const    qname,
00303         const   Attributes&     attrs
00304     ) = 0;
00305 
00318     virtual void startPrefixMapping
00319     (
00320         const   XMLCh* const    prefix,
00321         const   XMLCh* const    uri
00322     ) = 0 ;
00323 
00335     virtual void endPrefixMapping
00336     (
00337         const   XMLCh* const    prefix
00338     ) = 0 ;
00339 
00361     virtual void skippedEntity
00362     (
00363         const   XMLCh* const    name
00364     ) = 0 ;
00365 
00367 private :
00368     /* Unimplemented Constructors and operators */
00369     /* Copy constructor */
00370     ContentHandler(const ContentHandler&);
00372     ContentHandler& operator=(const ContentHandler&);
00373 };
00374 
00375 XERCES_CPP_NAMESPACE_END
00376 
00377 #endif