DOM::Attr Class Reference

#include <dom_element.h>

Inheritance diagram for DOM::Attr:

Public Member Functions
	Attr (const Attr &other)
	Attr (const Node &other)
DOMString	name () const
Attr &	operator= (const Attr &other)
Attr &	operator= (const Node &other)
Element	ownerElement () const
void	setValue (const DOMString &)
bool	specified () const
DOMString	value () const
Public Member Functions inherited from DOM::Node
	Node (const Node &other)
	Node (NodeImpl *_impl)
void	addEventListener (const DOMString &type, EventListener *listener, const bool useCapture)
Node	appendChild (const Node &newChild)
void	applyChanges ()
NamedNodeMap	attributes () const
NodeList	childNodes () const
Node	cloneNode (bool deep)
unsigned	compareDocumentPosition (const DOM::Node &other)
bool	dispatchEvent (const Event &evt)
quint32	elementId () const
Node	firstChild () const
KHTML_DEPRECATED void	getCursor (int offset, int &_x, int &_y, int &height)
QRect	getRect ()
NodeImpl *	handle () const
bool	hasAttributes ()
bool	hasChildNodes ()
unsigned long	index () const
Node	insertBefore (const Node &newChild, const Node &refChild)
bool	isNull () const
bool	isSupported (const DOMString &feature, const DOMString &version) const
Node	lastChild () const
DOMString	localName () const
DOMString	namespaceURI () const
Node	nextSibling () const
DOMString	nodeName () const
unsigned short	nodeType () const
DOMString	nodeValue () const
void	normalize ()
bool	operator!= (const Node &other) const
Node &	operator= (const Node &other)
bool	operator== (const Node &other) const
Document	ownerDocument () const
Node	parentNode () const
DOMString	prefix () const
Node	previousSibling () const
Node	removeChild (const Node &oldChild)
void	removeEventListener (const DOMString &type, EventListener *listener, bool useCapture)
Node	replaceChild (const Node &newChild, const Node &oldChild)
void	setNodeValue (const DOMString &)
void	setPrefix (const DOMString &prefix)
void	setTextContent (const DOMString &text)
DOMString	textContent () const
KHTML_DEPRECATED QString	toHTML ()

Protected Member Functions
	Attr (AttrImpl *_impl)

Additional Inherited Members
Public Types inherited from DOM::Node
enum	DocumentPosition {   DOCUMENT_POSITION_DISCONNECTED = 0x01, DOCUMENT_POSITION_PRECEDING = 0x02, DOCUMENT_POSITION_FOLLOWING = 0x04, DOCUMENT_POSITION_CONTAINS = 0x08,   DOCUMENT_POSITION_CONTAINED_BY = 0x10, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0x20 }
enum	NodeType {   ELEMENT_NODE = 1, ATTRIBUTE_NODE = 2, TEXT_NODE = 3, CDATA_SECTION_NODE = 4,   ENTITY_REFERENCE_NODE = 5, ENTITY_NODE = 6, PROCESSING_INSTRUCTION_NODE = 7, COMMENT_NODE = 8,   DOCUMENT_NODE = 9, DOCUMENT_TYPE_NODE = 10, DOCUMENT_FRAGMENT_NODE = 11, NOTATION_NODE = 12,   XPATH_NAMESPACE_NODE = 13 }
Protected Attributes inherited from DOM::Node
NodeImpl *	impl

Detailed Description

The Attr interface represents an attribute in an Element object.

Typically the allowable values for the attribute are defined in a document type definition.

Attr objects inherit the Node interface, but since they are not actually child nodes of the element they describe, the DOM does not consider them part of the document tree. Thus, the Node attributes parentNode , previousSibling , and nextSibling have a null value for 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, Attr nodes may not be immediate children of a DocumentFragment . However, they can be associated with Element nodes contained within a DocumentFragment . In short, users and implementors 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.

The attribute's effective value is determined as follows: if this attribute has been explicitly assigned any value, that value is the attribute's effective value; otherwise, if there is a declaration for this attribute, and that declaration includes a default value, then that default value is the attribute's effective value; otherwise, the attribute does not exist on this element in the structure model until it has been explicitly added. Note that the nodeValue attribute on the Attr instance can also be used to retrieve the string version of the attribute's value(s).

In XML, where the value of an attribute can contain entity references, the child nodes of the Attr node provide a representation in which entity references are not expanded. These child nodes may be either Text or EntityReference nodes. Because the attribute type may be unknown, there are no tokenized attribute values.

Definition at line 89 of file dom_element.h.

Member Function Documentation

name()

DOMString Attr::name

(

)

const

Returns the name of this attribute.

Definition at line 72 of file dom_element.cpp.

ownerElement()

Element Attr::ownerElement

(

)

const

Introduced in DOM Level 2.

The Element node this attribute is attached to or null if this attribute is not in use.

Definition at line 88 of file dom_element.cpp.

setValue()

void Attr::setValue

(

const DOMString &

newValue

)

see value

Definition at line 104 of file dom_element.cpp.

specified()

bool Attr::specified

(

)

const

If this attribute was explicitly given a value in the original document, this is true ; otherwise, it is false .

Note that the implementation is in charge of this attribute, not the user. If the user changes the value of the attribute (even if it ends up having the same value as the default value) then the specified flag is automatically flipped to true . To re-specify the attribute as the default value from the DTD, the user must delete the attribute. The implementation will then make a new attribute available with specified set to false and the default value (if one exists).

In summary:

• If the attribute has an assigned value in the document then specified is true , and the value is the assigned value.

• If the attribute has no assigned value in the document and has a default value in the DTD, then specified is false , and the value is the default value in the DTD.

• If the attribute has no assigned value in the document and has a value of #IMPLIED in the DTD, then the attribute does not appear in the structure model of the document.

Definition at line 80 of file dom_element.cpp.

value()

DOMString Attr::value

(

)

const

On retrieval, the value of the attribute is returned as a string.

Character and general entity references are replaced with their values.

On setting, this creates a Text node with the unparsed contents of the string.

Definition at line 96 of file dom_element.cpp.

---

The documentation for this class was generated from the following files:

• dom_element.h
• dom_element.cpp