TQDomNamedNodeMap Class Reference
[XML module]

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

All the functions in this class are reentrant when TQt is built with thread support.

#include <tqdom.h>

List of all member functions.

Public Members

TQDomNamedNodeMap ()
TQDomNamedNodeMap ( const TQDomNamedNodeMap & n )
TQDomNamedNodeMap & operator= ( const TQDomNamedNodeMap & n )
bool operator== ( const TQDomNamedNodeMap & n ) const
bool operator!= ( const TQDomNamedNodeMap & n ) const
~TQDomNamedNodeMap ()
TQDomNode namedItem ( const TQString & name ) const
TQDomNode setNamedItem ( const TQDomNode & newNode )
TQDomNode removeNamedItem ( const TQString & name )
TQDomNode item ( int index ) const
TQDomNode namedItemNS ( const TQString & nsURI, const TQString & localName ) const
TQDomNode setNamedItemNS ( const TQDomNode & newNode )
TQDomNode removeNamedItemNS ( const TQString & nsURI, const TQString & localName )
uint length () const
uint count () const
bool contains ( const TQString & name ) const

Detailed Description

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

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

The TQDomNamedNodeMap is used in three places:

TQDomDocumentType::entities() returns a map of all entities described in the DTD.
TQDomDocumentType::notations() returns a map of all notations described in the DTD.
TQDomNode::attributes() returns a map of all attributes of an element.

Items in the map are identified by the name which TQDomNode::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.

Member Function Documentation

TQDomNamedNodeMap::TQDomNamedNodeMap ()

Constructs an empty named node map.

TQDomNamedNodeMap::TQDomNamedNodeMap ( const TQDomNamedNodeMap & n )

Constructs a copy of n.

TQDomNamedNodeMap::~TQDomNamedNodeMap ()

Destroys the object and frees its resources.

bool TQDomNamedNodeMap::contains ( const TQString & name ) const

Returns TRUE if the map contains a node called name; otherwise returns FALSE.

uint TQDomNamedNodeMap::count () const

Returns the number of nodes in the map.

This function is the same as length().

TQDomNode TQDomNamedNodeMap::item ( int index ) const

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.

uint TQDomNamedNodeMap::length () const

Returns the number of nodes in the map.

TQDomNode TQDomNamedNodeMap::namedItem ( const TQString & name ) const

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 TQDomNode::nodeName().

See also setNamedItem() and namedItemNS().

TQDomNode TQDomNamedNodeMap::namedItemNS ( const TQString & nsURI, const TQString & localName ) const

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.

See also setNamedItemNS() and namedItem().

bool TQDomNamedNodeMap::operator!= ( const TQDomNamedNodeMap & n ) const

Returns TRUE if n and this named node map are not equal; otherwise returns FALSE.

TQDomNamedNodeMap & TQDomNamedNodeMap::operator= ( const TQDomNamedNodeMap & n )

Assigns n to this named node map.

bool TQDomNamedNodeMap::operator== ( const TQDomNamedNodeMap & n ) const

Returns TRUE if n and this named node map are equal; otherwise returns FALSE.

TQDomNode TQDomNamedNodeMap::removeNamedItem ( const TQString & name )

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.

See also setNamedItem(), namedItem(), and removeNamedItemNS().

TQDomNode TQDomNamedNodeMap::removeNamedItemNS ( const TQString & nsURI, const TQString & localName )

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.

See also setNamedItemNS(), namedItemNS(), and removeNamedItem().

TQDomNode TQDomNamedNodeMap::setNamedItem ( const TQDomNode & newNode )

Inserts the node newNode into the named node map. The name used by the map is the node name of newNode as returned by TQDomNode::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.

See also namedItem(), removeNamedItem(), and setNamedItemNS().

TQDomNode TQDomNamedNodeMap::setNamedItemNS ( const TQDomNode & newNode )

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.

See also namedItemNS(), removeNamedItemNS(), and setNamedItem().

Trademarks

TQt 3.3.8

TQDomNamedNodeMap Class Reference[XML module]