QDomNamedNodeMap

The QDomNamedNodeMap class contains a collection of nodes that can be accessed by name. More

Inheritance diagram of PySide2.QtXml.QDomNamedNodeMap

Synopsis

Functions

Detailed Description

Note that QDomNamedNodeMap does not inherit from QDomNodeList . QDomNamedNodeMaps do not provide any specific node ordering. Although nodes in a QDomNamedNodeMap may be accessed by an ordinal index, this is simply to allow a convenient enumeration of the contents of a QDomNamedNodeMap , and does not imply that the DOM specifies an ordering of the nodes.

The QDomNamedNodeMap is used in three places:

  1. entities() returns a map of all entities described in the DTD.

  2. notations() returns a map of all notations described in the DTD.

  3. attributes() returns a map of all attributes of an element.

Items in the map are identified by the name which QDomNode::name() returns. Nodes are retrieved using namedItem() , namedItemNS() or item() . New nodes are inserted with setNamedItem() or setNamedItemNS() and removed with removeNamedItem() or removeNamedItemNS() . Use contains() to see if an item with the given name is in the named node map. The number of items is returned by length() .

Terminology: in this class we use “item” and “node” interchangeably.

class PySide2.QtXml.QDomNamedNodeMap

PySide2.QtXml.QDomNamedNodeMap(arg__1)

param arg__1:

PySide2.QtXml.QDomNamedNodeMap

Constructs an empty named node map.

PySide2.QtXml.QDomNamedNodeMap.contains(name)
Parameters:

name – str

Return type:

bool

Returns true if the map contains a node called name ; otherwise returns false .

Note

This function does not take the presence of namespaces into account. Use namedItemNS() to test whether the map contains a node with a specific namespace URI and name.

PySide2.QtXml.QDomNamedNodeMap.count()
Return type:

int

This function is provided for Qt API consistency. It is equivalent to length() .

PySide2.QtXml.QDomNamedNodeMap.isEmpty()
Return type:

bool

Returns true if the map is empty; otherwise returns false . This function is provided for Qt API consistency.

PySide2.QtXml.QDomNamedNodeMap.item(index)
Parameters:

index – int

Return type:

PySide2.QtXml.QDomNode

Retrieves the node at position index .

This can be used to iterate over the map. Note that the nodes in the map are ordered arbitrarily.

See also

length()

PySide2.QtXml.QDomNamedNodeMap.length()
Return type:

int

Returns the number of nodes in the map.

See also

item()

PySide2.QtXml.QDomNamedNodeMap.namedItem(name)
Parameters:

name – str

Return type:

PySide2.QtXml.QDomNode

Returns the node called name .

If the named node map does not contain such a node, a null node is returned. A node’s name is the name returned by nodeName() .

PySide2.QtXml.QDomNamedNodeMap.namedItemNS(nsURI, localName)
Parameters:
  • nsURI – str

  • localName – str

Return type:

PySide2.QtXml.QDomNode

Returns the node associated with the local name localName and the namespace URI nsURI .

If the map does not contain such a node, a null node is returned.

PySide2.QtXml.QDomNamedNodeMap.__ne__(arg__1)
Parameters:

arg__1PySide2.QtXml.QDomNamedNodeMap

Return type:

bool

Returns true if n and this named node map are not equal; otherwise returns false .

PySide2.QtXml.QDomNamedNodeMap.__eq__(arg__1)
Parameters:

arg__1PySide2.QtXml.QDomNamedNodeMap

Return type:

bool

Returns true if n and this named node map are equal; otherwise returns false .

PySide2.QtXml.QDomNamedNodeMap.removeNamedItem(name)
Parameters:

name – str

Return type:

PySide2.QtXml.QDomNode

Removes the node called name from the map.

The function returns the removed node or a null node if the map did not contain a node called name .

PySide2.QtXml.QDomNamedNodeMap.removeNamedItemNS(nsURI, localName)
Parameters:
  • nsURI – str

  • localName – str

Return type:

PySide2.QtXml.QDomNode

Removes the node with the local name localName and the namespace URI nsURI from the map.

The function returns the removed node or a null node if the map did not contain a node with the local name localName and the namespace URI nsURI .

PySide2.QtXml.QDomNamedNodeMap.setNamedItem(newNode)
Parameters:

newNodePySide2.QtXml.QDomNode

Return type:

PySide2.QtXml.QDomNode

Inserts the node newNode into the named node map. The name used by the map is the node name of newNode as returned by nodeName() .

If the new node replaces an existing node, i.e. the map contains a node with the same name, the replaced node is returned.

PySide2.QtXml.QDomNamedNodeMap.setNamedItemNS(newNode)
Parameters:

newNodePySide2.QtXml.QDomNode

Return type:

PySide2.QtXml.QDomNode

Inserts the node newNode in the map. If a node with the same namespace URI and the same local name already exists in the map, it is replaced by newNode . If the new node replaces an existing node, the replaced node is returned.

PySide2.QtXml.QDomNamedNodeMap.size()
Return type:

int

This function is provided for Qt API consistency. It is equivalent to length() .