GdomeCppSmartDOM::CharacterData

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.

As explained in the DOMString interface, 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 CharacterData is done in 16-bit units.

Inherits from

Node

Default Constructor

CharacterData(GdomeCharacterData* = 0)

Creates a smart pointer for the Gdome element whose pointer is passed as an argument. The user should never pass a non-null pointer to this constructor.

Copy and Cast Constructors

CharacterData(const CharacterData&)
CharacterData(const Node&)

These constructors can be used to copy a smart pointer or to downcast it. If the downcasting is not possible, the resulting smart pointer will be null.

Copy Operator

CharacterData& operator=(const CharacterData&)

Equality

bool operator==(const CharacterData&) const
bool operator!=(const CharacterData&) const

Two smart pointers are equal if they point to the same Gdome object.

Attributes

DOMString get_data(void) const
voidset_data(const DOMString& )

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 DOMString. In such cases, the user may call substringData to retrieve the data in appropriately sized pieces.

unsigned long get_length(void) const

The number of 16-bit units that are available through data and the substringData method below. This may have the value zero, i.e., CharacterData nodes may be empty.

Methods

DOMString substringData(const unsigned longoffset, const unsigned longcount)

Parameters:

offset: Start offset of substring to extract.
count: The number of 16-bit units to extract.

Description:

Extracts a range of data from the node.

Exceptions:

DOMException

INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data, or if the specified count is negative.

DOMSTRING_SIZE_ERR: Raised if the specified range of text does not fit into a DOMString.

void appendData(const DOMString& arg)

Parameters:

arg: The DOMString to append.

Description:

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 DOMString specified.

Exceptions:

DOMException: NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

void insertData(const unsigned longoffset, const DOMString& arg)

Parameters:

offset: The character offset at which to insert.
arg: The DOMString to insert.

Description:

Insert a string at the specified 16-bit unit offset.

Exceptions:

DOMException

INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data.

NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

void deleteData(const unsigned longoffset, const unsigned longcount)

Parameters:

offset: The offset from which to start removing.
count: The number of 16-bit units to delete. If the sum of offset and count exceeds length then all 16-bit units from offset to the end of the data are deleted.

Description:

Remove a range of 16-bit units from the node. Upon success, data and length reflect the change.

Exceptions:

DOMException

INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data, or if the specified count is negative.

NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

void replaceData(const unsigned longoffset, const unsigned longcount, const DOMString& arg)

Parameters:

offset: The offset from which to start replacing.
count: The number of 16-bit units to replace. If the sum of offset and count exceeds length, then all 16-bit units 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 DOMString with which the range must be replaced.

Description:

Replace the characters starting at the specified 16-bit unit offset with the specified string.

Exceptions:

DOMException

INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data, or if the specified count is negative.

NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

This file has been generated automatically on Tue Nov 27 17:13:14 EST 2001 as part of GMetaDOM. For more information see the home page of the project, or contact the main author: luca.padovani@cs.unibo.it.