Xerces-C++: DOMCharacterData.hpp Source File

Xerces-C++ 3.2.4

DOMCharacterData.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_DOMCHARACTERDATA_HPP)
23#define XERCESC_INCLUDE_GUARD_DOMCHARACTERDATA_HPP
24
25#include <xercesc/util/XercesDefs.hpp>
26#include <xercesc/dom/DOMNode.hpp>
27
28 XERCES_CPP_NAMESPACE_BEGIN
29
30
46 class CDOM_EXPORT DOMCharacterData: public DOMNode {
47protected:
48 // -----------------------------------------------------------------------
49 // Hidden constructors
50 // -----------------------------------------------------------------------
53 DOMCharacterData() {}
54 DOMCharacterData(const DOMCharacterData &other) : DOMNode(other) {}
56
57private:
58 // -----------------------------------------------------------------------
59 // Unimplemented constructors and operators
60 // -----------------------------------------------------------------------
63 DOMCharacterData & operator = (const DOMCharacterData &);
65
66public:
67 // -----------------------------------------------------------------------
68 // All constructors are hidden, just the destructor is available
69 // -----------------------------------------------------------------------
76 virtual ~DOMCharacterData() {};
78
79 // -----------------------------------------------------------------------
80 // Virtual DOMCharacterData interface
81 // -----------------------------------------------------------------------
84 // -----------------------------------------------------------------------
85 // Getter methods
86 // -----------------------------------------------------------------------
100 virtual const XMLCh * getData() const = 0;
101
110 virtual XMLSize_t getLength() const = 0;
111
126 virtual const XMLCh * substringData(XMLSize_t offset,
127 XMLSize_t count) const = 0;
128
129 // -----------------------------------------------------------------------
130 // String methods
131 // -----------------------------------------------------------------------
142 virtual void appendData(const XMLCh *arg) = 0;
143
155 virtual void insertData(XMLSize_t offset, const XMLCh *arg) = 0;
156
174 virtual void deleteData(XMLSize_t offset,
175 XMLSize_t count) = 0;
176
196 virtual void replaceData(XMLSize_t offset,
197 XMLSize_t count,
198 const XMLCh *arg) = 0;
199
206 virtual void setData(const XMLCh *data) = 0;
208
209};
210
211 XERCES_CPP_NAMESPACE_END
212
213#endif
214
215
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
uint16_t XMLCh
Definition: Xerces_autoconf_config.hpp:120
XMLSize_t
size_t XMLSize_t
Definition: Xerces_autoconf_config.hpp:112
DOMCharacterData
The DOMCharacterData interface extends DOMNode with a set of attributes and methods for accessing cha...
Definition: DOMCharacterData.hpp:46
DOMCharacterData::substringData
virtual const XMLCh * substringData(XMLSize_t offset, XMLSize_t count) const =0
Extracts a range of data from the node.
DOMCharacterData::~DOMCharacterData
virtual ~DOMCharacterData()
Destructor.
Definition: DOMCharacterData.hpp:76
DOMCharacterData::deleteData
virtual void deleteData(XMLSize_t offset, XMLSize_t count)=0
Remove a range of characters from the node.
DOMCharacterData::appendData
virtual void appendData(const XMLCh *arg)=0
Append the string to the end of the character data of the node.
DOMCharacterData::getData
virtual const XMLCh * getData() const =0
Returns the character data of the node that implements this interface.
DOMCharacterData::DOMCharacterData
DOMCharacterData(const DOMCharacterData &other)
Definition: DOMCharacterData.hpp:54
DOMCharacterData::replaceData
virtual void replaceData(XMLSize_t offset, XMLSize_t count, const XMLCh *arg)=0
Replace the characters starting at the specified character offset with the specified string.
DOMCharacterData::getLength
virtual XMLSize_t getLength() const =0
Returns the number of characters that are available through data and the substringData method below.
DOMCharacterData::insertData
virtual void insertData(XMLSize_t offset, const XMLCh *arg)=0
Insert a string at the specified character offset.
DOMCharacterData::setData
virtual void setData(const XMLCh *data)=0
Sets the character data of the node that implements this interface.
DOMCharacterData::DOMCharacterData
DOMCharacterData()
Definition: DOMCharacterData.hpp:53
DOMNode
The DOMNode interface is the primary datatype for the entire Document Object Model.
Definition: DOMNode.hpp:139