|  | 
Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members 
 DOM_NamedNodeMap  Class ReferenceNamedNodeMaps are used to represent collections of nodes that can be accessed by name. 
More...
#include <DOM_NamedNodeMap.hpp> 
List of all members. 
 Detailed DescriptionNamedNodeMaps are used to represent collections of nodes that can be accessed by name.
Note that NamedNodeMapdoes not inherit fromNodeList;NamedNodeMaps are not maintained in any particular order.  Nodes contained in aNamedNodeMapmay  also be accessed by an ordinal index, but this is simply to allow  convenient enumeration of the contents, and  does not imply that the DOM specifies an order to these Nodes. 
 
 Constructor & Destructor Documentation
 
  
    | 
        
          | DOM_NamedNodeMap::DOM_NamedNodeMap ( | ) |  |  
  
    |  | 
Default constructor for DOM_NamedNodeMap.
 
The resulting object does not refer to an actual DOM_NamedNodeMap node; it will compare == to 0, and is similar to a null object reference variable in Java. NamedNopes are instantiated by these methods: DOM_Node::getAttributes, DOM_DocumentType::getEntities andDOM_DocumentType::getNotations      |  
 
  
    | 
        
          | DOM_NamedNodeMap::DOM_NamedNodeMap ( | const DOM_NamedNodeMap & other ) |  |  
  
    |  | 
Copy constructor.
 
Creates a new DOM_NamedNodeMapreference object  that refers to the same underlying NamedNodeMap as the original. 
Parameters: 
| other | The object to be copied. | 
 |  
 
  
    | 
        
          | DOM_NamedNodeMap::~DOM_NamedNodeMap ( | ) |  |  
  
    |  | 
Destructor for DOM_NamedNodeMap.
 
The object being destroyed is the reference object, not the underlying NamedNodeMap itself.
 
 
Like most other DOM types in this implementation, memory management of named node maps is automatic. Instances of DOM_NamedNodeMap function as references to an underlying heap based implementation object, and should never be explicitly new-ed or deleted in application code, but should appear only as local variables or function parameters.      |  
 
  
    | 
        
          | DOM_NamedNodeMap::DOM_NamedNodeMap ( | NamedNodeMapImpl * impl )  [protected] |  |  
 
  
    | 
        
          | DOM_NamedNodeMap::DOM_NamedNodeMap ( | NodeImpl * impl )  [protected] |  |  
 Member Function Documentation
 
  
    | 
        
          | unsigned int DOM_NamedNodeMap::getLength ( | ) const |  |  
  
    |  | 
The number of nodes in the map.
 
The range of valid child node indices is  0 to length-1inclusive. |  
 
  
    |  | 
Retrieves a node specified by name.
 
 
Parameters: 
| name | The nodeNameof a node to retrieve. | 
 
Returns: 
 A DOM_Node(of any type) with the specifiednodeName, ornullif it does not identify any node in  the map.
 |  
 
  
    |  | 
Retrieves a node specified by local name and namespace URI.
 
 
"Experimental - subject to change" 
Parameters: 
| namespaceURI | The namespace URI of the node to retrieve. |  | localName | The local name of the node to retrieve. | 
 
Returns: 
 A DOM_Node(of any type) with the specified local name and namespace URI, ornullif they do not identify any node in the map.
 |  
 
  
    | 
        
          | DOM_Node DOM_NamedNodeMap::item ( | unsigned int index ) const |  |  
  
    |  | 
Returns the indexth item in the map. 
If indexis greater than or equal to the number of nodes in the map, this returnsnull. 
Parameters: 
| index | Index into the map. | 
 
Returns: 
 The node at the indexth position in theNamedNodeMap, ornullif that is not a valid  index.
 |  
 
  
    | 
        
          | bool DOM_NamedNodeMap::operator!= ( | const DOM_NullPtr * p ) const |  |  
  
    |  | 
Use this comparison operator to test whether a Named Node Map reference is not null.
 
 
Parameters: 
| arg | p The value to be compared, which must not be 0 or null. | 
 
Returns: 
 Returns true if the named node map is not null 
 |  
 
  
    | 
        
          | bool DOM_NamedNodeMap::operator!= ( | const DOM_NamedNodeMap & other ) const |  |  
  
    |  | 
Test whether this NamedNodeMap reference refers to a different underlying named node map as the other reference object.
 
This does not compare the contents of two different objects. 
Parameters: 
| arg | p The value to be compared | 
 
