source: NonGTP/Xerces/xerces/doc/html/apiDocs/classDOMCharacterData.html @ 358

Revision 358, 33.8 KB checked in by bittner, 19 years ago (diff)

xerces added
Line 
1<HTML><HEAD><SCRIPT language="JavaScript" src="../resources/script.js" type="text/javascript"></SCRIPT><TITLE>DOMCharacterData class Reference</TITLE><link href="XercesApi.css" rel="stylesheet" type="text/css"></HEAD><BODY alink="#ff0000" bgcolor="#ffffff" leftmargin="4" link="#0000ff" marginheight="4" marginwidth="4" text="#000000" topmargin="4" vlink="#0000aa"><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD align="left" height="60" rowspan="3" valign="top" width="135"><IMG border="0" height="60" hspace="0" src="../resources/logo.gif" vspace="0" width="135"></TD><TD align="left" colspan="4" height="5" valign="top" width="456"><IMG border="0" height="5" hspace="0" src="../resources/line.gif" vspace="0" width="456"></TD><TD align="left" height="60" rowspan="3" valign="top" width="29"><IMG border="0" height="60" hspace="0" src="../resources/right.gif" vspace="0" width="29"></TD></TR><TR><TD align="left" bgcolor="#0086b2" colspan="4" height="35" valign="top" width="456"><IMG alt="" border="0" height="35" hspace="0" src="../graphics/api-header.jpg" vspace="0" width="456"></TD></TR><TR><TD align="left" height="20" valign="top" width="168"><IMG border="0" height="20" hspace="0" src="../resources/bottom.gif" vspace="0" width="168"></TD><TD align="left" height="20" valign="top" width="96"><A href="http://xml.apache.org/" onMouseOut="rolloverOff('xml');" onMouseOver="rolloverOn('xml');" target="new"><IMG alt="http://xml.apache.org/" border="0" height="20" hspace="0" name="xml" onLoad="rolloverLoad('xml','../resources/button-xml-hi.gif','../resources/button-xml-lo.gif');" src="../resources/button-xml-lo.gif" vspace="0" width="96"></A></TD><TD align="left" height="20" valign="top" width="96"><A href="http://www.apache.org/" onMouseOut="rolloverOff('asf');" onMouseOver="rolloverOn('asf');" target="new"><IMG alt="http://www.apache.org/" border="0" height="20" hspace="0" name="asf" onLoad="rolloverLoad('asf','../resources/button-asf-hi.gif','../resources/button-asf-lo.gif');" src="../resources/button-asf-lo.gif" vspace="0" width="96"></A></TD><TD align="left" height="20" valign="top" width="96"><A href="http://www.w3.org/" onMouseOut="rolloverOff('w3c');" onMouseOver="rolloverOn('w3c');" target="new"><IMG alt="http://www.w3.org/" border="0" height="20" hspace="0" name="w3c" onLoad="rolloverLoad('w3c','../resources/button-w3c-hi.gif','../resources/button-w3c-lo.gif');" src="../resources/button-w3c-lo.gif" vspace="0" width="96"></A></TD></TR></TABLE><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD align="left" valign="top" width="120"><IMG border="0" height="14" hspace="0" src="../resources/join.gif" vspace="0" width="120"><BR>
2  <A href="../../index.html" onMouseOut="rolloverOff('side-ext-2');" onMouseOver="rolloverOn('side-ext-2');"><IMG alt="Home" border="0" height="12" hspace="0" name="side-ext-2" onLoad="rolloverLoad('side-ext-2','../graphics/ext-2-label-2.jpg','../graphics/ext-2-label-3.jpg');" src="../graphics/ext-2-label-3.jpg" vspace="0" width="120"></A><BR>
3
4  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
5
6  <A href="../index.html" onMouseOut="rolloverOff('side-index');" onMouseOver="rolloverOn('side-index');"><IMG alt="Readme" border="0" height="12" hspace="0" name="side-index" onLoad="rolloverLoad('side-index','../graphics/index-label-2.jpg','../graphics/index-label-3.jpg');" src="../graphics/index-label-3.jpg" vspace="0" width="120"></A><BR>
7  <A href="../releases.html" onMouseOut="rolloverOff('side-releases');" onMouseOver="rolloverOn('side-releases');"><IMG alt="Release Info" border="0" height="12" hspace="0" name="side-releases" onLoad="rolloverLoad('side-releases','../graphics/releases-label-2.jpg','../graphics/releases-label-3.jpg');" src="../graphics/releases-label-3.jpg" vspace="0" width="120"></A><BR>
8  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
9  <A href="../install.html" onMouseOut="rolloverOff('side-install');" onMouseOver="rolloverOn('side-install');"><IMG alt="Installation" border="0" height="12" hspace="0" name="side-install" onLoad="rolloverLoad('side-install','../graphics/install-label-2.jpg','../graphics/install-label-3.jpg');" src="../graphics/install-label-3.jpg" vspace="0" width="120"></A><BR>
10  <A href="http://xml.apache.org/dist/xerces-c/" onMouseOut="rolloverOff('side-ext-18');" onMouseOver="rolloverOn('side-ext-18');"><IMG alt="Download" border="0" height="12" hspace="0" name="side-ext-18" onLoad="rolloverLoad('side-ext-18','../graphics/ext-18-label-2.jpg','../graphics/ext-18-label-3.jpg');" src="../graphics/ext-18-label-3.jpg" vspace="0" width="120"></A><BR>
11  <A href="../build.html" onMouseOut="rolloverOff('side-build');" onMouseOver="rolloverOn('side-build');"><IMG alt="Build" border="0" height="12" hspace="0" name="side-build" onLoad="rolloverLoad('side-build','../graphics/build-label-2.jpg','../graphics/build-label-3.jpg');" src="../graphics/build-label-3.jpg" vspace="0" width="120"></A><BR>
12
13  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
14  <A href="../faqs.html" onMouseOut="rolloverOff('side-faqs');" onMouseOver="rolloverOn('side-faqs');"><IMG alt="FAQs" border="0" height="12" hspace="0" name="side-faqs" onLoad="rolloverLoad('side-faqs','../graphics/faqs-label-2.jpg','../graphics/faqs-label-3.jpg');" src="../graphics/faqs-label-3.jpg" vspace="0" width="120"></A><BR> 
15  <A href="../samples.html" onMouseOut="rolloverOff('side-samples');" onMouseOver="rolloverOn('side-samples');"><IMG alt="Samples" border="0" height="12" hspace="0" name="side-samples" onLoad="rolloverLoad('side-samples','../graphics/samples-label-2.jpg','../graphics/samples-label-3.jpg');" src="../graphics/samples-label-3.jpg" vspace="0" width="120"></A><BR>
16  <A href="../api.html" onMouseOut="rolloverOff('side-api');" onMouseOver="rolloverOn('side-api');"><IMG alt="API Docs" border="0" height="12" hspace="0" name="side-api" onLoad="rolloverLoad('side-api','../graphics/api-label-2.jpg','../graphics/api-label-3.jpg');" src="../graphics/api-label-3.jpg" vspace="0" width="120"></A><BR> 
17
18  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR> 
19  <A href="../ApacheDOMC++Binding.html" onMouseOut="rolloverOff('side-ext-68');" onMouseOver="rolloverOn('side-ext-68');"><IMG alt="DOM C++ Binding" border="0" height="12" hspace="0" name="side-ext-68" onLoad="rolloverLoad('side-ext-68','../graphics/ext-68-label-2.jpg','../graphics/ext-68-label-3.jpg');" src="../graphics/ext-68-label-3.jpg" vspace="0" width="120"></A><BR>
20
21  <A href="../program.html" onMouseOut="rolloverOff('side-program');" onMouseOver="rolloverOn('side-program');"><IMG alt="Programming" border="0" height="12" hspace="0" name="side-program" onLoad="rolloverLoad('side-program','../graphics/program-label-2.jpg','../graphics/program-label-3.jpg');" src="../graphics/program-label-3.jpg" vspace="0" width="120"></A><BR>
22  <A href="../migrate.html" onMouseOut="rolloverOff('side-migrate');" onMouseOver="rolloverOn('side-migrate');"><IMG alt="Migration Guide" border="0" height="12" hspace="0" name="side-migrate" onLoad="rolloverLoad('side-migrate','../graphics/migrate-label-2.jpg','../graphics/migrate-label-3.jpg');" src="../graphics/migrate-label-3.jpg" vspace="0" width="120"></A><BR>
23
24  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
25
26  <A href="../feedback.html" onMouseOut="rolloverOff('side-feedback');" onMouseOver="rolloverOn('side-feedback');"><IMG alt="Feedback" border="0" height="12" hspace="0" name="side-feedback" onLoad="rolloverLoad('side-feedback','../graphics/feedback-label-2.jpg','../graphics/feedback-label-3.jpg');" src="../graphics/feedback-label-3.jpg" vspace="0" width="120"></A><BR>
27  <A href="../bug-report.html" onMouseOut="rolloverOff('side-bug-report');" onMouseOver="rolloverOn('side-bug-report');"><IMG alt="Bug-Reporting" border="0" height="12" hspace="0" name="side-bug-report" onLoad="rolloverLoad('side-bug-report','../graphics/bug-report-label-2.jpg','../graphics/bug-report-label-3.jpg');" src="../graphics/bug-report-label-3.jpg" vspace="0" width="120"></A><BR> 
28  <A href="../pdf.html" onMouseOut="rolloverOff('side-pdf');" onMouseOver="rolloverOn('side-pdf');"><IMG alt="PDF Document" border="0" height="12" hspace="0" name="side-pdf" onLoad="rolloverLoad('side-pdf','../graphics/pdf-label-2.jpg','../graphics/pdf-label-3.jpg');" src="../graphics/pdf-label-3.jpg" vspace="0" width="120"></A><BR>
29
30  <IMG border="0" height="6" hspace="0" src="../resources/separator.gif" vspace="0" width="120"><BR>
31
32  <A href="http://xml.apache.org/websrc/cvsweb.cgi/xml-xerces/c/" onMouseOut="rolloverOff('side-ext-100');" onMouseOver="rolloverOn('side-ext-100');"><IMG alt="CVS Repository" border="0" height="12" hspace="0" name="side-ext-100" onLoad="rolloverLoad('side-ext-100','../graphics/ext-100-label-2.jpg','../graphics/ext-100-label-3.jpg');" src="../graphics/ext-100-label-3.jpg" vspace="0" width="120"></A><BR>
33
34  <A href="http://marc.theaimsgroup.com/?l=xerces-c-dev" onMouseOut="rolloverOff('side-ext-102');" onMouseOver="rolloverOn('side-ext-102');"><IMG alt="Mail Archive" border="0" height="12" hspace="0" name="side-ext-102" onLoad="rolloverLoad('side-ext-102','../graphics/ext-102-label-2.jpg','../graphics/ext-102-label-3.jpg');" src="../graphics/ext-102-label-3.jpg" vspace="0" width="120"></A><BR>
35
36
37<IMG border="0" height="14" hspace="0" src="../resources/close.gif" vspace="0" width="120"><BR></TD><TD align="left" valign="top" width="500"><TABLE border="0" cellpadding="3" cellspacing="0"><TR><TD>
38    <TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="#FFFFFF" colspan="2" width="494"><TABLE border="0" cellpadding="0" cellspacing="0" width="494"><TR><TD bgcolor="#039acc" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#039acc" height="1" width="492"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#039acc" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#0086b2" width="492"><FONT color="#ffffff" face="arial,helvetica,sanserif" size="+1"><IMG border="0" height="2" hspace="0" src="../resources/void.gif" vspace="0" width="2"><B>API Docs for SAX and DOM</B></FONT></TD><TD bgcolor="#017299" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR><TR><TD bgcolor="#0086b2" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD><TD bgcolor="#017299" height="1" width="492"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="492"></TD><TD bgcolor="#017299" height="1" width="1"><IMG border="0" height="1" hspace="0" src="../resources/void.gif" vspace="0" width="1"></TD></TR></TABLE></TD></TR><TR><TD width="10">&nbsp;</TD><TD width="484"><FONT color="#000000" face="arial,helvetica,sanserif">
39
40            <P>
41<!-- Generated by Doxygen 1.2.14 -->
42<center>
43<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
44<hr><h1>DOMCharacterData Class Reference</h1>The <code>DOMCharacterData</code> interface extends <a class="el" href="classDOMNode.html">DOMNode</a> with a set of attributes and methods for accessing character data in the DOM.
45<a href="#_details">More...</a>
46<p>
47Inheritance diagram for DOMCharacterData:<p><center><img src="classDOMCharacterData__inherit__graph.gif" border="0" usemap="#DOMCharacterData__inherit__map" alt="Inheritance graph"></center>
48<map name="DOMCharacterData__inherit__map">
49<area href="classDOMComment.html" shape="rect" coords="7,174,105,155" alt="">
50<area href="classDOMText.html" shape="rect" coords="129,174,199,155" alt="">
51<area href="classDOMNode.html" shape="rect" coords="73,35,145,17" alt="">
52<area href="classDOMCDATASection.html" shape="rect" coords="97,243,231,225" alt="">
53</map>
54<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for DOMCharacterData:<p><center><img src="classDOMCharacterData__coll__graph.gif" border="0" usemap="#DOMCharacterData__coll__map" alt="Collaboration graph"></center>
55<map name="DOMCharacterData__coll__map">
56<area href="classDOMNode.html" shape="rect" coords="36,36,108,17" alt="">
57</map>
58<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classDOMCharacterData-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
59<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
60<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
61<tr><td nowrap align=right valign=top>virtual&nbsp;</td><td valign=bottom><a class="el" href="classDOMCharacterData.html#z17_0">~DOMCharacterData</a> ()</td></tr>
62<tr><td>&nbsp;</td><td><font size=-1><em>Destructor.</em> <a href="#z17_0">More...</a><em></em></font><br><br></td></tr>
63<tr><td colspan="2"><div class="groupHeader">Functions introduced in DOM Level 1</div></td></tr>
64<tr><td nowrap align=right valign=top>virtual const XMLCh *&nbsp;</td><td valign=bottom><a class="el" href="classDOMCharacterData.html#z18_0">getData</a> () const=0</td></tr>
65<tr><td>&nbsp;</td><td><font size=-1><em>Returns the character data of the node that implements this interface.</em> <a href="#z18_0">More...</a><em></em></font><br><br></td></tr>
66<tr><td nowrap align=right valign=top>virtual XMLSize_t&nbsp;</td><td valign=bottom><a class="el" href="classDOMCharacterData.html#z18_1">getLength</a> () const=0</td></tr>
67<tr><td>&nbsp;</td><td><font size=-1><em>Returns the number of characters that are available through <code>data</code> and the <code>substringData</code> method below.</em> <a href="#z18_1">More...</a><em></em></font><br><br></td></tr>
68<tr><td nowrap align=right valign=top>virtual const XMLCh *&nbsp;</td><td valign=bottom><a class="el" href="classDOMCharacterData.html#z18_2">substringData</a> (XMLSize_t offset, XMLSize_t count) const=0</td></tr>
69<tr><td>&nbsp;</td><td><font size=-1><em>Extracts a range of data from the node.</em> <a href="#z18_2">More...</a><em></em></font><br><br></td></tr>
70<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDOMCharacterData.html#z18_3">appendData</a> (const XMLCh *arg)=0</td></tr>
71<tr><td>&nbsp;</td><td><font size=-1><em>Append the string to the end of the character data of the node.</em> <a href="#z18_3">More...</a><em></em></font><br><br></td></tr>
72<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDOMCharacterData.html#z18_4">insertData</a> (XMLSize_t offset, const XMLCh *arg)=0</td></tr>
73<tr><td>&nbsp;</td><td><font size=-1><em>Insert a string at the specified character offset.</em> <a href="#z18_4">More...</a><em></em></font><br><br></td></tr>
74<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDOMCharacterData.html#z18_5">deleteData</a> (XMLSize_t offset, XMLSize_t count)=0</td></tr>
75<tr><td>&nbsp;</td><td><font size=-1><em>Remove a range of characters from the node.</em> <a href="#z18_5">More...</a><em></em></font><br><br></td></tr>
76<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDOMCharacterData.html#z18_6">replaceData</a> (XMLSize_t offset, XMLSize_t count, const XMLCh *arg)=0</td></tr>
77<tr><td>&nbsp;</td><td><font size=-1><em>Replace the characters starting at the specified character offset with the specified string.</em> <a href="#z18_6">More...</a><em></em></font><br><br></td></tr>
78<tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classDOMCharacterData.html#z18_7">setData</a> (const XMLCh *data)=0</td></tr>
79<tr><td>&nbsp;</td><td><font size=-1><em>Sets the character data of the node that implements this interface.</em> <a href="#z18_7">More...</a><em></em></font><br><br></td></tr>
80<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
81<tr><td colspan="2"><div class="groupHeader">Hidden constructors</div></td></tr>
82<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classDOMCharacterData.html#z15_0">DOMCharacterData</a> ()</td></tr>
83</table>
84<hr><a name="_details"></a><h2>Detailed Description</h2>
85The <code>DOMCharacterData</code> interface extends <a class="el" href="classDOMNode.html">DOMNode</a> with a set of attributes and methods for accessing character data in the DOM.
86<p>
87For clarity this set is defined here rather than on each object that uses these attributes and methods. No DOM objects correspond directly to <code>DOMCharacterData</code>, though <code><a class="el" href="classDOMText.html">DOMText</a></code> and others do inherit the interface from it. All <code>offsets</code> in this interface start from <code>0</code>.
88<p>
89As explained in the DOM spec, text strings in the DOM are represented in UTF-16, i.e. as a sequence of 16-bit units. In the following, the term 16-bit units is used whenever necessary to indicate that indexing on DOMCharacterData is done in 16-bit units.
90<p>
91See also the <a href="http://www.w3.org/TR/2000/REC-DOM-Level-2-Core-20001113">Document Object Model (DOM) Level 2 Core Specification</a>. <dl compact><dt><b>
92Since: </b><dd>
93DOM Level 1 </dl>
94<p>
95<hr><h2>Constructor &amp; Destructor Documentation</h2>
96<a name="z15_0" doxytag="DOMCharacterData::DOMCharacterData"></a><p>
97<table width="100%" cellpadding="2" cellspacing="0" border="0">
98  <tr>
99    <td class="md">
100      <table cellpadding="0" cellspacing="0" border="0">
101        <tr>
102          <td class="md" nowrap valign="top"> DOMCharacterData::DOMCharacterData </td>
103          <td class="md" valign="top">(&nbsp;</td>
104          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
105          <td class="md" valign="top">)&nbsp;</td>
106          <td class="md" nowrap><code> [protected]</code></td>
107        </tr>
108
109      </table>
110    </td>
111  </tr>
112</table>
113<table cellspacing=5 cellpadding=0 border=0>
114  <tr>
115    <td>
116      &nbsp;
117    </td>
118    <td>
119
120<p>
121    </td>
122  </tr>
123</table>
124<a name="z17_0" doxytag="DOMCharacterData::~DOMCharacterData"></a><p>
125<table width="100%" cellpadding="2" cellspacing="0" border="0">
126  <tr>
127    <td class="md">
128      <table cellpadding="0" cellspacing="0" border="0">
129        <tr>
130          <td class="md" nowrap valign="top"> virtual DOMCharacterData::~DOMCharacterData </td>
131          <td class="md" valign="top">(&nbsp;</td>
132          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
133          <td class="md" valign="top">)&nbsp;</td>
134          <td class="md" nowrap><code> [virtual]</code></td>
135        </tr>
136
137      </table>
138    </td>
139  </tr>
140</table>
141<table cellspacing=5 cellpadding=0 border=0>
142  <tr>
143    <td>
144      &nbsp;
145    </td>
146    <td>
147
148<p>
149Destructor.
150<p>
151    </td>
152  </tr>
153</table>
154<hr><h2>Member Function Documentation</h2>
155<a name="z18_3" doxytag="DOMCharacterData::appendData"></a><p>
156<table width="100%" cellpadding="2" cellspacing="0" border="0">
157  <tr>
158    <td class="md">
159      <table cellpadding="0" cellspacing="0" border="0">
160        <tr>
161          <td class="md" nowrap valign="top"> virtual void DOMCharacterData::appendData </td>
162          <td class="md" valign="top">(&nbsp;</td>
163          <td class="md" nowrap valign="top">const XMLCh *&nbsp;</td>
164          <td class="mdname1" valign="top" nowrap>&nbsp; <em>arg</em>          </td>
165          <td class="md" valign="top">)&nbsp;</td>
166          <td class="md" nowrap><code> [pure virtual]</code></td>
167        </tr>
168
169      </table>
170    </td>
171  </tr>
172</table>
173<table cellspacing=5 cellpadding=0 border=0>
174  <tr>
175    <td>
176      &nbsp;
177    </td>
178    <td>
179
180<p>
181Append the string to the end of the character data of the node.
182<p>
183Upon success, <code>data</code> provides access to the concatenation of <code>data</code> and the <code>XMLCh* String</code> specified. <dl compact><dt><b>
184Parameters: </b><dd>
185<table border=0 cellspacing=2 cellpadding=0>
186<tr><td valign=top><em>arg</em>&nbsp;</td><td>
187The <code>XMLCh* String</code> to append. </td></tr>
188</table>
189</dl><dl compact><dt><b>
190Exceptions: </b><dd>
191<table border=0 cellspacing=2 cellpadding=0>
192<tr><td valign=top><em><a class="el" href="classDOMException.html">DOMException</a></em>&nbsp;</td><td>
193 NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. </td></tr>
194</table>
195</dl><dl compact><dt><b>
196Since: </b><dd>
197DOM Level 1 </dl>    </td>
198  </tr>
199</table>
200<a name="z18_5" doxytag="DOMCharacterData::deleteData"></a><p>
201<table width="100%" cellpadding="2" cellspacing="0" border="0">
202  <tr>
203    <td class="md">
204      <table cellpadding="0" cellspacing="0" border="0">
205        <tr>
206          <td class="md" nowrap valign="top"> virtual void DOMCharacterData::deleteData </td>
207          <td class="md" valign="top">(&nbsp;</td>
208          <td class="md" nowrap valign="top">XMLSize_t&nbsp;</td>
209          <td class="mdname" nowrap>&nbsp; <em>offset</em>, </td>
210        </tr>
211        <tr>
212          <td></td>
213          <td></td>
214          <td class="md" nowrap>XMLSize_t&nbsp;</td>
215          <td class="mdname" nowrap>&nbsp; <em>count</em></td>
216        </tr>
217        <tr>
218          <td></td>
219          <td class="md">)&nbsp;</td>
220          <td class="md" colspan="2"><code> [pure virtual]</code></td>
221        </tr>
222
223      </table>
224    </td>
225  </tr>
226</table>
227<table cellspacing=5 cellpadding=0 border=0>
228  <tr>
229    <td>
230      &nbsp;
231    </td>
232    <td>
233
234<p>
235Remove a range of characters from the node.
236<p>
237Upon success, <code>data</code> and <code>length</code> reflect the change. <dl compact><dt><b>
238Parameters: </b><dd>
239<table border=0 cellspacing=2 cellpadding=0>
240<tr><td valign=top><em>offset</em>&nbsp;</td><td>
241The offset from which to remove characters. </td></tr>
242<tr><td valign=top><em>count</em>&nbsp;</td><td>
243The number of characters to delete. If the sum of <code>offset</code> and <code>count</code> exceeds <code>length</code> then all characters from <code>offset</code> to the end of the data are deleted. </td></tr>
244</table>
245</dl><dl compact><dt><b>
246Exceptions: </b><dd>
247<table border=0 cellspacing=2 cellpadding=0>
248<tr><td valign=top><em><a class="el" href="classDOMException.html">DOMException</a></em>&nbsp;</td><td>
249 INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of characters in <code>data</code>, or if the specified <code>count</code> is negative. <br>
250NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. </td></tr>
251</table>
252</dl><dl compact><dt><b>
253Since: </b><dd>
254DOM Level 1 </dl>    </td>
255  </tr>
256</table>
257<a name="z18_0" doxytag="DOMCharacterData::getData"></a><p>
258<table width="100%" cellpadding="2" cellspacing="0" border="0">
259  <tr>
260    <td class="md">
261      <table cellpadding="0" cellspacing="0" border="0">
262        <tr>
263          <td class="md" nowrap valign="top"> virtual const XMLCh* DOMCharacterData::getData </td>
264          <td class="md" valign="top">(&nbsp;</td>
265          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
266          <td class="md" valign="top">)&nbsp;</td>
267          <td class="md" nowrap> const<code> [pure virtual]</code></td>
268        </tr>
269
270      </table>
271    </td>
272  </tr>
273</table>
274<table cellspacing=5 cellpadding=0 border=0>
275  <tr>
276    <td>
277      &nbsp;
278    </td>
279    <td>
280
281<p>
282Returns the character data of the node that implements this interface.
283<p>
284The DOM implementation may not put arbitrary limits on the amount of data that may be stored in a <code>DOMCharacterData</code> node. However, implementation limits may mean that the entirety of a node's data may not fit into a single <code>XMLCh* String</code>. In such cases, the user may call <code>substringData</code> to retrieve the data in appropriately sized pieces. <dl compact><dt><b>
285Exceptions: </b><dd>
286<table border=0 cellspacing=2 cellpadding=0>
287<tr><td valign=top><em><a class="el" href="classDOMException.html">DOMException</a></em>&nbsp;</td><td>
288 NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly. </td></tr>
289</table>
290</dl><dl compact><dt><b>
291Since: </b><dd>
292DOM Level 1 </dl>    </td>
293  </tr>
294</table>
295<a name="z18_1" doxytag="DOMCharacterData::getLength"></a><p>
296<table width="100%" cellpadding="2" cellspacing="0" border="0">
297  <tr>
298    <td class="md">
299      <table cellpadding="0" cellspacing="0" border="0">
300        <tr>
301          <td class="md" nowrap valign="top"> virtual XMLSize_t DOMCharacterData::getLength </td>
302          <td class="md" valign="top">(&nbsp;</td>
303          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
304          <td class="md" valign="top">)&nbsp;</td>
305          <td class="md" nowrap> const<code> [pure virtual]</code></td>
306        </tr>
307
308      </table>
309    </td>
310  </tr>
311</table>
312<table cellspacing=5 cellpadding=0 border=0>
313  <tr>
314    <td>
315      &nbsp;
316    </td>
317    <td>
318
319<p>
320Returns the number of characters that are available through <code>data</code> and the <code>substringData</code> method below.
321<p>
322This may have the value zero, i.e., <code>CharacterData</code> nodes may be empty. <dl compact><dt><b>
323Since: </b><dd>
324DOM Level 1 </dl>    </td>
325  </tr>
326</table>
327<a name="z18_4" doxytag="DOMCharacterData::insertData"></a><p>
328<table width="100%" cellpadding="2" cellspacing="0" border="0">
329  <tr>
330    <td class="md">
331      <table cellpadding="0" cellspacing="0" border="0">
332        <tr>
333          <td class="md" nowrap valign="top"> virtual void DOMCharacterData::insertData </td>
334          <td class="md" valign="top">(&nbsp;</td>
335          <td class="md" nowrap valign="top">XMLSize_t&nbsp;</td>
336          <td class="mdname" nowrap>&nbsp; <em>offset</em>, </td>
337        </tr>
338        <tr>
339          <td></td>
340          <td></td>
341          <td class="md" nowrap>const XMLCh *&nbsp;</td>
342          <td class="mdname" nowrap>&nbsp; <em>arg</em></td>
343        </tr>
344        <tr>
345          <td></td>
346          <td class="md">)&nbsp;</td>
347          <td class="md" colspan="2"><code> [pure virtual]</code></td>
348        </tr>
349
350      </table>
351    </td>
352  </tr>
353</table>
354<table cellspacing=5 cellpadding=0 border=0>
355  <tr>
356    <td>
357      &nbsp;
358    </td>
359    <td>
360
361<p>
362Insert a string at the specified character offset.
363<p>
364<dl compact><dt><b>
365Parameters: </b><dd>
366<table border=0 cellspacing=2 cellpadding=0>
367<tr><td valign=top><em>offset</em>&nbsp;</td><td>
368The character offset at which to insert. </td></tr>
369<tr><td valign=top><em>arg</em>&nbsp;</td><td>
370The <code>XMLCh* String</code> to insert. </td></tr>
371</table>
372</dl><dl compact><dt><b>
373Exceptions: </b><dd>
374<table border=0 cellspacing=2 cellpadding=0>
375<tr><td valign=top><em><a class="el" href="classDOMException.html">DOMException</a></em>&nbsp;</td><td>
376 INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of characters in <code>data</code>. <br>
377NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. </td></tr>
378</table>
379</dl><dl compact><dt><b>
380Since: </b><dd>
381DOM Level 1 </dl>    </td>
382  </tr>
383</table>
384<a name="z18_6" doxytag="DOMCharacterData::replaceData"></a><p>
385<table width="100%" cellpadding="2" cellspacing="0" border="0">
386  <tr>
387    <td class="md">
388      <table cellpadding="0" cellspacing="0" border="0">
389        <tr>
390          <td class="md" nowrap valign="top"> virtual void DOMCharacterData::replaceData </td>
391          <td class="md" valign="top">(&nbsp;</td>
392          <td class="md" nowrap valign="top">XMLSize_t&nbsp;</td>
393          <td class="mdname" nowrap>&nbsp; <em>offset</em>, </td>
394        </tr>
395        <tr>
396          <td></td>
397          <td></td>
398          <td class="md" nowrap>XMLSize_t&nbsp;</td>
399          <td class="mdname" nowrap>&nbsp; <em>count</em>, </td>
400        </tr>
401        <tr>
402          <td></td>
403          <td></td>
404          <td class="md" nowrap>const XMLCh *&nbsp;</td>
405          <td class="mdname" nowrap>&nbsp; <em>arg</em></td>
406        </tr>
407        <tr>
408          <td></td>
409          <td class="md">)&nbsp;</td>
410          <td class="md" colspan="2"><code> [pure virtual]</code></td>
411        </tr>
412
413      </table>
414    </td>
415  </tr>
416</table>
417<table cellspacing=5 cellpadding=0 border=0>
418  <tr>
419    <td>
420      &nbsp;
421    </td>
422    <td>
423
424<p>
425Replace the characters starting at the specified character offset with the specified string.
426<p>
427<dl compact><dt><b>
428Parameters: </b><dd>
429<table border=0 cellspacing=2 cellpadding=0>
430<tr><td valign=top><em>offset</em>&nbsp;</td><td>
431The offset from which to start replacing. </td></tr>
432<tr><td valign=top><em>count</em>&nbsp;</td><td>
433The number of characters to replace. If the sum of <code>offset</code> and <code>count</code> exceeds <code>length</code> , then all characters to the end of the data are replaced (i.e., the effect is the same as a <code>remove</code> method call with the same range, followed by an <code>append</code> method invocation). </td></tr>
434<tr><td valign=top><em>arg</em>&nbsp;</td><td>
435The <code>XMLCh* String</code> with which the range must be replaced. </td></tr>
436</table>
437</dl><dl compact><dt><b>
438Exceptions: </b><dd>
439<table border=0 cellspacing=2 cellpadding=0>
440<tr><td valign=top><em><a class="el" href="classDOMException.html">DOMException</a></em>&nbsp;</td><td>
441 INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of characters in <code>data</code>, or if the specified <code>count</code> is negative. <br>
442NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. </td></tr>
443</table>
444</dl><dl compact><dt><b>
445Since: </b><dd>
446DOM Level 1 </dl>    </td>
447  </tr>
448</table>
449<a name="z18_7" doxytag="DOMCharacterData::setData"></a><p>
450<table width="100%" cellpadding="2" cellspacing="0" border="0">
451  <tr>
452    <td class="md">
453      <table cellpadding="0" cellspacing="0" border="0">
454        <tr>
455          <td class="md" nowrap valign="top"> virtual void DOMCharacterData::setData </td>
456          <td class="md" valign="top">(&nbsp;</td>
457          <td class="md" nowrap valign="top">const XMLCh *&nbsp;</td>
458          <td class="mdname1" valign="top" nowrap>&nbsp; <em>data</em>          </td>
459          <td class="md" valign="top">)&nbsp;</td>
460          <td class="md" nowrap><code> [pure virtual]</code></td>
461        </tr>
462
463      </table>
464    </td>
465  </tr>
466</table>
467<table cellspacing=5 cellpadding=0 border=0>
468  <tr>
469    <td>
470      &nbsp;
471    </td>
472    <td>
473
474<p>
475Sets the character data of the node that implements this interface.
476<p>
477<dl compact><dt><b>
478Parameters: </b><dd>
479<table border=0 cellspacing=2 cellpadding=0>
480<tr><td valign=top><em>data</em>&nbsp;</td><td>
481The <code>XMLCh* String</code> to set. </td></tr>
482</table>
483</dl><dl compact><dt><b>
484Since: </b><dd>
485DOM Level 1 </dl>    </td>
486  </tr>
487</table>
488<a name="z18_2" doxytag="DOMCharacterData::substringData"></a><p>
489<table width="100%" cellpadding="2" cellspacing="0" border="0">
490  <tr>
491    <td class="md">
492      <table cellpadding="0" cellspacing="0" border="0">
493        <tr>
494          <td class="md" nowrap valign="top"> virtual const XMLCh* DOMCharacterData::substringData </td>
495          <td class="md" valign="top">(&nbsp;</td>
496          <td class="md" nowrap valign="top">XMLSize_t&nbsp;</td>
497          <td class="mdname" nowrap>&nbsp; <em>offset</em>, </td>
498        </tr>
499        <tr>
500          <td></td>
501          <td></td>
502          <td class="md" nowrap>XMLSize_t&nbsp;</td>
503          <td class="mdname" nowrap>&nbsp; <em>count</em></td>
504        </tr>
505        <tr>
506          <td></td>
507          <td class="md">)&nbsp;</td>
508          <td class="md" colspan="2"> const<code> [pure virtual]</code></td>
509        </tr>
510
511      </table>
512    </td>
513  </tr>
514</table>
515<table cellspacing=5 cellpadding=0 border=0>
516  <tr>
517    <td>
518      &nbsp;
519    </td>
520    <td>
521
522<p>
523Extracts a range of data from the node.
524<p>
525<dl compact><dt><b>
526Parameters: </b><dd>
527<table border=0 cellspacing=2 cellpadding=0>
528<tr><td valign=top><em>offset</em>&nbsp;</td><td>
529Start offset of substring to extract. </td></tr>
530<tr><td valign=top><em>count</em>&nbsp;</td><td>
531The number of characters to extract. </td></tr>
532</table>
533</dl><dl compact><dt><b>
534Returns: </b><dd>
535The specified substring. If the sum of <code>offset</code> and <code>count</code> exceeds the <code>length</code>, then all characters to the end of the data are returned. </dl><dl compact><dt><b>
536Exceptions: </b><dd>
537<table border=0 cellspacing=2 cellpadding=0>
538<tr><td valign=top><em><a class="el" href="classDOMException.html">DOMException</a></em>&nbsp;</td><td>
539 INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of characters in <code>data</code>, or if the specified <code>count</code> is negative. </td></tr>
540</table>
541</dl><dl compact><dt><b>
542Since: </b><dd>
543DOM Level 1 </dl>    </td>
544  </tr>
545</table>
546<hr>The documentation for this class was generated from the following file:<ul>
547<li><a class="el" href="DOMCharacterData_8hpp-source.html">DOMCharacterData.hpp</a></ul>
548    </FONT></TD></TR></TABLE><BR>
549</TD></TR></TABLE></TD></TR></TABLE><BR><TABLE border="0" cellpadding="0" cellspacing="0" width="620"><TR><TD bgcolor="#0086b2"><IMG height="1" src="images/dot.gif" width="1" alt=""></TD></TR><TR><TD align="center"><FONT color="#0086b2" size="-1"><I>
550              Copyright &copy; 1994-2004 The Apache Software Foundation.
551              All Rights Reserved.
552            </I></FONT></TD></TR></TABLE></BODY></HTML>
Note: See TracBrowser for help on using the repository browser.