aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/libs/poco/XML/include/Poco/DOM/CharacterData.h
blob: 29d73519b1d0b567809dd2da741b059bbb77abf8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
// 
// CharacterData.h 
// 
// Library: XML 
// Package: DOM 
// Module:  DOM 
// 
// Definition of the DOM CharacterData class. 
// 
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH. 
// and Contributors. 
// 
// SPDX-License-Identifier:	BSL-1.0 
// 
 
 
#ifndef DOM_CharacterData_INCLUDED 
#define DOM_CharacterData_INCLUDED 
 
 
#include "Poco/XML/XML.h" 
#include "Poco/DOM/AbstractNode.h" 
#include "Poco/XML/XMLString.h" 
 
 
namespace Poco { 
namespace XML { 
 
 
class XML_API CharacterData: public AbstractNode 
	/// The CharacterData interface extends Node with a set of attributes and methods 
	/// for accessing character data in the DOM. For clarity this set is defined 
	/// here rather than on each object that uses these attributes and methods. 
	/// No DOM objects correspond directly to CharacterData, though Text and others 
	/// do inherit the interface from it. All offsets in this interface start from 0. 
	///  
	/// Text strings in the DOM are represented in either UTF-8 (if XML_UNICODE_WCHAR_T is 
	/// not defined) or in UTF-16 (if XML_UNICODE_WCHAR_T is defined). 
	/// Indexing on character data is done in XMLChar units. 
{ 
public: 
	const XMLString& data() const; 
		/// Returns the character data of the node that  
		/// implements the interface. 
	 
	const XMLString& getData() const; 
		/// Returns the character data of the node that  
		/// implements the interface. 
 
	void setData(const XMLString& data); 
		/// Sets the character data of the node that 
		/// implements the interface. 
 
	unsigned long length() const; 
		/// Returns the number of XMLChars that are available 
		/// through getData and substringData. This may have the 
		/// value zero. 
 
	XMLString substringData(unsigned long offset, unsigned long count) const; 
		/// Extracts a range of data from the node. 
		/// If offset and count exceeds the length, then all 
		/// the characters to the end of the data are returned. 
 
	void appendData(const XMLString& arg); 
		/// Append the string to the end of the character data 
		/// of the node. 
 
	void insertData(unsigned long offset, const XMLString& arg); 
		/// Insert a string at the specified character offset. 
 
	void deleteData(unsigned long offset, unsigned long count); 
		/// Remove a range of characters from the node. 
 
	void replaceData(unsigned long offset, unsigned long count, const XMLString& arg); 
		/// Replace the characters starting at the specified character 
		/// offset with the specified string. 
 
	// Non-standard extensions 
	XMLString trimmedData() const; 
		/// Returns the character data of that node with 
		/// all surrounding whitespace removed. 
		/// 
		/// This method is an extension to the W3C Document Object Model. 
 
	// Node 
	const XMLString& getNodeValue() const; 
	void setNodeValue(const XMLString& value); 
 
protected: 
	CharacterData(Document* pOwnerDocument, const XMLString& data); 
	CharacterData(Document* pOwnerDocument, const CharacterData& data); 
	~CharacterData(); 
 
private: 
	XMLString _data; 
}; 
 
 
// 
// inlines 
// 
inline const XMLString& CharacterData::data() const 
{ 
	return _data; 
} 
 
 
inline const XMLString& CharacterData::getData() const 
{ 
	return _data; 
} 
 
 
inline unsigned long CharacterData::length() const 
{ 
	return (unsigned long) _data.length(); 
} 
 
 
} } // namespace Poco::XML 
 
 
#endif // DOM_CharacterData_INCLUDED