Returns: 
 Returns true if the underlying named node map is different 
 |  
 
  
    | 
        
          | DOM_NamedNodeMap & DOM_NamedNodeMap::operator= ( | const DOM_NullPtr * other ) |  |  
  
    |  | 
Assignment operator.
 
 
Parameters: 
| other | The object to be copied. | 
 |  
 
  
    | 
        
          | DOM_NamedNodeMap & DOM_NamedNodeMap::operator= ( | const DOM_NamedNodeMap & other ) |  |  
  
    |  | 
Assignment operator.
 
 
Parameters: 
| other | The object to be copied. | 
 |  
 
  
    | 
        
          | bool DOM_NamedNodeMap::operator== ( | const DOM_NullPtr * p ) const |  |  
  
    |  | 
Use this comparison operator to test whether a Named Node Map reference is null.
 
 
Parameters: 
| arg | p The value to be compared, which must be 0 or null. | 
 
Returns: 
 Returns true if the named node map is null 
 |  
 
  
    | 
        
          | bool DOM_NamedNodeMap::operator== ( | const DOM_NamedNodeMap & other ) const |  |  
  
    |  | 
Test whether this NamedNodeMap reference refers to the same underlying named node map as the other reference object.
 
This does not compare the contents of two different objects. 
Parameters: 
| arg | p The value to be compared | 
 
Returns: 
 Returns true if the underlying named node map is same 
 |  
 
  
    |  | 
Removes a node specified by name.
 
If the removed node is an  Attrwith a default value it is immediately replaced. 
Parameters: 
| name | The nodeNameof a node to remove. | 
 
Returns: 
 The node removed from the map or nullif no node  with such a name exists.
 
Exceptions: 
| DOMException | NOT_FOUND_ERR: Raised if there is no node named namein  the map.NO_MODIFICATION_ALLOWED_ERR: Raised if this
 NamedNodeMapis readonly. | 
 |  
 
  
    |  | 
Removes a node specified by local name and namespace URI.
 
 
"Experimental - subject to change" 
Parameters: 
| namespaceURI | The namespace URI of the node to remove. |  | localName | The local name of the node to remove. When this DOM_NamedNodeMapcontains the attributes attached to an element, as returned by the attributes attribute of theDOM_Nodeinterface, 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. | 
 
Returns: 
 The node removed from the map if a node with such a local name and namespace URI exists. 
 
Exceptions: 
| DOMException | NOT_FOUND_ERR: Raised if there is no node named namein  the map.NO_MODIFICATION_ALLOWED_ERR: Raised if this
 DOM_NamedNodeMapis readonly. | 
 |  
 
  
    |  | 
Adds a node using its nodeNameattribute. 
As the
 nodeNameattribute 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. 
Parameters: 
| arg | A node to store in a named node map. The node will later be  accessible using the value of the nodeNameattribute of  the node. If a node with that name is already present in the map, it  is replaced by the new one. | 
 
Returns: 
 If the new Nodereplaces an existing node the replacedNodeis returned,  otherwisenullis returned.
 
Exceptions: 
| DOMException | WRONG_DOCUMENT_ERR: Raised if argwas created from a  different document than the one that created theNamedNodeMap.NO_MODIFICATION_ALLOWED_ERR: Raised if this
 NamedNodeMapis readonly.INUSE_ATTRIBUTE_ERR: Raised if
 argis anAttrthat is already an attribute of anotherElementobject. The DOM user must explicitly cloneAttrnodes to re-use them in other elements. | 
 |  
 
  
    |  | 
Adds a node using its namespaceURIandlocalName. 
 
"Experimental - subject to change" 
Parameters: 
| arg | A node to store in a named node map. The node will later be  accessible using the value of the namespaceURIandlocalNameattribute of the node. If a node with those  namespace URI and local name is already present in the map, it is  replaced by the new one. | 
 
Returns: 
 If the new DOM_Nodereplaces an existing node the replacedDOM_Nodeis returned,  otherwisenullis returned.
 
Exceptions: 
| DOMException | WRONG_DOCUMENT_ERR: Raised if argwas created from a  different document than the one that created theDOM_NamedNodeMap.NO_MODIFICATION_ALLOWED_ERR: Raised if this
 vNamedNodeMapis readonly.INUSE_ATTRIBUTE_ERR: Raised if
 argis anDOM_Attrthat is already an attribute of anotherDOM_Elementobject. The DOM user must explicitly cloneDOM_Attrnodes to re-use them in other elements. | 
 |  
 Friends And Related Function Documentation
 
  
    | 
        
          | class DOM_DocumentType  [friend] |  |  
 The documentation for this class was generated from the following file:
 |