The QDomComment class represents an XML comment. More...

#include <qdom.h>

Inheritance diagram for QDomComment:

Public Functions
QDomNode::NodeType	nodeType () const
	Returns `CommentNode`. More...

QDomComment &	operator= (const QDomComment &)
	Assigns x to this DOM comment. More...

	QDomComment ()
	Constructs an empty comment. More...

	QDomComment (const QDomComment &x)
	Constructs a copy of x. More...

Public Functions inherited from QDomCharacterData
void	appendData (const QString &arg)
	Appends the string arg to the stored string. More...

QString	data () const
	Returns the string stored in this object. More...

void	deleteData (unsigned long offset, unsigned long count)
	Deletes a substring of length count from position offset. More...

void	insertData (unsigned long offset, const QString &arg)
	Inserts the string arg into the stored string at position offset. More...

uint	length () const
	Returns the length of the stored string. More...

QDomNode::NodeType	nodeType () const
	Returns the type of node this object refers to (i.e. More...

QDomCharacterData &	operator= (const QDomCharacterData &)
	Assigns x to this character data. More...

	QDomCharacterData ()
	Constructs an empty character data object. More...

	QDomCharacterData (const QDomCharacterData &x)
	Constructs a copy of x. More...

void	replaceData (unsigned long offset, unsigned long count, const QString &arg)
	Replaces the substring of length count starting at position offset with the string arg. More...

void	setData (const QString &)
	Sets this object's string to v. More...

QString	substringData (unsigned long offset, unsigned long count)
	Returns the substring of length count from position offset. More...

Public Functions inherited from QDomNode
QDomNode	appendChild (const QDomNode &newChild)
	Appends newChild as the node's last child. More...

QDomNamedNodeMap	attributes () const
	Returns a named node map of all attributes. More...

QDomNodeList	childNodes () const
	Returns a list of all direct child nodes. More...

void	clear ()
	Converts the node into a null node; if it was not a null node before, its type and contents are deleted. More...

QDomNode	cloneNode (bool deep=true) const
	Creates a deep (not shallow) copy of the QDomNode. More...

int	columnNumber () const
	For nodes created by QDomDocument::setContent(), this function returns the column number in the XML document where the node was parsed. More...

QDomNode	firstChild () const
	Returns the first child of the node. More...

QDomElement	firstChildElement (const QString &tagName=QString()) const
	Returns the first child element with tag name tagName if tagName is non-empty; otherwise returns the first child element. More...

bool	hasAttributes () const
	Returns true if the node has attributes; otherwise returns false. More...

bool	hasChildNodes () const
	Returns true if the node has one or more children; otherwise returns false. More...

QDomNode	insertAfter (const QDomNode &newChild, const QDomNode &refChild)
	Inserts the node newChild after the child node refChild. More...

QDomNode	insertBefore (const QDomNode &newChild, const QDomNode &refChild)
	Inserts the node newChild before the child node refChild. More...

bool	isAttr () const
	Returns true if the node is an attribute; otherwise returns false. More...

bool	isCDATASection () const
	Returns true if the node is a CDATA section; otherwise returns false. More...

bool	isCharacterData () const
	Returns true if the node is a character data node; otherwise returns false. More...

bool	isComment () const
	Returns true if the node is a comment; otherwise returns false. More...

bool	isDocument () const
	Returns true if the node is a document; otherwise returns false. More...

bool	isDocumentFragment () const
	Returns true if the node is a document fragment; otherwise returns false. More...

bool	isDocumentType () const
	Returns true if the node is a document type; otherwise returns false. More...

bool	isElement () const
	Returns true if the node is an element; otherwise returns false. More...

bool	isEntity () const
	Returns true if the node is an entity; otherwise returns false. More...

bool	isEntityReference () const
	Returns true if the node is an entity reference; otherwise returns false. More...

bool	isNotation () const
	Returns true if the node is a notation; otherwise returns false. More...

bool	isNull () const
	Returns true if this node is null (i.e. More...

bool	isProcessingInstruction () const
	Returns true if the node is a processing instruction; otherwise returns false. More...

bool	isSupported (const QString &feature, const QString &version) const
	Returns true if the DOM implementation implements the feature feature and this feature is supported by this node in the version version; otherwise returns false. More...

bool	isText () const
	Returns true if the node is a text node; otherwise returns false. More...

QDomNode	lastChild () const
	Returns the last child of the node. More...

QDomElement	lastChildElement (const QString &tagName=QString()) const
	Returns the last child element with tag name tagName if tagName is non-empty; otherwise returns the last child element. More...

int	lineNumber () const
	For nodes created by QDomDocument::setContent(), this function returns the line number in the XML document where the node was parsed. More...

QString	localName () const
	If the node uses namespaces, this function returns the local name of the node; otherwise it returns an empty string. More...

QDomNode	namedItem (const QString &name) const
	Returns the first direct child node for which nodeName() equals name. More...

QString	namespaceURI () const
	Returns the namespace URI of this node or an empty string if the node has no namespace URI. More...

QDomNode	nextSibling () const
	Returns the next sibling in the document tree. More...

QDomElement	nextSiblingElement (const QString &taName=QString()) const
	Returns the next sibling element with tag name tagName if tagName is non-empty; otherwise returns any next sibling element. More...

QString	nodeName () const
	Returns the name of the node. More...

NodeType	nodeType () const
	Returns the type of the node. More...

QString	nodeValue () const
	Returns the value of the node. More...

void	normalize ()
	Calling normalize() on an element converts all its children into a standard form. More...

bool	operator!= (const QDomNode &) const
	Returns true if n and this DOM node are not equal; otherwise returns false. More...

QDomNode &	operator= (const QDomNode &)
	Assigns a copy of n to this DOM node. More...

bool	operator== (const QDomNode &) const
	Returns true if n and this DOM node are equal; otherwise returns false. More...

QDomDocument	ownerDocument () const
	Returns the document to which this node belongs. More...

QDomNode	parentNode () const
	Returns the parent node. More...

QString	prefix () const
	Returns the namespace prefix of the node or an empty string if the node has no namespace prefix. More...

QDomNode	previousSibling () const
	Returns the previous sibling in the document tree. More...

QDomElement	previousSiblingElement (const QString &tagName=QString()) const
	Returns the previous sibilng element with tag name tagName if tagName is non-empty; otherwise returns any previous sibling element. More...

	QDomNode ()
	Constructs a null node. More...

	QDomNode (const QDomNode &)
	Constructs a copy of n. More...

QDomNode	removeChild (const QDomNode &oldChild)
	Removes oldChild from the list of children. More...

QDomNode	replaceChild (const QDomNode &newChild, const QDomNode &oldChild)
	Replaces oldChild with newChild. More...

void	save (QTextStream &, int) const
	Writes the XML representation of the node and all its children to the stream str. More...

void	save (QTextStream &, int, EncodingPolicy) const
	If encodingPolicy is QDomNode::EncodingFromDocument, this function behaves as save(QTextStream &str, int indent). More...

void	setNodeValue (const QString &)
	Sets the node's value to v. More...

void	setPrefix (const QString &pre)
	If the node has a namespace prefix, this function changes the namespace prefix of the node to pre. More...

QDomAttr	toAttr () const
	Converts a QDomNode into a QDomAttr. More...

QDomCDATASection	toCDATASection () const
	Converts a QDomNode into a QDomCDATASection. More...

QDomCharacterData	toCharacterData () const
	Converts a QDomNode into a QDomCharacterData. More...

QDomComment	toComment () const
	Converts a QDomNode into a QDomComment. More...

QDomDocument	toDocument () const
	Converts a QDomNode into a QDomDocument. More...

QDomDocumentFragment	toDocumentFragment () const
	Converts a QDomNode into a QDomDocumentFragment. More...

QDomDocumentType	toDocumentType () const
	Converts a QDomNode into a QDomDocumentType. More...

QDomElement	toElement () const
	Converts a QDomNode into a QDomElement. More...

QDomEntity	toEntity () const
	Converts a QDomNode into a QDomEntity. More...

QDomEntityReference	toEntityReference () const
	Converts a QDomNode into a QDomEntityReference. More...

QDomNotation	toNotation () const
	Converts a QDomNode into a QDomNotation. More...

QDomProcessingInstruction	toProcessingInstruction () const
	Converts a QDomNode into a QDomProcessingInstruction. More...

QDomText	toText () const
	Converts a QDomNode into a QDomText. More...

	~QDomNode ()
	Destroys the object and frees its resources. More...

Private Functions
	QDomComment (QDomCommentPrivate *)

Friends
class	QDomDocument

class	QDomNode

Additional Inherited Members
Public Types inherited from QDomNode
enum	EncodingPolicy { EncodingFromDocument = 1, EncodingFromTextStream = 2 }
	This enum specifies how QDomNode::save() determines what encoding to use when serializing. More...

enum	NodeType { ElementNode = 1, AttributeNode = 2, TextNode = 3, CDATASectionNode = 4, EntityReferenceNode = 5, EntityNode = 6, ProcessingInstructionNode = 7, CommentNode = 8, DocumentNode = 9, DocumentTypeNode = 10, DocumentFragmentNode = 11, NotationNode = 12, BaseNode = 21, CharacterDataNode = 22 }
	This enum defines the type of the node: More...

Protected Functions inherited from QDomNode
	QDomNode (QDomNodePrivate *)
	Constructs a new node for the data n. More...

Protected Variables inherited from QDomNode
QDomNodePrivate *	impl

Related Functions inherited from QDomNode
QTextStream &	operator<< (QTextStream &str, const QDomNode &node)
	Writes the XML representation of the node node and all its children to the stream str. More...

Detailed Description

The QDomComment class represents an XML comment.

Note: This class or function is reentrant.

Attention: Module: QtXml

A comment in the parsed XML such as this:

is represented by QDomComment objects in the parsed Dom tree.

For further information about the Document Object Model see http://www.w3.org/TR/DOM-Level-2-Core/. For a more general introduction of the DOM implementation see the QDomDocument documentation.

Definition at line 555 of file qdom.h.

Constructors and Destructors

◆ QDomComment() [1/3]

QDomComment::QDomComment ( )

Constructs an empty comment.

To construct a comment with content, use the QDomDocument::createComment() function.

Definition at line 5490 of file qdom.cpp.

     : QDomCharacterData()
 {
 }

◆ QDomComment() [2/3]

QDomComment::QDomComment ( const QDomComment & 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().

Definition at line 5502 of file qdom.cpp.

     : QDomCharacterData(x)
 {
 }

◆ QDomComment() [3/3]

QDomComment::QDomComment ( QDomCommentPrivate * n )

private

Definition at line 5507 of file qdom.cpp.

     : QDomCharacterData(n)
 {
 }

Functions

◆ nodeType()

QDomNode::NodeType QDomComment::nodeType ( ) const

inline

Returns CommentNode.

Definition at line 563 of file qdom.h.

563 { return CommentNode; }

QDomNode::CommentNode

Definition: qdom.h:139

◆ operator=()

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

Assigns x to this DOM comment.

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().

Definition at line 5519 of file qdom.cpp.

 {
     return (QDomComment&) QDomNode::operator=(x);
 }

Friends and Related Functions

◆ QDomDocument

friend class QDomDocument

friend

Definition at line 568 of file qdom.h.

◆ QDomNode

friend class QDomNode

friend

Definition at line 569 of file qdom.h.

The documentation for this class was generated from the following files:

/src/xml/dom/qdom.h
/src/xml/dom/qdom.cpp

Public Functions

Private Functions

Friends

Additional Inherited Members