Xerces-C++ 3.3.0

DocumentHandler.hpp
Go to the documentation of this file.
1/*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18/*
19 * $Id$
20 */
21
22#if !defined(XERCESC_INCLUDE_GUARD_DOCUMENTHANDLER_HPP)
23#define XERCESC_INCLUDE_GUARD_DOCUMENTHANDLER_HPP
24
25#include <xercesc/util/XercesDefs.hpp>
26
27 XERCES_CPP_NAMESPACE_BEGIN
28
29 class AttributeList;
30 class Locator;
31
60 class SAX_EXPORT DocumentHandler
61{
62 public:
66 DocumentHandler()
67 {
68 }
69
71 virtual ~DocumentHandler()
72 {
73 }
75
103 virtual void characters
104 (
105 const XMLCh* const chars
106 , const XMLSize_t length
107 ) = 0;
108
121 virtual void endDocument () = 0;
122
138 virtual void endElement(const XMLCh* const name) = 0;
139
163 virtual void ignorableWhitespace
164 (
165 const XMLCh* const chars
166 , const XMLSize_t length
167 ) = 0;
168
186 virtual void processingInstruction
187 (
188 const XMLCh* const target
189 , const XMLCh* const data
190 ) = 0;
191
199 virtual void resetDocument() = 0;
200
229 virtual void setDocumentLocator(const Locator* const locator) = 0;
230
241 virtual void startDocument() = 0;
242
265 virtual void startElement
266 (
267 const XMLCh* const name
268 , AttributeList& attrs
269 ) = 0;
270
272
273private :
274 /* Unimplemented Constructors and operators */
275 /* Copy constructor */
276 DocumentHandler(const DocumentHandler&);
278 DocumentHandler& operator=(const DocumentHandler&);
279};
280
281 XERCES_CPP_NAMESPACE_END
282
283#endif
XercesDefs.hpp
XERCES_CPP_NAMESPACE_BEGIN
#define XERCES_CPP_NAMESPACE_BEGIN
Definition XercesDefs.hpp:112
SAX_EXPORT
#define SAX_EXPORT
Definition XercesDefs.hpp:164
XERCES_CPP_NAMESPACE_END
#define XERCES_CPP_NAMESPACE_END
Definition XercesDefs.hpp:113
XMLSize_t
size_t XMLSize_t
Definition Xerces_autoconf_config.hpp:112
XMLCh
char16_t XMLCh
Definition Xerces_autoconf_config.hpp:120
AttributeList
Interface for an element's attribute specifications.
Definition AttributeList.hpp:81
DocumentHandler
Receive notification of general document events.
Definition DocumentHandler.hpp:61
DocumentHandler::characters
virtual void characters(const XMLCh *const chars, const XMLSize_t length)=0
Receive notification of character data.
DocumentHandler::startElement
virtual void startElement(const XMLCh *const name, AttributeList &attrs)=0
Receive notification of the beginning of an element.
DocumentHandler::startDocument
virtual void startDocument()=0
Receive notification of the beginning of a document.
DocumentHandler::processingInstruction
virtual void processingInstruction(const XMLCh *const target, const XMLCh *const data)=0
Receive notification of a processing instruction.
DocumentHandler::~DocumentHandler
virtual ~DocumentHandler()
Destructor.
Definition DocumentHandler.hpp:71
DocumentHandler::endDocument
virtual void endDocument()=0
Receive notification of the end of a document.
DocumentHandler::resetDocument
virtual void resetDocument()=0
Reset the Document object on its reuse.
DocumentHandler::DocumentHandler
DocumentHandler()
Default constructor.
Definition DocumentHandler.hpp:66
DocumentHandler::endElement
virtual void endElement(const XMLCh *const name)=0
Receive notification of the end of an element.
DocumentHandler::setDocumentLocator
virtual void setDocumentLocator(const Locator *const locator)=0
Receive an object for locating the origin of SAX document events.
DocumentHandler::ignorableWhitespace
virtual void ignorableWhitespace(const XMLCh *const chars, const XMLSize_t length)=0
Receive notification of ignorable whitespace in element content.
Locator
Interface for associating a SAX event with a document location.
Definition Locator.hpp:55