QDomCharacterData

Section: Misc. Reference Manual Pages (3qt)
Updated: 2 February 2007
Index Return to Main Contents

NAME

QDomCharacterData - Represents a generic string in the DOM

SYNOPSIS

All the functions in this class are reentrant when Qt is built with thread support.</p>

#include <qdom.h>

Inherits QDomNode.

Inherited by QDomText and QDomComment.

Public Members

QDomCharacterData ()

QDomCharacterData ( const QDomCharacterData & x )

QDomCharacterData & operator= ( const QDomCharacterData & x )

~QDomCharacterData ()

virtual QString substringData ( unsigned long offset, unsigned long count )

virtual void appendData ( const QString & arg )

virtual void insertData ( unsigned long offset, const QString & arg )

virtual void deleteData ( unsigned long offset, unsigned long count )

virtual void replaceData ( unsigned long offset, unsigned long count, const QString & arg )

virtual uint length () const

virtual QString data () const

virtual void setData ( const QString & v )

virtual QDomNode::NodeType nodeType () const

virtual bool isCharacterData () const

DESCRIPTION

The QDomCharacterData class represents a generic string in the DOM.

Character data as used in XML specifies a generic data string. More specialized versions of this class are QDomText, QDomComment and QDomCDATASection.

The data string is set with setData() and retrieved with data(). You can retrieve a portion of the data string using substringData(). Extra data can be appended with appendData(), or inserted with insertData(). Portions of the data string can be deleted with deleteData() or replaced with replaceData(). The length of the data string is returned by length().

The node type of the node containing this character data is returned by nodeType().

See also QDomText, QDomComment, QDomCDATASection, and XML.

MEMBER FUNCTION DOCUMENTATION

QDomCharacterData::QDomCharacterData ()

Constructs an empty character data object.

QDomCharacterData::QDomCharacterData ( const QDomCharacterData & x )

Constructs a copy of x.

The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode().

QDomCharacterData::~QDomCharacterData ()

Destroys the object and frees its resources.

void QDomCharacterData::appendData ( const QString & arg ) [virtual]

Appends the string arg to the stored string.

QString QDomCharacterData::data () const [virtual]

Returns the string stored in this object.

If the node is a null node, it will return QString::null.

void QDomCharacterData::deleteData ( unsigned long offset, unsigned long count ) [virtual]

Deletes a substring of length count from position offset.

void QDomCharacterData::insertData ( unsigned long offset, const QString & arg ) [virtual]

Inserts the string arg into the stored string at position offset.

bool QDomCharacterData::isCharacterData () const [virtual]

Returns TRUE.

Reimplemented from QDomNode.

uint QDomCharacterData::length () const [virtual]

Returns the length of the stored string.

QDomNode::NodeType QDomCharacterData::nodeType () const [virtual]

Returns the type of node this object refers to (i.e. TextNode, CDATASectionNode, CommentNode or CharacterDataNode). For a null node CharacterDataNode is returned.

Reimplemented from QDomNode.

Reimplemented in QDomText and QDomComment.

QDomCharacterData & QDomCharacterData::operator= ( const QDomCharacterData & x )

Assigns x to this character data.

The data of the copy is shared (shallow copy): modifying one node will also change the other. If you want to make a deep copy, use cloneNode().

void QDomCharacterData::replaceData ( unsigned long offset, unsigned long count, const QString & arg ) [virtual]

Replaces the substring of length count starting at position offset with the string arg.

void QDomCharacterData::setData ( const QString & v ) [virtual]

Sets this object's string to v.

QString QDomCharacterData::substringData ( unsigned long offset, unsigned long count ) [virtual]

Returns the substring of length count from position offset.

COPYRIGHT

AUTHOR

Generated automatically from the source code.

BUGS

If you find a bug in Qt, please report it as described in http://doc.trolltech.com/bughowto.html. Good bug reports help us to help you. Thank you. The definitive Qt documentation is provided in HTML format; it is located at $QTDIR/doc/html and can be read using Qt Assistant or with a web browser. This man page is provided as a convenience for those users who prefer man pages, although this format is not officially supported by Trolltech. If you find errors in this manual page, please report them to qt-bugs@trolltech.com. Please include the name of the manual page (qdomcharacterdata.3qt) and the Qt version (3.3.8).