GdomeCppSmartDOM::NamedNodeMap

Objects implementing the NamedNodeMap interface are used to represent collections of nodes that can be accessed by name. Note that NamedNodeMap does not inherit from NodeList; NamedNodeMaps are not maintained in any particular order. Objects contained in an object implementing NamedNodeMap may also be accessed by an ordinal index, but this is simply to allow convenient enumeration of the contents of a NamedNodeMap, and does not imply that the DOM specifies an order to these Nodes.

NamedNodeMap objects in the DOM are live.

Default Constructor

NamedNodeMap(GdomeNamedNodeMap* = 0)

Creates a smart pointer for the Gdome element whose pointer is passed as an argument. The user should never pass a non-null pointer to this constructor.

Copy and Cast Constructors

NamedNodeMap(const NamedNodeMap&)

These constructors can be used to copy a smart pointer or to downcast it. If the downcasting is not possible, the resulting smart pointer will be null.

Copy Operator

NamedNodeMap& operator=(const NamedNodeMap&)

Equality

bool operator==(const NamedNodeMap&) const
bool operator!=(const NamedNodeMap&) const

Two smart pointers are equal if they point to the same Gdome object.

Attributes

unsigned long get_length(void) const

The number of nodes in this map. The range of valid child node indices is 0 to length-1 inclusive.

Methods

Node getNamedItem(const DOMString& name)

Parameters:

name: The nodeName of a node to retrieve.

Description:

Retrieves a node specified by name.

Node setNamedItem(const Node& arg)

Parameters:

arg: A node to store in this map. The node will later be accessible using the value of its nodeName attribute.

Description:

Adds a node using its nodeName attribute. If a node with that name is already present in this map, it is replaced by the new one.

As the nodeName attribute is used to derive the name which the node must be stored under, multiple nodes of certain types (those that have a "special" string value) cannot be stored as the names would clash. This is seen as preferable to allowing nodes to be aliased.

Exceptions:

DOMException

WRONG_DOCUMENT_ERR: Raised if arg was created from a different document than the one that created this map.

NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.

INUSE_ATTRIBUTE_ERR: Raised if arg is an Attr that is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.

Node removeNamedItem(const DOMString& name)

Parameters:

name: The nodeName of the node to remove.

Description:

Removes a node specified by name. When this map contains the attributes attached to an element, if the removed attribute is known to have a default value, an attribute immediately appears containing the default value as well as the corresponding namespace URI, local name, and prefix when applicable.

Exceptions:

DOMException

NOT_FOUND_ERR: Raised if there is no node named name in this map.

NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.

Node item(const unsigned longindex)

Parameters:

index: Index into this map.

Description:

Returns the indexth item in the map. If index is greater than or equal to the number of nodes in this map, this returns null.

Node getNamedItemNS(const DOMString& namespaceURI, const DOMString& localName)

Parameters:

namespaceURI: The namespace URI of the node to retrieve.
localName: The local name of the node to retrieve.

Description:

Retrieves a node specified by local name and namespace URI. HTML-only DOM implementations do not need to implement this method.

Node setNamedItemNS(const Node& arg)

Parameters:

arg: A node to store in this map. The node will later be accessible using the value of its namespaceURI and localName attributes.

Description:

Adds a node using its namespaceURI and localName. If a node with that namespace URI and that local name is already present in this map, it is replaced by the new one.

HTML-only DOM implementations do not need to implement this method.

Exceptions:

DOMException

WRONG_DOCUMENT_ERR: Raised if arg was created from a different document than the one that created this map.

NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.

INUSE_ATTRIBUTE_ERR: Raised if arg is an Attr that is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.

Node removeNamedItemNS(const DOMString& namespaceURI, const DOMString& localName)

Parameters:

namespaceURI: The namespace URI of the node to remove.
localName: The local name of the node to remove.

Description:

Removes a node specified by local name and namespace URI. A removed attribute may be known to have a default value when this map contains the attributes attached to an element, as returned by the attributes attribute of the Node interface. If so, an attribute immediately appears containing the default value as well as the corresponding namespace URI, local name, and prefix when applicable.

HTML-only DOM implementations do not need to implement this method.

Exceptions:

DOMException

NOT_FOUND_ERR: Raised if there is no node with the specified namespaceURI and localName in this map.

NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.

This file has been generated automatically on Tue Nov 27 17:13:14 EST 2001 as part of GMetaDOM. For more information see the home page of the project, or contact the main author: luca.padovani@cs.unibo.it.