Home |All Classes |Grouped Classes |Index |Search

Class CL_DomElement

DOM Element class. More...

Derived from:	public CL_DomNode
Derived by:	None
Group:	XML (Core)

#include <ClanLib/core.h>

Class Members:

Construction:
CL_DomElement	Constructs a DOM Element handle.

Attributes:
get_tag_name	Returns the name of the element.

Operations:
has_attribute	Returns true if the element has the specified attribute.
has_attribute_ns	Returns true if the element has the specified attribute.
get_attribute	Returns the specified attribute.
get_attribute_ns	Returns the specified attribute.
set_attribute	Adds a new attribute.
set_attribute_ns
remove_attribute	Removes an attribute by name.
remove_attribute_ns
get_attribute_node
get_attribute_node_ns
set_attribute_node
set_attribute_node_ns
get_elements_by_tag_name	Returns a NodeList of all descendant elements with a given tag name.
get_elements_by_tag_name_ns
get_text	Returns the text of all child Text nodes appended together.
get_child_string	Returns the text value of the child node with the given tag name.
get_child_string_ns	Returns the text value of the child node with the given local name and namespace.
get_child_int	Returns the integer value of the child node with the given tag name.
get_child_int_ns	Returns the integer value of the child node with the given local name and namespace.
get_child_bool	Returns the boolean value of the child node with the given tag name.
get_child_bool_ns	Returns the boolean value of the child node with the given local name and namespace.
set_child_string	Sets the child node with the specified tag name to the given text value.
set_child_string_ns	Sets the child node with the specified qualified name and namespace to the given text value.
set_child_int	Sets the child node with the specified tag name to the given integer value.
set_child_int_ns	Sets the child node with the specified qualified name and namespace to the given integer value.
set_child_bool	Sets the child node with the specified tag name to the given boolean value.
set_child_bool_ns	Sets the child node with the specified qualified name and namespace to the given boolean value.
get_first_child_element	Returns the first child node that is an element node.
get_next_sibling_element	Returns the next sibling node that is an element node.

Detailed description:

By far the vast majority of objects (apart from text) that authors encounter when traversing a document are Element nodes. Assume the following XML document:

When represented using DOM, the top node is an Element node for "elementExample", which contains two child Element nodes, one for "subelement1" and one for "subelement2". "subelement1" contains no child nodes.

Elements may have attributes associated with them; since the Element interface inherits from Node, the generic Node interface method getAttributes may be used to retrieve the set of all attributes for an element. There are methods on the Element interface to retrieve either an Attr object by name or an attribute value by name. In XML, where an attribute value may contain entity references, an Attr object should be retrieved to examine the possibly fairly complex sub-tree representing the attribute value.