.TH "DOM::CharacterData" kde3 "11 Jun 2005" "Version Version 3.4.1" "khtml Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
DOM::CharacterData \- The \fC\fBCharacterData\fP\fP interface extends \fBNode\fP with a set of attributes and methods for accessing character data in the \fBDOM\fP.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <dom_text.h>\fP
.PP
Inherits \fBDOM::Node\fP.
.PP
Inherited by \fBDOM::Comment\fP, and \fBDOM::Text\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBCharacterData\fP (const \fBCharacterData\fP &other)"
.br
.ti -1c
.RI "\fBCharacterData\fP (const \fBNode\fP &other)"
.br
.ti -1c
.RI "\fBCharacterData\fP & \fBoperator=\fP (const \fBNode\fP &other)"
.br
.ti -1c
.RI "\fBCharacterData\fP & \fBoperator=\fP (const \fBCharacterData\fP &other)"
.br
.ti -1c
.RI "\fBDOMString\fP \fBdata\fP () const "
.br
.ti -1c
.RI "void \fBsetData\fP (const \fBDOMString\fP &)"
.br
.ti -1c
.RI "unsigned long \fBlength\fP () const "
.br
.ti -1c
.RI "\fBDOMString\fP \fBsubstringData\fP (const unsigned long offset, const unsigned long count)"
.br
.ti -1c
.RI "void \fBappendData\fP (const \fBDOMString\fP &arg)"
.br
.ti -1c
.RI "void \fBinsertData\fP (const unsigned long offset, const \fBDOMString\fP &arg)"
.br
.ti -1c
.RI "void \fBdeleteData\fP (const unsigned long offset, const unsigned long count)"
.br
.ti -1c
.RI "void \fBreplaceData\fP (const unsigned long offset, const unsigned long count, const \fBDOMString\fP &arg)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBCharacterData\fP (CharacterDataImpl *i)"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBCharacterDataImpl\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fC\fBCharacterData\fP\fP interface extends \fBNode\fP with a set of attributes and methods for accessing character data in the \fBDOM\fP. 

For clarity this set is defined here rather than on each object that uses these attributes and methods. No \fBDOM\fP objects correspond directly to \fC\fBCharacterData\fP\fP , though \fC\fBText\fP\fP and others do inherit the interface from it. All \fCoffset\fPs in this interface start from 0. 
.PP
Definition at line 49 of file dom_text.h.
.SH "Member Function Documentation"
.PP 
.SS "\fBDOMString\fP CharacterData::data () const"
.PP
The character data of the node that implements this interface. 
.PP
The \fBDOM\fP implementation may not put arbitrary limits on the amount of data that may be stored in a \fC\fBCharacterData\fP\fP node. However, implementation limits may mean that the entirety of a node's data may not fit into a single \fC\fBDOMString\fP\fP . In such cases, the user may call \fCsubstringData\fP to retrieve the data in appropriately sized pieces.
.PP
\fBExceptions:\fP
.RS 4
\fIDOMException\fP DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a \fC\fBDOMString\fP\fP variable on the implementation platform. 
.RE
.PP

.PP
Definition at line 64 of file dom_text.cpp.
.SS "void CharacterData::setData (const \fBDOMString\fP &)"
.PP
see data 
.PP
\fBExceptions:\fP
.RS 4
\fIDOMException\fP NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly. 
.RE
.PP

