Main Page   Class Hierarchy   Compound List   File List   Compound Members  

IDOM_CharacterData Class Reference

Inheritance diagram for IDOM_CharacterData:

IDOM_Node IDOM_Comment IDOM_Text IDOM_CDATASection List of all members.

Public Methods

Destructor.
virtual ~IDOM_CharacterData ()
Getter functions.
virtual const XMLCh * getData () const=0
virtual unsigned int getLength () const=0
virtual const XMLCh * substringData (unsigned int offset, unsigned int count) const=0
Functions that set or change data.
virtual void appendData (const XMLCh *arg)=0
virtual void insertData (unsigned int offset, const XMLCh *arg)=0
virtual void deleteData (unsigned int offset, unsigned int count)=0
virtual void replaceData (unsigned int offset, unsigned int count, const XMLCh *arg)=0
virtual void setData (const XMLCh *data)=0

Protected Methods

 IDOM_CharacterData (const IDOM_CharacterData &other)
IDOM_CharacterData & operator= (const IDOM_CharacterData &other)

Detailed Description

The IDOM_CharacterData interface extends Node with a set of methods for accessing character data in the DOM.

For clarity this set is defined here rather than on each class that uses these 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, and index in terms of Unicode 16 bit storage units.

Constructor & Destructor Documentation

virtual IDOM_CharacterData::~IDOM_CharacterData (    )  [inline, virtual]
 

Destructor for IDOM_CharacterData. The object being destroyed is the reference to the Character Data node, not the character data itself.

Member Function Documentation

virtual void IDOM_CharacterData::appendData (  const XMLCh *    arg )  [pure virtual]
 

Append the string to the end of the character data of the node.

Upon success, data provides access to the concatenation of data and the XMLCh* String specified.

Parameters:
arg The XMLCh* String to append.
Exceptions:
DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

virtual void IDOM_CharacterData::deleteData (  unsigned int    offset,
unsigned int    count
)  [pure virtual]
 

Remove a range of characters from the node.

Upon success, data and length reflect the change.

Parameters:
offset The offset from which to remove characters.
count The number of characters to delete. If the sum of offset and count exceeds length then all characters from offset to the end of the data are deleted.
Exceptions:
DOMException INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of characters in data, or if the specified count is negative.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

virtual const XMLCh* IDOM_CharacterData::getData (    )  const [pure virtual]
 

Returns the character data of the node that implements this interface.

The DOM implementation may not put arbitrary limits on the amount of data that may be stored in a CharacterData node. However, implementation limits may mean that the entirety of a node's data may not fit into a single XMLCh* String. In such cases, the user may call substringData to retrieve the data in appropriately sized pieces.

Exceptions:
DOMException NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

virtual unsigned int IDOM_CharacterData::getLength (    )  const [pure virtual]
 

Returns the number of characters that are available through data and the substringData method below.

This may have the value zero, i.e., CharacterData nodes may be empty.

virtual void IDOM_CharacterData::insertData (  unsigned int    offset,
const XMLCh *    arg
)  [pure virtual]
 

Insert a string at the specified character offset.

Parameters:
offset The character offset at which to insert.
arg The XMLCh* String to insert.
Exceptions:
DOMException INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of characters in data.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

virtual void IDOM_CharacterData::replaceData (  unsigned int    offset,
unsigned int    count,
const XMLCh *    arg
)  [pure virtual]
 

Replace the characters starting at the specified character offset with the specified string.

Parameters:
offset The offset from which to start replacing.
count The number of characters to replace. If the sum of offset and count exceeds length , then all characters to the end of the data are replaced (i.e., the effect is the same as a remove method call with the same range, followed by an append method invocation).
arg The XMLCh* String with which the range must be replaced.
Exceptions:
DOMException INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of characters in data, or if the specified count is negative.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

virtual void IDOM_CharacterData::setData (  const XMLCh *    data )  [pure virtual]
 

Sets the character data of the node that implements this interface.

Parameters:
data The XMLCh* String to set.

virtual const XMLCh* IDOM_CharacterData::substringData (  unsigned int    offset,
unsigned int    count
)  const [pure virtual]
 

Extracts a range of data from the node.

Parameters:
offset Start offset of substring to extract.
count The number of characters to extract.
Returns:
The specified substring. If the sum of offset and count exceeds the length, then all characters to the end of the data are returned.
Exceptions:
DOMException INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of characters in data, or if the specified count is negative.

The documentation for this class was generated from the following file:
Generated on Tue Nov 19 09:36:41 2002 by doxygen1.3-rc1