QDomElement Class

The QDomElement class represents one element in the DOM tree. More...

Header:	`#include <QDomElement>`
CMake:	`find_package(Qt6 REQUIRED COMPONENTS Xml)` `target_link_libraries(mytarget PRIVATE Qt6::Xml)`
qmake:	`QT += xml`
Inherits:	QDomNode

List of all members, including inherited members
QDomElement is part of XML Classes.

Note: All functions in this class are reentrant.

Public Functions

	QDomElement()
	QDomElement(const QDomElement &element)
QString	attribute(const QString &name, const QString &defValue = QString()) const
QString	attributeNS(const QString &nsURI, const QString &localName, const QString &defValue = QString()) const
QDomAttr	attributeNode(const QString &name)
QDomAttr	attributeNodeNS(const QString &nsURI, const QString &localName)
QDomNamedNodeMap	attributes() const
QDomNodeList	elementsByTagName(const QString &tagname) const
QDomNodeList	elementsByTagNameNS(const QString &nsURI, const QString &localName) const
bool	hasAttribute(const QString &name) const
bool	hasAttributeNS(const QString &nsURI, const QString &localName) const
QDomNode::NodeType	nodeType() const
void	removeAttribute(const QString &name)
void	removeAttributeNS(const QString &nsURI, const QString &localName)
QDomAttr	removeAttributeNode(const QDomAttr &oldAttr)
void	setAttribute(const QString &name, const QString &value)
void	setAttribute(const QString &name, double value)
void	setAttribute(const QString &name, float value)
void	setAttribute(const QString &name, int value)
void	setAttribute(const QString &name, qlonglong value)
void	setAttribute(const QString &name, qulonglong value)
void	setAttribute(const QString &name, uint value)
void	setAttributeNS(const QString &nsURI, const QString &qName, const QString &value)
void	setAttributeNS(const QString &nsURI, const QString &qName, double value)
void	setAttributeNS(const QString &nsURI, const QString &qName, int value)
void	setAttributeNS(const QString &nsURI, const QString &qName, qlonglong value)
void	setAttributeNS(const QString &nsURI, const QString &qName, qulonglong value)
void	setAttributeNS(const QString &nsURI, const QString &qName, uint value)
QDomAttr	setAttributeNode(const QDomAttr &newAttr)
QDomAttr	setAttributeNodeNS(const QDomAttr &newAttr)
void	setTagName(const QString &name)
QString	tagName() const
QString	text() const
QDomElement &	operator=(const QDomElement &other)

Detailed Description

Elements have a tagName() and zero or more attributes associated with them. The tag name can be changed with setTagName().

Element attributes are represented by QDomAttr objects that can be queried using the attribute() and attributeNode() functions. You can set attributes with the setAttribute() and setAttributeNode() functions. Attributes can be removed with removeAttribute(). There are namespace-aware equivalents to these functions, i.e. setAttributeNS(), setAttributeNodeNS() and removeAttributeNS().

If you want to access the text of a node use text(), e.g.

QDomElement e = //...
//...
QString s = e.text()

The text() function operates recursively to find the text (since not all elements contain text). If you want to find all the text in all of a node's children, iterate over the children looking for QDomText nodes, e.g.

QString text;
QDomElement element = doc.documentElement();
for(QDomNode n = element.firstChild(); !n.isNull(); n = n.nextSibling())
{
    QDomText t = n.toText();
    if (!t.isNull())
        text += t.data();
}

Note that we attempt to convert each node to a text node and use text() rather than using firstChild().toText().data() or n.toText().data() directly on the node, because the node may not be a text element.

You can get a list of all the descendents of an element which have a specified tag name with elementsByTagName() or elementsByTagNameNS().

To browse the elements of a dom document use firstChildElement(), lastChildElement(), nextSiblingElement() and previousSiblingElement(). For example, to iterate over all child elements called "entry" in a root element called "database", you can use:

QDomDocument doc = // ...
QDomElement root = doc.firstChildElement("database");
QDomElement elt = root.firstChildElement("entry");
for (; !elt.isNull(); elt = elt.nextSiblingElement("entry")) {
    // ...
}

For further information about the Document Object Model see Level 1 and Level 2 Core. For a more general introduction of the DOM implementation see the QDomDocument documentation.

Member Function Documentation

QDomElement::QDomElement()

Constructs an empty element. Use the QDomDocument::createElement() function to construct elements with content.

QDomElement::QDomElement(const QDomElement &element)

Constructs a copy of element.

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

QString QDomElement::attribute(const QString &name, const QString &defValue = QString()) const

Returns the attribute called name. If the attribute does not exist defValue is returned.

See also setAttribute(), attributeNode(), setAttributeNode(), and attributeNS().

QString QDomElement::attributeNS(const QString &nsURI, const QString &localName, const QString &defValue = QString()) const

Returns the attribute with the local name localName and the namespace URI nsURI. If the attribute does not exist defValue is returned.

See also setAttributeNS(), attributeNodeNS(), setAttributeNodeNS(), and attribute().

QDomAttr QDomElement::attributeNode(const QString &name)

Returns the QDomAttr object that corresponds to the attribute called name. If no such attribute exists a null attribute is returned.

See also setAttributeNode(), attribute(), setAttribute(), and attributeNodeNS().

QDomAttr QDomElement::attributeNodeNS(const QString &nsURI, const QString &localName)

Returns the QDomAttr object that corresponds to the attribute with the local name localName and the namespace URI nsURI. If no such attribute exists a null attribute is returned.

See also setAttributeNodeNS(), setAttributeNode(), attribute(), and setAttribute().

