class DOM_CharacterData : public DOM_Node

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

Inheritance:

Public

	Constructors and assignment operator DOM_CharacterData () Default constructor for DOM_CharacterData DOM_CharacterData (const DOM_CharacterData &other) Copy constructor DOM_CharacterData& operator = (const DOM_CharacterData &other) Assignment operator
	Destructor. ~DOM_CharacterData () Destructor for DOM_CharacterData DOM_CharacterData& operator = (const DOM_NullPtr *val) Assignment operator
	Functions that set or change data. void appendData (const DOMString &arg) Append the string to the end of the character data of the node void insertData (int offset, const DOMString &arg) Insert a string at the specified character offset void deleteData (int offset, int count) Remove a range of characters from the node void replaceData (int offset, int count, const DOMString &arg) Replace the characters starting at the specified character offset with the specified string void setData (const DOMString &data) Sets the character data of the node that implements this interface
	Getter functions. DOMString getData () const Returns the character data of the node that implements this interface int getLength () const Returns the number of characters that are available through data and the substringData method below DOMString substringData (int offset, int count) const Extracts a range of data from the node

Inherited from DOM_Node:

Public

Cloning function.

DOM_Node cloneNode(bool deep) const

Returns a duplicate of this node

Constructors and assignment operators

DOM_Node()

Default constructor for DOM_Node

DOM_Node(const DOM_Node &other)

Copy constructor

DOM_Node& operator = (const DOM_Node &other)

Assignment operator

DOM_Node& operator = (const DOM_NullPtr *val)

Assignment operator

Equality and Inequality operators.

bool operator == (const DOM_Node & other) const

The equality operator

bool operator == (const DOM_NullPtr *other) const

Compare with a pointer

bool operator != (const DOM_Node & other) const

The inequality operator

bool operator != (const DOM_NullPtr * other) const

Compare with a pointer

Functions introduced in DOM Level 2.

bool supports(const DOMString &feature, const DOMString &version) const

Tests whether the DOM implementation implements a specific feature and that feature is supported by this node

DOMString getNamespaceURI() const

Get the namespace URI of this node, or null if it is unspecified

DOMString getPrefix() const

Get the namespace prefix of this node, or null if it is unspecified

DOMString getLocalName() const

Returns the local part of the qualified name of this node

void setPrefix(const DOMString &prefix)

Get the namespace prefix of this node

Functions to modify the DOM Node.

DOM_Node insertBefore(const DOM_Node &newChild, const DOM_Node &refChild)

Inserts the node newChild before the existing child node refChild

DOM_Node replaceChild(const DOM_Node &newChild, const DOM_Node &oldChild)

Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node

DOM_Node removeChild(const DOM_Node &oldChild)

Removes the child node indicated by oldChild from the list of children, and returns it

DOM_Node appendChild(const DOM_Node &newChild)

Adds the node newChild to the end of the list of children of this node

Get functions.

DOMString getNodeName() const

The name of this node, depending on its type; see the table above

DOMString getNodeValue() const

Gets the value of this node, depending on its type

short getNodeType() const

An enum value representing the type of the underlying object

DOM_Node getParentNode() const

Gets the parent of this node

DOM_NodeList getChildNodes() const

Gets a NodeList that contains all children of this node

DOM_Node getFirstChild() const

Gets the first child of this node

DOM_Node getLastChild() const

Gets the last child of this node

DOM_Node getPreviousSibling() const

Gets the node immediately preceding this node

DOM_Node getNextSibling() const

Gets the node immediately following this node

DOM_NamedNodeMap getAttributes() const

Gets a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise

DOM_Document getOwnerDocument() const

Gets the Document object associated with this node

void* getUserData() const

Return the user data pointer

Query functions.

bool hasChildNodes() const

This is a convenience method to allow easy determination of whether a node has any children

bool isNull() const

Test whether this node is null

Set functions.

void setNodeValue(const DOMString &nodeValue)

Sets the value of the node

void setUserData(void *p)

Set the user data for a node

Constructors and assignment operator

DOM_CharacterData()

Default constructor for DOM_CharacterData. While there can be no actual DOM nodes of type CharacterData, the C++ objects function more like reference variables, and instances of DOM_CharacterData can exist. They will be null when created by this constructor, and can then be assigned to refer to Text or CDATASection nodes.

DOM_CharacterData(const DOM_CharacterData &other)

Copy constructor

Parameters:

other - The object to be copied

DOM_CharacterData& operator = (const DOM_CharacterData &other)

Assignment operator

Parameters:

other - The object to be copied

Destructor.

~DOM_CharacterData()

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

DOM_CharacterData& operator = (const DOM_NullPtr *val)

Assignment operator. This overloaded variant is provided for the sole purpose of setting a DOM_Node reference variable to zero. Nulling out a reference variable in this way will decrement the reference count on the underlying Node object that the variable formerly referenced. This effect is normally obtained when reference variable goes out of scope, but zeroing them can be useful for global instances, or for local instances that will remain in scope for an extended time, when the storage belonging to the underlying node needs to be reclaimed.

Parameters:

val. - Only a value of 0, or null, is allowed.

Getter functions.

DOMString getData() const

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

Throws:

DOMException NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
DOMException DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

int getLength() const

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.

DOMString substringData(int offset, int count) const

Extracts a range of data from the node.

Throws:

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.
DOMSTRING_SIZE_ERR: Raised if the specified range of text does not fit into a DOMString.

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.

Parameters:

offset - Start offset of substring to extract.
count - The number of characters to extract.

Functions that set or change data.

void appendData(const DOMString &arg)

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.

Throws:

DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

Parameters:

arg - The DOMString to append.

void insertData(int offset, const DOMString &arg)

Insert a string at the specified character offset.

Throws:

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.

Parameters:

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

void deleteData(int offset, int count)

Remove a range of characters from the node. Upon success, data and length reflect the change.

Throws:

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.

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.

void replaceData(int offset, int count, const DOMString &arg)

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

Throws:

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.

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 DOMString with which the range must be replaced.

void setData(const DOMString &data)

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

Parameters:

data - The DOMString to set.

Direct child classes:

DOM_Text
DOM_Comment

alphabetic index hierarchy of classes