|
|
Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members
DOM_Attr Class ReferenceThe DOM_Attr class refers to an attribute of an XML element.
More...
#include <DOM_Attr.hpp>
Inheritance diagram for DOM_Attr:
Collaboration diagram for DOM_Attr:
List of all members. Public Methods
|
|
|
|
- DOMString getName () const
- Returns the name of this attribute.
- bool getSpecified () const
- Returns true if the attribute received its value explicitly in the XML document, or if a value was assigned programatically with the setValue function. More...
- DOMString getValue () const
- Returns the value of the attribute. More...
|
|
Protected Methods
Friends
Detailed Description
The DOM_Attr
class refers to an attribute of an XML element.
Typically the allowable values for the
attribute are defined in a documenttype definition.
DOM_Attr
objects inherit the DOM_Node
interface, but
since attributes are not actually child nodes of the elements they are associated with, the
DOM does not consider them part of the document tree. Thus, the
DOM_Node
attributes parentNode
,
previousSibling
, and nextSibling
have a null
value for DOM_Attr
objects. The DOM takes the view that
attributes are properties of elements rather than having a separate
identity from the elements they are associated with; this should make it
more efficient to implement such features as default attributes associated
with all elements of a given type. Furthermore, attribute nodes
may not be immediate children of a DocumentFragment
. However,
they can be associated with Element
nodes contained within a
DocumentFragment
. In short, users of the DOM
need to be aware that Attr
nodes have some things in common
with other objects inheriting the Node
interface, but they
also are quite distinct.
Constructor & Destructor Documentation
Default constructor for DOM_Attr.
The resulting object does not
refer to any Attribute; it will compare == to 0, and is similar
to a null object reference variable in Java.
DOM_Attr::DOM_Attr (
|
const DOM_Attr & other) |
|
Copy constructor.
Creates a new DOM_Attr
that refers to the
same underlying Attribute as the original. See also DOM_Node::clone(),
which will copy an actual attribute, rather than just creating a new
reference to the original attribute.
-
Parameters:
-
other
|
The source attribute reference object
|
Destructor.
The object being destroyed is a reference to the Attribute
"node", not the underlying attribute itself.
DOM_Attr::DOM_Attr (
|
AttrImpl * attr) [protected] |
|
Member Function Documentation
Returns the name of this attribute.
The DOM_Element
node this attribute is attached to or null
if this attribute is not in use.
"Experimental - subject to change"
bool DOM_Attr::getSpecified () const |
|
Returns true if the attribute received its value explicitly in the XML document, or if a value was assigned programatically with the setValue function.
Returns false if the attribute value
came from the default value declared in the document's DTD.
Returns the value of the attribute.
The value of the attribute is returned as a string.
Character and general entity references are replaced with their values.
DOM_Attr & DOM_Attr::operator= (
|
const DOM_NullPtr * val) |
|
Assignment operator.
This overloaded variant is provided for
the sole purpose of setting a DOM_Node reference variable to
zero. Nulling out a reference variable in this way will decrement
the reference count on the underlying Node object that the variable
formerly referenced. This effect is normally obtained when reference
variable goes out of scope, but zeroing them can be useful for
global instances, or for local instances that will remain in scope
for an extended time, when the storage belonging to the underlying
node needs to be reclaimed.
-
Parameters:
-
val.
|
Only a value of 0, or null, is allowed.
|
Reimplemented from DOM_Node.
DOM_Attr & DOM_Attr::operator= (
|
const DOM_Attr & other) |
|
Assignment operator.
-
Parameters:
-
other
|
The source attribute object
|
void DOM_Attr::setValue (
|
const DOMString & value) |
|
Sets the value of the attribute.
A text node with the unparsed contents
of the string will be created.
-
Parameters:
-
value
|
The value of the DOM attribute to be set
|
Friends And Related Function Documentation
class DOM_Document [friend] |
|
class DOM_Element [friend] |
|
The documentation for this class was generated from the following file: