Xerces-C++: DOMUserDataHandler.hpp Source File

Xerces-C++ 3.3.0

DOMUserDataHandler.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_DOMUSERDATAHANDLER_HPP)
23#define XERCESC_INCLUDE_GUARD_DOMUSERDATAHANDLER_HPP
24
25#include <xercesc/util/XercesDefs.hpp>
26#include <xercesc/dom/DOMNode.hpp>
27
28 XERCES_CPP_NAMESPACE_BEGIN
29
40 class CDOM_EXPORT DOMUserDataHandler {
41protected:
42 // -----------------------------------------------------------------------
43 // Hidden constructors
44 // -----------------------------------------------------------------------
47 DOMUserDataHandler() {};
49
50private:
51 // -----------------------------------------------------------------------
52 // Unimplemented constructors and operators
53 // -----------------------------------------------------------------------
56 DOMUserDataHandler(const DOMUserDataHandler &);
57 DOMUserDataHandler & operator = (const DOMUserDataHandler &);
59
60public:
61 // -----------------------------------------------------------------------
62 // All constructors are hidden, just the destructor is available
63 // -----------------------------------------------------------------------
70 virtual ~DOMUserDataHandler() {};
72
73 // -----------------------------------------------------------------------
74 // Class Types
75 // -----------------------------------------------------------------------
98 enum DOMOperationType {
99 NODE_CLONED = 1,
100 NODE_IMPORTED = 2,
101 NODE_DELETED = 3,
102 NODE_RENAMED = 4,
103 NODE_ADOPTED = 5
104 };
106
107
108 // -----------------------------------------------------------------------
109 // Virtual DOMUserDataHandler interface
110 // -----------------------------------------------------------------------
127 virtual void handle(DOMOperationType operation,
128 const XMLCh* const key,
129 void* data,
130 const DOMNode* src,
131 DOMNode* dst) = 0;
132
134
135};
136
137 XERCES_CPP_NAMESPACE_END
138
139#endif
140
DOMNode.hpp
XercesDefs.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
XMLCh
char16_t XMLCh
Definition Xerces_autoconf_config.hpp:120
DOMNode
The DOMNode interface is the primary datatype for the entire Document Object Model.
Definition DOMNode.hpp:139
DOMUserDataHandler
When associating an object to a key on a node using setUserData the application can provide a handler...
Definition DOMUserDataHandler.hpp:40
DOMUserDataHandler::DOMOperationType
DOMOperationType
Operation Type.
Definition DOMUserDataHandler.hpp:98
DOMUserDataHandler::DOMUserDataHandler
DOMUserDataHandler()
Definition DOMUserDataHandler.hpp:47
DOMUserDataHandler::~DOMUserDataHandler
virtual ~DOMUserDataHandler()
Destructor.
Definition DOMUserDataHandler.hpp:70
DOMUserDataHandler::handle
virtual void handle(DOMOperationType operation, const XMLCh *const key, void *data, const DOMNode *src, DOMNode *dst)=0
This method is called whenever the node for which this handler is registered is imported or cloned.