QDomElement(3qt)

📦 version 3.3.8b, in fedora 43, fedora 44

💖 QDomElement — from the `3qt` manual 💖

okay bestie, pull up a chair because today we're learning about QDomElement, aka the little diva that represents one element in the DOM tree. yes that's the NAME section, we're doing this properly, in order, no skipping 💅

✨ SYNOPSIS ✨

real talk first: all the functions in this class are reentrant when Qt is built with thread support. </p>

#include <qdom.h>

Inherits QDomNode.

🎀 Public Members 🎀

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

🌸 DESCRIPTION 🌸

so. the QDomElement class represents one element in the DOM tree. that's the whole vibe. one element. main character energy, honestly.

Elements have a tagName() and zero or more attributes hanging out with them. wanna change the tag name? setTagName(). slay.

Element attributes are represented by QDomAttr objects, and you can go ask about them using the attribute() and attributeNode() functions. wanna set stuff? that's setAttribute() and setAttributeNode(). wanna yeet an attribute into the void? removeAttribute(). and because namespaces are a whole thing, there are namespace-aware equivalents to all of these, i.e. setAttributeNS(), setAttributeNodeNS() and removeAttributeNS(). iykyk 💜

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. (translation: don't be reckless, check first bestie 🙈)

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

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

See also XML.

👑 MEMBER FUNCTION DOCUMENTATION 👑

`QDomElement::QDomElement ()`

Constructs an empty element. Use the QDomDocument::createElement() function to construct elements with content. (empty element = the blank canvas era, but you gotta use QDomDocument::createElement() if you want actual content in there ✨)

`QDomElement::QDomElement ( const QDomElement & 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(). no cap, they're linked fr fr — so if you wanted a real independent twin, cloneNode() is the move.

`QDomElement::~QDomElement ()`

Destroys the object and frees its resources. bye bestie 🦋

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

Returns the attribute called name. If the attribute does not exist defValue is returned. (no attribute? you get the fallback, no drama 💅)

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

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

Returns the attribute with the local name localName and the namespace URI nsURI. If the attribute does not exist defValue is returned. the namespace-aware glow-up version 🌈

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. so always check for that null, okay? 👀

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 setAttributeNode(), attribute(), and setAttribute().

`QDomNamedNodeMap QDomElement::attributes () const` [virtual]

Returns a QDomNamedNodeMap containing all this element's attributes. the whole squad, assembled 💖

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

Reimplemented from QDomNode.

`QDomNodeList QDomElement::elementsByTagName ( const QString & tagname ) const` [virtual]

Returns a QDomNodeList containing all descendent elements of this element that are called tagname. The order they are in the node list is the order they are encountered in a preorder traversal of the element tree. so the order is not random, it's literally the tree-walk order, periodt.

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

`QDomNodeList QDomElement::elementsByTagNameNS ( const QString & nsURI, const QString & localName ) const` [virtual]

Returns a QDomNodeList containing all the descendent elements of this element with the local name localName and the namespace URI nsURI. The order they are in the node list is the order they are encountered in a preorder traversal of the element tree.

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. vibe check, boolean edition ✨

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

`bool QDomElement::isElement () const` [virtual]

Returns TRUE. that's it. that's the whole function. it's an element, confirmed, we love a confident queen 👑

Reimplemented from QDomNode.

`QDomNode::NodeType QDomElement::nodeType () const` [virtual]

Returns ElementNode. yes, this is an element node. it said what it said 💅

Reimplemented from QDomNode.

`QDomElement & QDomElement::operator= ( const QDomElement & x )`

Assigns x 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(). same warning as before bestie, they are linked, do not forget 😭

`void QDomElement::removeAttribute ( const QString & name )`

Removes the attribute called name name from this element. (yes, the original really says "name name", we are keeping that, iconic typo, no notes 🎀)

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. namespace-aware removal, gone girl 💨

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

`QDomAttr QDomElement::removeAttributeNode ( const QDomAttr & oldAttr )`

Removes the attribute oldAttr from the element and returns it. you get it back! it's not lost, it's just evicted 🫶

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. so it's add-or-overwrite, no duplicates allowed 🚫

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