QDomElement露

PyQt5.QtXml.QDomElement

Inherits from QDomNode.

Description露

The QDomElement class represents one element in the DOM tree.

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鈥檚 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() <https://doc.qt.io/qt-5/qtdatavisualization-qmlbars-example.html#data>`_ or n.toText().`data() <https://doc.qt.io/qt-5/qtdatavisualization-qmlbars-example.html#data>`_ directly on the node, because the node may not be a text element.

You can get a list of all the decendents 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 鈥渆ntry鈥 in a root element called 鈥渄atabase鈥, 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.

Methods露

__init__()

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

__init__(QDomElement)

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

attribute(str, defaultValue: str = '') → str

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

See also

setAttribute(), attributeNode(), setAttributeNode(), attributeNS().

attributeNode(str) → QDomAttr

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

See also

setAttributeNode(), attribute(), setAttribute(), attributeNodeNS().

attributeNodeNS(str, str) → QDomAttr

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 isNull() is returned.

See also

setAttributeNodeNS(), setAttributeNode(), attribute(), setAttribute().

attributeNS(str, str, defaultValue: str = '') → str

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

attributes() → QDomNamedNodeMap

Returns a QDomNamedNodeMap containing all this element鈥檚 attributes.

See also

attribute(), setAttribute(), attributeNode(), setAttributeNode().

elementsByTagName(str) → QDomNodeList

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

elementsByTagNameNS(str, str) → QDomNodeList

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

hasAttribute(str) → bool

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.

hasAttributeNS(str, str) → bool

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

nodeType() → NodeType

TODO

removeAttribute(str)

Removes the attribute called name name from this element.

See also

setAttribute(), attribute(), removeAttributeNS().

removeAttributeNode(QDomAttr) → QDomAttr

Removes the attribute oldAttr from the element and returns it.

See also

attributeNode(), setAttributeNode().

removeAttributeNS(str, str)

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

See also

setAttributeNS(), attributeNS(), removeAttribute().

setAttribute(str, str)

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

setAttribute(str, int)

This is an overloaded function.

The number is formatted according to the current locale.

setAttribute(str, int)

This is an overloaded function.

The number is formatted according to the current locale.

setAttribute(str, float)

This is an overloaded function.

The number is formatted according to the current locale.

setAttribute(str, int)

This is an overloaded function.

The number is formatted according to the current locale.

setAttributeNode(QDomAttr) → QDomAttr

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

See also

attributeNode(), setAttribute(), setAttributeNodeNS().

setAttributeNodeNS(QDomAttr) → QDomAttr

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

See also

attributeNodeNS(), setAttributeNS(), setAttributeNode().

setAttributeNS(str, str, str)

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 repaced by value.

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

See also

attributeNS(), setAttributeNodeNS(), setAttribute().

setAttributeNS(str, str, int)

This is an overloaded function.

setAttributeNS(str, str, int)

This is an overloaded function.

setAttributeNS(str, str, float)

This is an overloaded function.

setAttributeNS(str, str, int)

This is an overloaded function.

setTagName(str)

Sets this element鈥檚 tag name to name.

See also

tagName().

tagName() → str

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

# <img src="myimg.png">

the tagname would return 鈥渋mg鈥.

See also

setTagName().

text() → str

Returns the element鈥檚 text or an empty string.

Example:

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

The function 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.