QDomNamedNodeMap QDomElement::attributes() const

Returns a QDomNamedNodeMap containing all this element's attributes.

See also attribute(), setAttribute(), attributeNode(), and setAttributeNode().

QDomNodeList QDomElement::elementsByTagName(const QString &tagname) const

Returns a QDomNodeList containing all descendants of this element named tagname encountered during a preorder traversal of the element subtree with this element as its root. The order of the elements in the returned list is the order they are encountered during the preorder traversal.

See also elementsByTagNameNS() and QDomDocument::elementsByTagName().

QDomNodeList QDomElement::elementsByTagNameNS(const QString &nsURI, const QString &localName) const

Returns a QDomNodeList containing all descendants of this element with local name localName and namespace URI nsURI encountered during a preorder traversal of the element subtree with this element as its root. The order of the elements in the returned list is the order they are encountered during the preorder traversal.

See also elementsByTagName() and QDomDocument::elementsByTagNameNS().

bool QDomElement::hasAttribute(const QString &name) const

Returns true if this element has an attribute called name; otherwise returns false.

Note: This function does not take the presence of namespaces into account. As a result, the specified name will be tested against fully-qualified attribute names that include any namespace prefixes that may be present.

Use hasAttributeNS() to explicitly test for attributes with specific namespaces and names.

bool QDomElement::hasAttributeNS(const QString &nsURI, const QString &localName) const

Returns true if this element has an attribute with the local name localName and the namespace URI nsURI; otherwise returns false.

QDomNode::NodeType QDomElement::nodeType() const

Returns ElementNode.

void QDomElement::removeAttribute(const QString &name)

Removes the attribute called name name from this element.

See also setAttribute(), attribute(), and removeAttributeNS().

void QDomElement::removeAttributeNS(const QString &nsURI, const QString &localName)

Removes the attribute with the local name localName and the namespace URI nsURI from this element.

See also setAttributeNS(), attributeNS(), and removeAttribute().

QDomAttr QDomElement::removeAttributeNode(const QDomAttr &oldAttr)

Removes the attribute oldAttr from the element and returns it.

See also attributeNode() and setAttributeNode().

void QDomElement::setAttribute(const QString &name, const QString &value)

Adds an attribute called name with value value. If an attribute with the same name exists, its value is replaced by value.

See also attribute(), setAttributeNode(), and setAttributeNS().

void QDomElement::setAttribute(const QString &name, double value)

This is an overloaded function.

The formatting always uses QLocale::C.

void QDomElement::setAttribute(const QString &name, float value)

This is an overloaded function.

The formatting always uses QLocale::C.

void QDomElement::setAttribute(const QString &name, int value)

This is an overloaded function.

The formatting always uses QLocale::C.

void QDomElement::setAttribute(const QString &name, qlonglong value)

This is an overloaded function.

The formatting always uses QLocale::C.

void QDomElement::setAttribute(const QString &name, qulonglong value)

This is an overloaded function.

The formatting always uses QLocale::C.

void QDomElement::setAttribute(const QString &name, uint value)

This is an overloaded function.

The formatting always uses QLocale::C.

void QDomElement::setAttributeNS(const QString &nsURI, const QString &qName, const QString &value)

Adds an attribute with the qualified name qName and the namespace URI nsURI with the value value. If an attribute with the same local name and namespace URI exists, its prefix is replaced by the prefix of qName and its value is replaced by value.

Although qName is the qualified name, the local name is used to decide if an existing attribute's value should be replaced.

See also attributeNS(), setAttributeNodeNS(), and setAttribute().

void QDomElement::setAttributeNS(const QString &nsURI, const QString &qName, double value)

This is an overloaded function.

void QDomElement::setAttributeNS(const QString &nsURI, const QString &qName, int value)

This is an overloaded function.

void QDomElement::setAttributeNS(const QString &nsURI, const QString &qName, qlonglong value)

This is an overloaded function.

void QDomElement::setAttributeNS(const QString &nsURI, const QString &qName, qulonglong value)

This is an overloaded function.

void QDomElement::setAttributeNS(const QString &nsURI, const QString &qName, uint value)

This is an overloaded function.

QDomAttr QDomElement::setAttributeNode(const QDomAttr &newAttr)

Adds the attribute newAttr to this element.

If the element has another attribute that has the same name as newAttr, this function replaces that attribute and returns it; otherwise the function returns a null attribute.

See also attributeNode(), setAttribute(), and setAttributeNodeNS().

QDomAttr QDomElement::setAttributeNodeNS(const QDomAttr &newAttr)

Adds the attribute newAttr to this element.

If the element has another attribute that has the same local name and namespace URI as newAttr, this function replaces that attribute and returns it; otherwise the function returns a null attribute.

See also attributeNodeNS(), setAttributeNS(), and setAttributeNode().

void QDomElement::setTagName(const QString &name)

Sets this element's tag name to name.

See also tagName().

QString QDomElement::tagName() const

Returns the tag name of this element. For an XML element like this:

<img src="myimg.png">

the tagname would return "img".

See also setTagName().

QString QDomElement::text() const

Returns the element's text or an empty string.

Example:

<h1>Hello <b>Qt</b> <![CDATA[<xml is cool>]]></h1>

The function text() of the QDomElement for the <h1> tag, will return the following text:

Hello Qt <xml is cool>

Comments are ignored by this function. It only evaluates QDomText and QDomCDATASection objects.

QDomElement &QDomElement::operator=(const QDomElement &other)

Assigns other to this DOM element.

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

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.