.PP
Definition at line 70 of file dom_text.cpp.
.SS "unsigned long CharacterData::length () const"
.PP
The number of characters that are available through \fCdata\fP and the \fCsubstringData\fP method below. 
.PP
This may have the value zero, i.e., \fC\fBCharacterData\fP\fP nodes may be empty. 
.PP
Definition at line 82 of file dom_text.cpp.
.PP
References DOM::DOMString::length().
.SS "\fBDOMString\fP CharacterData::substringData (const unsigned long offset, const unsigned long count)"
.PP
Extracts a range of data from the node. 
.PP
\fBParameters:\fP
.RS 4
\fIoffset\fP Start offset of substring to extract.
.br
\fIcount\fP The number of characters to extract.
.RE
.PP
\fBReturns:\fP
.RS 4
The specified substring. If the sum of \fCoffset\fP and \fCcount\fP exceeds the \fClength\fP , then all characters to the end of the data are returned.
.RE
.PP
\fBExceptions:\fP
.RS 4
\fIDOMException\fP INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of characters in \fCdata\fP , or if the specified \fCcount\fP is negative.
.RE
.PP
DOMSTRING_SIZE_ERR: Raised if the specified range of text does not fit into a \fC\fBDOMString\fP\fP . 
.PP
Definition at line 89 of file dom_text.cpp.
.SS "void CharacterData::appendData (const \fBDOMString\fP & arg)"
.PP
Append the string to the end of the character data of the node. 
.PP
Upon success, \fCdata\fP provides access to the concatenation of \fCdata\fP and the \fC\fBDOMString\fP\fP specified.
.PP
\fBParameters:\fP
.RS 4
\fIarg\fP The \fC\fBDOMString\fP\fP to append.
.RE
.PP
\fBReturns:\fP
.RS 4
.RE
.PP
\fBExceptions:\fP
.RS 4
\fIDOMException\fP NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. 
.RE
.PP

.PP
Definition at line 101 of file dom_text.cpp.
.SS "void CharacterData::insertData (const unsigned long offset, const \fBDOMString\fP & arg)"
.PP
Insert a string at the specified character offset. 
.PP
\fBParameters:\fP
.RS 4
\fIoffset\fP The character offset at which to insert.
.br
\fIarg\fP The \fC\fBDOMString\fP\fP to insert.
.RE
.PP
\fBReturns:\fP
.RS 4
.RE
.PP
\fBExceptions:\fP
.RS 4
\fIDOMException\fP INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of characters in \fCdata\fP .
.RE
.PP
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. 
.PP
Definition at line 112 of file dom_text.cpp.
.SS "void CharacterData::deleteData (const unsigned long offset, const unsigned long count)"
.PP
Remove a range of characters from the node. 
.PP
Upon success, \fCdata\fP and \fClength\fP reflect the change.
.PP
\fBParameters:\fP
.RS 4
\fIoffset\fP The offset from which to remove characters.
.br
\fIcount\fP The number of characters to delete. If the sum of \fCoffset\fP and \fCcount\fP exceeds \fClength\fP then all characters from \fCoffset\fP to the end of the data are deleted.
.RE
.PP
\fBReturns:\fP
.RS 4
.RE
.PP
\fBExceptions:\fP
.RS 4
\fIDOMException\fP INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of characters in \fCdata\fP , or if the specified \fCcount\fP is negative.
.RE
.PP
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. 
.PP
Definition at line 123 of file dom_text.cpp.
.SS "void CharacterData::replaceData (const unsigned long offset, const unsigned long count, const \fBDOMString\fP & arg)"
.PP
Replace the characters starting at the specified character offset with the specified string. 
.PP
\fBParameters:\fP
.RS 4
\fIoffset\fP The offset from which to start replacing.
.br
\fIcount\fP The number of characters to replace. If the sum of \fCoffset\fP and \fCcount\fP exceeds \fClength\fP , then all characters to the end of the data are replaced (i.e., the effect is the same as a \fCremove\fP method call with the same range, followed by an \fCappend\fP method invocation).
.br
\fIarg\fP The \fC\fBDOMString\fP\fP with which the range must be replaced.
.RE
.PP
\fBReturns:\fP
.RS 4
.RE
.PP
\fBExceptions:\fP
.RS 4
\fIDOMException\fP INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of characters in \fCdata\fP , or if the specified \fCcount\fP is negative.
.RE
.PP
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. 
.PP
Definition at line 134 of file dom_text.cpp.

.SH "Author"
.PP 
Generated automatically by Doxygen for khtml Library from the source code.
