DOMCharacterData interface extends DOMNode 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
* DOMCharacterData, though DOMText and others do
* inherit the interface from it. All offsets in this interface
* start from 0.
* As 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. *
See also the Document Object Model (DOM) Level 2 Core Specification.
* @since DOM Level 1
*/
class CDOM_EXPORT DOMCharacterData: public DOMNode {
protected:
// -----------------------------------------------------------------------
// Hidden constructors
// -----------------------------------------------------------------------
/** @name Hidden constructors */
//@{
DOMCharacterData() {};
DOMCharacterData(const DOMCharacterData &) {};
DOMCharacterData & operator = (const DOMCharacterData &) {return *this;};
//@}
public:
// -----------------------------------------------------------------------
// All constructors are hidden, just the destructor is available
// -----------------------------------------------------------------------
/** @name Destructor */
//@{
/**
* Destructor
*
*/
virtual ~DOMCharacterData() {};
//@}
// -----------------------------------------------------------------------
// Virtual DOMCharacterData interface
// -----------------------------------------------------------------------
/** @name Functions introduced in DOM Level 1 */
//@{
// -----------------------------------------------------------------------
// Getter methods
// -----------------------------------------------------------------------
/**
* 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 DOMCharacterData 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.
* @exception DOMException
* NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
* @since DOM Level 1
*/
virtual const XMLCh * getData() const = 0;
/**
* 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.
* @since DOM Level 1
*/
virtual XMLSize_t getLength() const = 0;
/**
* Extracts a range of data from the node.
*
* @param offset Start offset of substring to extract.
* @param count The number of characters to extract.
* @return The specified substring. If the sum of offset and
* count exceeds the length, then all
* characters to the end of the data are returned.
* @exception 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.
* @since DOM Level 1
*/
virtual const XMLCh * substringData(XMLSize_t offset,
XMLSize_t count) const = 0;
// -----------------------------------------------------------------------
// String methods
// -----------------------------------------------------------------------
/**
* 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.
* @param arg The XMLCh* String to append.
* @exception DOMException
* NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
* @since DOM Level 1
*/
virtual void appendData(const XMLCh *arg) = 0;
/**
* Insert a string at the specified character offset.
*
* @param offset The character offset at which to insert.
* @param arg The XMLCh* String to insert.
* @exception 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.
* @since DOM Level 1
*/
virtual void insertData(XMLSize_t offset, const XMLCh *arg) = 0;
/**
* Remove a range of characters from the node.
*
* Upon success,
* data and length reflect the change.
* @param offset The offset from which to remove characters.
* @param 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.
* @exception 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.
* @since DOM Level 1
*/
virtual void deleteData(XMLSize_t offset,
XMLSize_t count) = 0;
/**
* Replace the characters starting at the specified character offset with
* the specified string.
*
* @param offset The offset from which to start replacing.
* @param 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).
* @param arg The XMLCh* String with which the range must be
* replaced.
* @exception 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.
* @since DOM Level 1
*/
virtual void replaceData(XMLSize_t offset,
XMLSize_t count,
const XMLCh *arg) = 0;
/**
* Sets the character data of the node that implements this interface.
*
* @param data The XMLCh* String to set.
* @since DOM Level 1
*/
virtual void setData(const XMLCh *data) = 0;
//@}
};
XERCES_CPP_NAMESPACE_END
#endif