\reentrant More...

#include <qdom.h>

Inheritance diagram for QDomAttr:

Collaboration diagram for QDomAttr:

Public Member Functions
	QDomAttr ()
	Constructs an empty attribute.

	QDomAttr (const QDomAttr &x)
	Constructs a copy of x.

QDomAttr &	operator= (const QDomAttr &)
	Assigns x to this DOM attribute.

QString	name () const
	Returns the attribute's name.

bool	specified () const
	Returns `true` if the attribute has been set by the user with setValue().

QDomElement	ownerElement () const
	Returns the element node this attribute is attached to or a \l{QDomNode::isNull()}{null node} if this attribute is not attached to any element.

QString	value () const
	Returns the value of the attribute or an empty string if the attribute has not been specified.

void	setValue (const QString &)
	Sets the attribute's value to v.

QDomNode::NodeType	nodeType () const
	Returns \l{QDomNode::NodeType}{AttributeNode}.

Public Member Functions inherited from QDomNode
	QDomNode ()
	Constructs a \l{isNull()}{null} node.

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

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

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

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

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

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

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

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

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

QDomNode	appendChild (const QDomNode &newChild)
	Appends newChild as the node's last child.

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

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

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

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`.

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

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

QDomNode	parentNode () const
	Returns the parent node.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	save (QTextStream &, int, EncodingPolicy=QDomNode::EncodingFromDocument) const
	Writes the XML representation of the node and all its children to the stream stream.

QDomElement	firstChildElement (const QString &tagName=QString(), const QString &namespaceURI=QString()) const
	Returns the first child element with tag name tagName and namespace URI namespaceURI.

QDomElement	lastChildElement (const QString &tagName=QString(), const QString &namespaceURI=QString()) const
	Returns the last child element with tag name tagName and namespace URI namespaceURI.

QDomElement	previousSiblingElement (const QString &tagName=QString(), const QString &namespaceURI=QString()) const
	Returns the previous sibling element with tag name tagName and namespace URI namespaceURI.

QDomElement	nextSiblingElement (const QString &taName=QString(), const QString &namespaceURI=QString()) const
	Returns the next sibling element with tag name tagName and namespace URI namespaceURI.

int	lineNumber () const

int	columnNumber () const

Friends
class	QDomDocument

class	QDomElement

class	QDomNode

Additional Inherited Members
Public Types inherited from QDomNode
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: \value ElementNode \value AttributeNode \value TextNode \value CDATASectionNode \value EntityReferenceNode \value EntityNode \value ProcessingInstructionNode \value CommentNode \value DocumentNode \value DocumentTypeNode \value DocumentFragmentNode \value NotationNode \value BaseNode A QDomNode object, i.e. More...

enum	EncodingPolicy { EncodingFromDocument = 1 , EncodingFromTextStream = 2 }

Protected Member Functions inherited from QDomNode
	QDomNode (QDomNodePrivate *)

Protected Attributes inherited from QDomNode
QDomNodePrivate *	impl

Related Symbols 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.

Detailed Description

\reentrant

The QDomAttr class represents one attribute of a QDomElement.

\inmodule QtXml

For example, the following piece of XML produces an element with no children, but two attributes:

color

Definition qssgutils_p.h:103

You can access the attributes of an element with code like this:

QDomElement e;
//...
QDomAttr a = e.attributeNode("href");
cout << qPrintable(a.value()) << '\n';   // prints "http://qt-project.org"
a.setValue("http://qt-project.org/doc"); // change the node's attribute
QDomAttr a2 = e.attributeNode("href");
cout << qPrintable(a2.value()) << '\n';  // prints "http://qt-project.org/doc"

This example also shows that changing an attribute received from an element changes the attribute of the element. If you do not want to change the value of the element's attribute you must use cloneNode() to get an independent copy of the attribute.

QDomAttr can return the name() and value() of an attribute. An attribute's value is set with setValue(). If specified() returns true the value was set with setValue(). The node this attribute is attached to (if any) is returned by ownerElement().

For further information about the Document Object Model see \l{http://www.w3.org/TR/REC-DOM-Level-1/} and \l{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 440 of file qdom.h.

Constructor & Destructor Documentation

◆ QDomAttr() [1/2]

QDomAttr::QDomAttr ( )

Constructs an empty attribute.

Definition at line 3728 of file qdom.cpp.

◆ QDomAttr() [2/2]

QDomAttr::QDomAttr ( const QDomAttr & 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 3739 of file qdom.cpp.

Member Function Documentation

◆ name()

QString QDomAttr::name ( ) const

Returns the attribute's name.

Definition at line 3761 of file qdom.cpp.

References QDomNode::impl, and QDomNodePrivate::nodeName().

Here is the call graph for this function:

◆ nodeType()

QDomNode::NodeType QDomAttr::nodeType ( ) const

inline

Returns \l{QDomNode::NodeType}{AttributeNode}.

Definition at line 457 of file qdom.h.

◆ operator=()

QDomAttr & QDomAttr::operator= ( const QDomAttr & )

default

Assigns x to this DOM attribute.

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

◆ ownerElement()

QDomElement QDomAttr::ownerElement ( ) const

Returns the element node this attribute is attached to or a \l{QDomNode::isNull()}{null node} if this attribute is not attached to any element.

Definition at line 3786 of file qdom.cpp.

References QDomNode::impl, QDomNodePrivate::isElement(), QDomNodePrivate::parent(), Q_ASSERT, and QDomElement.

Here is the call graph for this function:

◆ setValue()

void QDomAttr::setValue ( const QString & v )

Sets the attribute's value to v.

See also: value()

Definition at line 3812 of file qdom.cpp.

References IMPL, QDomNode::impl, and QDomNodePrivate::setNodeValue().

Here is the call graph for this function:

◆ specified()

bool QDomAttr::specified ( ) const

Returns true if the attribute has been set by the user with setValue().

Returns false if the value hasn't been specified or set.

See also: setValue()

Definition at line 3774 of file qdom.cpp.

References IMPL, and QDomNode::impl.

◆ value()

QString QDomAttr::value ( ) const

Returns the value of the attribute or an empty string if the attribute has not been specified.

See also: specified(), setValue()

Definition at line 3800 of file qdom.cpp.

References QDomNode::impl, and QDomNodePrivate::nodeValue().

Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ QDomDocument

friend class QDomDocument

friend

Definition at line 462 of file qdom.h.

◆ QDomElement

friend class QDomElement

friend

Definition at line 463 of file qdom.h.

Referenced by ownerElement().

◆ QDomNode

friend class QDomNode

friend

Definition at line 464 of file qdom.h.

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

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

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QDomAttr() [1/2]

◆ QDomAttr() [2/2]

Member Function Documentation

◆ name()

◆ nodeType()

◆ operator=()

◆ ownerElement()

◆ setValue()

◆ specified()

◆ value()

Friends And Related Symbol Documentation

◆ QDomDocument

◆ QDomElement

◆ QDomNode