Xerces-C++: DOMLSParserFilter.hpp Source File

Xerces-C++ 3.3.0

DOMLSParserFilter.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_DOMLSPARSERFILTER_HPP)
23#define XERCESC_INCLUDE_GUARD_DOMLSPARSERFILTER_HPP
24
38#include <xercesc/dom/DOMNodeFilter.hpp>
39
40 XERCES_CPP_NAMESPACE_BEGIN
41
42class DOMElement;
43class DOMNode;
44
45 class CDOM_EXPORT DOMLSParserFilter {
46protected:
47 // -----------------------------------------------------------------------
48 // Hidden constructors
49 // -----------------------------------------------------------------------
52 DOMLSParserFilter() {};
54
55private:
56 // -----------------------------------------------------------------------
57 // Unimplemented constructors and operators
58 // -----------------------------------------------------------------------
61 DOMLSParserFilter(const DOMLSParserFilter &);
62 DOMLSParserFilter & operator = (const DOMLSParserFilter &);
64
65
66public:
67 // -----------------------------------------------------------------------
68 // All constructors are hidden, just the destructor is available
69 // -----------------------------------------------------------------------
76 virtual ~DOMLSParserFilter() {};
78
79 // -----------------------------------------------------------------------
80 // Class Types
81 // -----------------------------------------------------------------------
101 enum FilterAction {FILTER_ACCEPT = 1,
102 FILTER_REJECT = 2,
103 FILTER_SKIP = 3,
104 FILTER_INTERRUPT = 4};
105
106 // -----------------------------------------------------------------------
107 // Virtual DOMLSParserFilter interface
108 // -----------------------------------------------------------------------
128 virtual FilterAction acceptNode(DOMNode* node) = 0;
129
145 virtual FilterAction startElement(DOMElement* node) = 0;
146
157 virtual DOMNodeFilter::ShowType getWhatToShow() const = 0;
158
160};
161
162 XERCES_CPP_NAMESPACE_END
163
164#endif
DOMNodeFilter.hpp
CDOM_EXPORT
#define CDOM_EXPORT
Definition XercesDefs.hpp:166
XERCES_CPP_NAMESPACE_BEGIN
#define XERCES_CPP_NAMESPACE_BEGIN
Definition XercesDefs.hpp:112
XERCES_CPP_NAMESPACE_END
#define XERCES_CPP_NAMESPACE_END
Definition XercesDefs.hpp:113
DOMElement
By far the vast majority of objects (apart from text) that authors encounter when traversing a docume...
Definition DOMElement.hpp:66
DOMLSParserFilter
Definition DOMLSParserFilter.hpp:45
DOMLSParserFilter::DOMLSParserFilter
DOMLSParserFilter()
Definition DOMLSParserFilter.hpp:52
DOMLSParserFilter::~DOMLSParserFilter
virtual ~DOMLSParserFilter()
Destructor.
Definition DOMLSParserFilter.hpp:76
DOMLSParserFilter::getWhatToShow
virtual DOMNodeFilter::ShowType getWhatToShow() const =0
Tells the DOMLSParser what types of nodes to show to the method DOMLSParserFilter::acceptNode.
DOMLSParserFilter::acceptNode
virtual FilterAction acceptNode(DOMNode *node)=0
This method will be called by the parser at the completion of the parsing of each node.
DOMLSParserFilter::startElement
virtual FilterAction startElement(DOMElement *node)=0
The parser will call this method after each DOMElement start tag has been scanned,...
DOMLSParserFilter::FilterAction
FilterAction
Constants returned by acceptNode.
Definition DOMLSParserFilter.hpp:101
DOMNodeFilter::ShowType
unsigned long ShowType
Definition DOMNodeFilter.hpp:193
DOMNode
The DOMNode interface is the primary datatype for the entire Document Object Model.
Definition DOMNode.hpp:139