DOMNodeFilter.hpp
Go to the documentation of this file.
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* $Id$
*/
#if !defined(XERCESC_INCLUDE_GUARD_DOMNODEFILTER_HPP)
#define XERCESC_INCLUDE_GUARD_DOMNODEFILTER_HPP
#include <xercesc/dom/DOMNode.hpp>
XERCES_CPP_NAMESPACE_BEGIN
class CDOM_EXPORT DOMNodeFilter
{
protected:
// -----------------------------------------------------------------------
// Hidden constructors
// -----------------------------------------------------------------------
DOMNodeFilter() {};
private:
// -----------------------------------------------------------------------
// Unimplemented constructors and operators
// -----------------------------------------------------------------------
DOMNodeFilter(const DOMNodeFilter &);
DOMNodeFilter & operator = (const DOMNodeFilter &);
public:
// -----------------------------------------------------------------------
// All constructors are hidden, just the destructor is available
// -----------------------------------------------------------------------
virtual ~DOMNodeFilter() {};
// -----------------------------------------------------------------------
// Class Types
// -----------------------------------------------------------------------
enum FilterAction {FILTER_ACCEPT = 1,
FILTER_REJECT = 2,
FILTER_SKIP = 3};
enum ShowTypeMasks {
SHOW_ALL = 0x0000FFFF,
SHOW_ELEMENT = 0x00000001,
SHOW_ATTRIBUTE = 0x00000002,
SHOW_TEXT = 0x00000004,
SHOW_CDATA_SECTION = 0x00000008,
SHOW_ENTITY_REFERENCE = 0x00000010,
SHOW_ENTITY = 0x00000020,
SHOW_PROCESSING_INSTRUCTION = 0x00000040,
SHOW_COMMENT = 0x00000080,
SHOW_DOCUMENT = 0x00000100,
SHOW_DOCUMENT_TYPE = 0x00000200,
SHOW_DOCUMENT_FRAGMENT = 0x00000400,
SHOW_NOTATION = 0x00000800
};
typedef unsigned long ShowType;
// -----------------------------------------------------------------------
// Virtual DOMNodeFilter interface
// -----------------------------------------------------------------------
virtual FilterAction acceptNode (const DOMNode* node) const =0;
};
XERCES_CPP_NAMESPACE_END
#endif
DOMNode.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
DOMNodeFilter
Filters are objects that know how to "filter out" nodes.
Definition DOMNodeFilter.hpp:50
DOMNodeFilter::DOMNodeFilter
DOMNodeFilter()
Definition DOMNodeFilter.hpp:57
DOMNodeFilter::~DOMNodeFilter
virtual ~DOMNodeFilter()
Destructor.
Definition DOMNodeFilter.hpp:80
DOMNodeFilter::FilterAction
FilterAction
Constants returned by acceptNode.
Definition DOMNodeFilter.hpp:112
DOMNodeFilter::FILTER_SKIP
@ FILTER_SKIP
Definition DOMNodeFilter.hpp:114
DOMNodeFilter::FILTER_REJECT
@ FILTER_REJECT
Definition DOMNodeFilter.hpp:113
DOMNodeFilter::FILTER_ACCEPT
@ FILTER_ACCEPT
Definition DOMNodeFilter.hpp:112
DOMNodeFilter::ShowType
unsigned long ShowType
Definition DOMNodeFilter.hpp:193
DOMNodeFilter::acceptNode
virtual FilterAction acceptNode(const DOMNode *node) const =0
Test whether a specified node is visible in the logical view of a DOMTreeWalker or DOMNodeIterator.
DOMNodeFilter::ShowTypeMasks
ShowTypeMasks
Constants for whatToShow.
Definition DOMNodeFilter.hpp:177
DOMNodeFilter::SHOW_DOCUMENT_TYPE
@ SHOW_DOCUMENT_TYPE
Definition DOMNodeFilter.hpp:188
DOMNodeFilter::SHOW_ALL
@ SHOW_ALL
Definition DOMNodeFilter.hpp:178
DOMNodeFilter::SHOW_NOTATION
@ SHOW_NOTATION
Definition DOMNodeFilter.hpp:190
DOMNodeFilter::SHOW_ENTITY_REFERENCE
@ SHOW_ENTITY_REFERENCE
Definition DOMNodeFilter.hpp:183
DOMNodeFilter::SHOW_TEXT
@ SHOW_TEXT
Definition DOMNodeFilter.hpp:181
DOMNodeFilter::SHOW_CDATA_SECTION
@ SHOW_CDATA_SECTION
Definition DOMNodeFilter.hpp:182
DOMNodeFilter::SHOW_COMMENT
@ SHOW_COMMENT
Definition DOMNodeFilter.hpp:186
DOMNodeFilter::SHOW_ATTRIBUTE
@ SHOW_ATTRIBUTE
Definition DOMNodeFilter.hpp:180
DOMNodeFilter::SHOW_ENTITY
@ SHOW_ENTITY
Definition DOMNodeFilter.hpp:184
DOMNodeFilter::SHOW_ELEMENT
@ SHOW_ELEMENT
Definition DOMNodeFilter.hpp:179
DOMNodeFilter::SHOW_DOCUMENT_FRAGMENT
@ SHOW_DOCUMENT_FRAGMENT
Definition DOMNodeFilter.hpp:189
DOMNodeFilter::SHOW_DOCUMENT
@ SHOW_DOCUMENT
Definition DOMNodeFilter.hpp:187
DOMNodeFilter::SHOW_PROCESSING_INSTRUCTION
@ SHOW_PROCESSING_INSTRUCTION
Definition DOMNodeFilter.hpp:185
DOMNode
The DOMNode interface is the primary datatype for the entire Document Object Model.
Definition DOMNode.hpp:139