PySide6.QtXml.QDomElement¶

class QDomElement¶

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

Synopsis¶

Methods¶

def __init__()
def attribute()
def attributeNS()
def attributeNode()
def attributeNodeNS()
def elementsByTagName()
def elementsByTagNameNS()
def hasAttribute()
def hasAttributeNS()
def removeAttribute()
def removeAttributeNS()
def removeAttributeNode()
def setAttribute()
def setAttributeNS()
def setAttributeNode()
def setAttributeNodeNS()
def setTagName()
def tagName()
def text()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description¶

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

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.

e = //...
#...
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.

text = QString()
element = doc.documentElement()
for(QDomNode n = element.firstChild(); not n.isNull(); n = n.nextSibling())

    t = n.toText()
    if not 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:

doc = // ...
root = doc.firstChildElement("database")
elt = root.firstChildElement("entry")
for (; not 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.

__init__()¶

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

__init__(element)

Parameters:: element – QDomElement

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

attribute(name[, defValue=""])¶

Parameters:

name – str
defValue – str

Return type:

str

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

See also

setAttribute() attributeNode() setAttributeNode() attributeNS()

attributeNS(nsURI, localName[, defValue=""])¶

Parameters:

nsURI – str
localName – str
defValue – str

Return type:

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

attributeNode(name)¶

Parameters:: name – str
Return type:: QDomAttr

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

attributeNodeNS(nsURI, localName)¶

Parameters:

nsURI – str
localName – str

Return type:

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 null attribute is returned.

See also

setAttributeNodeNS() setAttributeNode() attribute() setAttribute()

elementsByTagName(tagname)¶

Parameters:: tagname – str
Return type:: 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(nsURI, localName)¶

Parameters:

nsURI – str
localName – str

Return type:

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(name)¶

Parameters:: name – str
Return type:: 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(nsURI, localName)¶

Parameters:

nsURI – str
localName – str

Return type:

bool

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

removeAttribute(name)¶

Parameters:: name – str

Removes the attribute called name name from this element.

See also

setAttribute() attribute() removeAttributeNS()

removeAttributeNS(nsURI, localName)¶

Parameters:

nsURI – str
localName – str

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

See also

setAttributeNS() attributeNS() removeAttribute()

removeAttributeNode(oldAttr)¶

Parameters:: oldAttr – QDomAttr
Return type:: QDomAttr

Removes the attribute oldAttr from the element and returns it.

See also

attributeNode() setAttributeNode()

setAttribute(name, value)¶

Parameters:

name – str
value – 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(name, value)

Parameters:

name – str
value – float

This is an overloaded function.

The formatting always uses QLocale::C.

setAttribute(name, value)

Parameters:

name – str
value – int

This is an overloaded function.

The formatting always uses QLocale::C.

setAttributeNS(nsURI, qName, value)¶

Parameters:

nsURI – str
qName – str
value – 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 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() setAttribute()

setAttributeNS(nsURI, qName, value)

Parameters:

nsURI – str
qName – str
value – float

This is an overloaded function.

setAttributeNS(nsURI, qName, value)

Parameters:

nsURI – str
qName – str
value – int

This is an overloaded function.

setAttributeNS(nsURI, qName, value)

Parameters:

nsURI – str
qName – str
value – int

This is an overloaded function.

setAttributeNS(nsURI, qName, value)

Parameters:

nsURI – str
qName – str
value – int

This is an overloaded function.

setAttributeNS(nsURI, qName, value)

Parameters:

nsURI – str
qName – str
value – int

This is an overloaded function.

setAttributeNode(newAttr)¶

Parameters:: newAttr – QDomAttr
Return type:: 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 null attribute .

See also

attributeNode() setAttribute() setAttributeNodeNS()

setAttributeNodeNS(newAttr)¶

Parameters:: newAttr – QDomAttr
Return type:: 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 null attribute .

See also

attributeNodeNS() setAttributeNS() setAttributeNode()

setTagName(name)¶

Parameters:: name – str

Sets this element’s tag name to name.

See also

tagName()

tagName()¶

Return type:: str

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

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

text()¶

Return type:: str

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Returns the element’s text or an empty string.

Example:

<h1>Hello <b>Qt</b> <not [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.