Text interface represents the textual content (termed
* character data in XML) of an Element or Attr.
* If there is no markup inside an element's content, the text is contained
* in a single object implementing the Text interface that is
* the only child of the element. If there is markup, it is parsed into a
* list of elements and Text nodes that form the list of
* children of the element.
* When a document is first made available via the DOM, there is only one
* Text node for each block of text. Users may create adjacent
* Text nodes that represent the contents of a given element
* without any intervening markup, but should be aware that there is no way
* to represent the separations between these nodes in XML, so they
* will not (in general) persist between DOM editing sessions. The
* normalize() method on Element merges any such
* adjacent Text objects into a single node for each block of
* text; this is recommended before employing operations that depend on a
* particular document structure, such as navigation with
* XPointers.
*/
class CDOM_EXPORT IDOM_Text: public IDOM_CharacterData {
protected:
/** @name Constructors and assignment operator */
//@{
IDOM_Text() {};
IDOM_Text(const IDOM_Text &other) {};
IDOM_Text & operator = (const IDOM_Text &other) {return *this;};
//@}
public:
/** @name Destructor. */
//@{
/**
* Destructor for IDOM_Text. The object being destroyed is the reference
* object, not the underlying Comment node itself.
*
*/
virtual ~IDOM_Text() {};
//@}
/** @name Functions to modify the Text node. */
//@{
/**
* Breaks this node into two nodes at the specified
* offset, keeping both in the tree as siblings.
*
* This node then only
* contains all the content up to the offset point. And a new
* node of the same nodeType, which is inserted as the next sibling of this
* node, contains all the content at and after the offset
* point. When the offset is equal to the lenght of this node,
* the new node has no data.
* @param offset The offset at which to split, starting from 0.
* @return The new Text node.
* @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.
*/
virtual IDOM_Text *splitText(unsigned int offset) = 0;
//@}
/** @name Non-standard (not defined by the DOM specification) functions. */
//@{
/**
*
* Return true if this node contains ignorable whitespaces only.
* @return True if this node contains ignorable whitespaces only.
*/
virtual bool isIgnorableWhitespace() const = 0;
//@}
};
#endif