File: Poco.XML.CharacterData.html

package info (click to toggle)
poco-doc 1.3.6-1
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, squeeze, stretch, wheezy
  • size: 10,076 kB
  • ctags: 9,611
  • sloc: makefile: 31
file content (122 lines) | stat: -rw-r--r-- 15,847 bytes parent folder | download | duplicates (2)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Class Poco::XML::CharacterData</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="language" content="en"/>
<meta name="date" content="2009-11-24"/>
<meta name="generator" content="PocoDoc"/>
<link rel="stylesheet" href="css/styles.css" type="text/css"/>
</head>
<body bgcolor="#ffffff" leftmargin="0" topmargin="0">
<div class="header">
<h1 class="namespace"><a href="Poco.XML.html" class="namespace">Poco::XML</a></h1>
<h1 class="symbol">class CharacterData</h1>
</div>
<div class="body">
<p>
<b>Library:</b> XML<br />
<b>Package:</b> DOM<br />
<b>Header:</b> Poco/DOM/CharacterData.h</p>
<h2>Description</h2>
<div class="description">
<p>The <a href="Poco.XML.CharacterData.html" title="class Poco::XML::CharacterData">CharacterData</a> interface extends <a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a> 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 <a href="Poco.XML.CharacterData.html" title="class Poco::XML::CharacterData">CharacterData</a>, though <a href="Poco.XML.Text.html" title="class Poco::XML::Text">Text</a> and others do inherit the interface from it. All offsets in this interface start from 0. </p>
<p><a href="Poco.XML.Text.html" title="class Poco::XML::Text">Text</a> 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 <a href="Poco.XML.html#19840" title="Poco::XML::XMLChar">XMLChar</a> units. </p>
</div>
<h2>Inheritance</h2>
<p><b>Direct Base Classes: </b><a href="Poco.XML.AbstractNode.html" title="class Poco::XML::AbstractNode">AbstractNode</a></p>
<p><b>All Base Classes: </b><a href="Poco.XML.AbstractNode.html" title="class Poco::XML::AbstractNode">AbstractNode</a>, <a href="Poco.XML.DOMObject.html" title="class Poco::XML::DOMObject">DOMObject</a>, <a href="Poco.XML.EventTarget.html" title="class Poco::XML::EventTarget">EventTarget</a>, <a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a></p>
<p><b>Known Derived Classes: </b><a href="Poco.XML.CDATASection.html" title="class Poco::XML::CDATASection">CDATASection</a>, <a href="Poco.XML.Comment.html" title="class Poco::XML::Comment">Comment</a>, <a href="Poco.XML.Text.html" title="class Poco::XML::Text">Text</a></p>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.XML.CharacterData.html#17696" title="Poco::XML::CharacterData::appendData()">appendData</a>, <a href="Poco.XML.CharacterData.html#17688" title="Poco::XML::CharacterData::data()">data</a>, <a href="Poco.XML.CharacterData.html#17701" title="Poco::XML::CharacterData::deleteData()">deleteData</a>, <a href="Poco.XML.CharacterData.html#17689" title="Poco::XML::CharacterData::getData()">getData</a>, <a href="Poco.XML.CharacterData.html#17709" title="Poco::XML::CharacterData::getNodeValue()">getNodeValue</a>, <a href="Poco.XML.CharacterData.html#17698" title="Poco::XML::CharacterData::insertData()">insertData</a>, <a href="Poco.XML.CharacterData.html#17692" title="Poco::XML::CharacterData::length()">length</a>, <a href="Poco.XML.CharacterData.html#17704" title="Poco::XML::CharacterData::replaceData()">replaceData</a>, <a href="Poco.XML.CharacterData.html#17690" title="Poco::XML::CharacterData::setData()">setData</a>, <a href="Poco.XML.CharacterData.html#17710" title="Poco::XML::CharacterData::setNodeValue()">setNodeValue</a>, <a href="Poco.XML.CharacterData.html#17693" title="Poco::XML::CharacterData::substringData()">substringData</a>, <a href="Poco.XML.CharacterData.html#17708" title="Poco::XML::CharacterData::trimmedData()">trimmedData</a></p>
<p><b>Inherited Functions: </b><a href="Poco.XML.AbstractNode.html#17561" title="Poco::XML::AbstractNode::addEventListener()">addEventListener</a>, <a href="Poco.XML.AbstractNode.html#17548" title="Poco::XML::AbstractNode::appendChild()">appendChild</a>, <a href="Poco.XML.AbstractNode.html#17538" title="Poco::XML::AbstractNode::attributes()">attributes</a>, <a href="Poco.XML.AbstractNode.html#17572" title="Poco::XML::AbstractNode::autoRelease()">autoRelease</a>, <a href="Poco.XML.AbstractNode.html#17586" title="Poco::XML::AbstractNode::bubbleEvent()">bubbleEvent</a>, <a href="Poco.XML.AbstractNode.html#17584" title="Poco::XML::AbstractNode::captureEvent()">captureEvent</a>, <a href="Poco.XML.AbstractNode.html#17533" title="Poco::XML::AbstractNode::childNodes()">childNodes</a>, <a href="Poco.XML.AbstractNode.html#17551" title="Poco::XML::AbstractNode::cloneNode()">cloneNode</a>, <a href="Poco.XML.AbstractNode.html#17579" title="Poco::XML::AbstractNode::copyNode()">copyNode</a>, <a href="Poco.XML.AbstractNode.html#17593" title="Poco::XML::AbstractNode::dispatchAttrModified()">dispatchAttrModified</a>, <a href="Poco.XML.AbstractNode.html#17598" title="Poco::XML::AbstractNode::dispatchCharacterDataModified()">dispatchCharacterDataModified</a>, <a href="Poco.XML.AbstractNode.html#17569" title="Poco::XML::AbstractNode::dispatchEvent()">dispatchEvent</a>, <a href="Poco.XML.AbstractNode.html#17589" title="Poco::XML::AbstractNode::dispatchNodeInserted()">dispatchNodeInserted</a>, <a href="Poco.XML.AbstractNode.html#17592" title="Poco::XML::AbstractNode::dispatchNodeInsertedIntoDocument()">dispatchNodeInsertedIntoDocument</a>, <a href="Poco.XML.AbstractNode.html#17590" title="Poco::XML::AbstractNode::dispatchNodeRemoved()">dispatchNodeRemoved</a>, <a href="Poco.XML.AbstractNode.html#17591" title="Poco::XML::AbstractNode::dispatchNodeRemovedFromDocument()">dispatchNodeRemovedFromDocument</a>, <a href="Poco.XML.AbstractNode.html#17588" title="Poco::XML::AbstractNode::dispatchSubtreeModified()">dispatchSubtreeModified</a>, <a href="Poco.XML.DOMObject.html#17881" title="Poco::XML::DOMObject::duplicate()">duplicate</a>, <a href="Poco.XML.AbstractNode.html#17582" title="Poco::XML::AbstractNode::events()">events</a>, <a href="Poco.XML.AbstractNode.html#17583" title="Poco::XML::AbstractNode::eventsSuspended()">eventsSuspended</a>, <a href="Poco.XML.AbstractNode.html#17534" title="Poco::XML::AbstractNode::firstChild()">firstChild</a>, <a href="Poco.XML.AbstractNode.html#17529" title="Poco::XML::AbstractNode::getNodeValue()">getNodeValue</a>, <a href="Poco.XML.AbstractNode.html#17560" title="Poco::XML::AbstractNode::hasAttributes()">hasAttributes</a>, <a href="Poco.XML.AbstractNode.html#17550" title="Poco::XML::AbstractNode::hasChildNodes()">hasChildNodes</a>, <a href="Poco.XML.AbstractNode.html#17571" title="Poco::XML::AbstractNode::innerText()">innerText</a>, <a href="Poco.XML.AbstractNode.html#17540" title="Poco::XML::AbstractNode::insertBefore()">insertBefore</a>, <a href="Poco.XML.AbstractNode.html#17554" title="Poco::XML::AbstractNode::isSupported()">isSupported</a>, <a href="Poco.XML.AbstractNode.html#17535" title="Poco::XML::AbstractNode::lastChild()">lastChild</a>, <a href="Poco.XML.AbstractNode.html#17559" title="Poco::XML::AbstractNode::localName()">localName</a>, <a href="Poco.XML.AbstractNode.html#17557" title="Poco::XML::AbstractNode::namespaceURI()">namespaceURI</a>, <a href="Poco.XML.AbstractNode.html#17537" title="Poco::XML::AbstractNode::nextSibling()">nextSibling</a>, <a href="Poco.XML.AbstractNode.html#17528" title="Poco::XML::AbstractNode::nodeName()">nodeName</a>, <a href="Poco.XML.Node.html#18504" title="Poco::XML::Node::nodeType()">nodeType</a>, <a href="Poco.XML.Node.html#18500" title="Poco::XML::Node::nodeValue()">nodeValue</a>, <a href="Poco.XML.AbstractNode.html#17553" title="Poco::XML::AbstractNode::normalize()">normalize</a>, <a href="Poco.XML.AbstractNode.html#17539" title="Poco::XML::AbstractNode::ownerDocument()">ownerDocument</a>, <a href="Poco.XML.AbstractNode.html#17532" title="Poco::XML::AbstractNode::parentNode()">parentNode</a>, <a href="Poco.XML.AbstractNode.html#17558" title="Poco::XML::AbstractNode::prefix()">prefix</a>, <a href="Poco.XML.AbstractNode.html#17536" title="Poco::XML::AbstractNode::previousSibling()">previousSibling</a>, <a href="Poco.XML.DOMObject.html#17882" title="Poco::XML::DOMObject::release()">release</a>, <a href="Poco.XML.AbstractNode.html#17546" title="Poco::XML::AbstractNode::removeChild()">removeChild</a>, <a href="Poco.XML.AbstractNode.html#17565" title="Poco::XML::AbstractNode::removeEventListener()">removeEventListener</a>, <a href="Poco.XML.AbstractNode.html#17543" title="Poco::XML::AbstractNode::replaceChild()">replaceChild</a>, <a href="Poco.XML.AbstractNode.html#17530" title="Poco::XML::AbstractNode::setNodeValue()">setNodeValue</a>, <a href="Poco.XML.AbstractNode.html#17601" title="Poco::XML::AbstractNode::setOwnerDocument()">setOwnerDocument</a></p>
<h2>Constructors</h2>
<h3><a name="17712">CharacterData</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.XML.CharacterData.html" title="class Poco::XML::CharacterData">CharacterData</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a> * pOwnerDocument,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; data<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="17715">CharacterData</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.XML.CharacterData.html" title="class Poco::XML::CharacterData">CharacterData</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a> * pOwnerDocument,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.CharacterData.html" title="class Poco::XML::CharacterData">CharacterData</a> &amp; data<br />);</p>
<div class="description">
<p></p>
</div>
<h2>Destructor</h2>
<h3><a name="17718">~CharacterData</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" />  <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">~<a href="Poco.XML.CharacterData.html" title="class Poco::XML::CharacterData">CharacterData</a>();</p>
<div class="description">
<p></p>
</div>
<h2>Member Functions</h2>
<h3><a name="17696">appendData</a></h3>
<p class="decl">void appendData(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; arg<br />);</p>
<div class="description">
<p>Append the string to the end of the character data of the node. </p>
</div>
<h3><a name="17688">data</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; data() const;</p>
<div class="description">
<p>Returns the character data of the node that  implements the interface. </p>
</div>
<h3><a name="17701">deleteData</a></h3>
<p class="decl">void deleteData(<br />&nbsp;&nbsp;&nbsp;&nbsp;unsigned long offset,<br />&nbsp;&nbsp;&nbsp;&nbsp;unsigned long count<br />);</p>
<div class="description">
<p>Remove a range of characters from the node. </p>
</div>
<h3><a name="17689">getData</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; getData() const;</p>
<div class="description">
<p>Returns the character data of the node that  implements the interface. </p>
</div>
<h3><a name="17709">getNodeValue</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; getNodeValue() const;</p>
<div class="description">
<p></p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.XML.AbstractNode.html#17529" title="Poco::XML::AbstractNode::getNodeValue()">Poco::XML::AbstractNode::getNodeValue()</a></p></div>
<h3><a name="17698">insertData</a></h3>
<p class="decl">void insertData(<br />&nbsp;&nbsp;&nbsp;&nbsp;unsigned long offset,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; arg<br />);</p>
<div class="description">
<p>Insert a string at the specified character offset. </p>
</div>
<h3><a name="17692">length</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">unsigned long length() const;</p>
<div class="description">
<p>Returns the number of XMLChars that are available through getData and substringData. This may have the value zero. </p>
</div>
<h3><a name="17704">replaceData</a></h3>
<p class="decl">void replaceData(<br />&nbsp;&nbsp;&nbsp;&nbsp;unsigned long offset,<br />&nbsp;&nbsp;&nbsp;&nbsp;unsigned long count,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; arg<br />);</p>
<div class="description">
<p>Replace the characters starting at the specified character offset with the specified string. </p>
</div>
<h3><a name="17690">setData</a></h3>
<p class="decl">void setData(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; data<br />);</p>
<div class="description">
<p>Sets the character data of the node that implements the interface. </p>
</div>
<h3><a name="17710">setNodeValue</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void setNodeValue(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; value<br />);</p>
<div class="description">
<p></p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.XML.AbstractNode.html#17530" title="Poco::XML::AbstractNode::setNodeValue()">Poco::XML::AbstractNode::setNodeValue()</a></p></div>
<h3><a name="17693">substringData</a></h3>
<p class="decl"><a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> substringData(<br />&nbsp;&nbsp;&nbsp;&nbsp;unsigned long offset,<br />&nbsp;&nbsp;&nbsp;&nbsp;unsigned long count<br />) const;</p>
<div class="description">
<p>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. </p>
</div>
<h3><a name="17708">trimmedData</a></h3>
<p class="decl"><a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> trimmedData() const;</p>
<div class="description">
<p>Returns the character data of that node with all surrounding whitespace removed. </p>
<p>This method is an extension to the W3C <a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a> Object Model. </p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright &copy; 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>

</div>
</body>
</html>