All Classes |Grouped Classes |Index

Class CL_DomDocument

DOM Document class. More...

Derived from:

public CL_DomNode

Derived by:

None

Group:

XML (Core)

#include <ClanLib/core.h>

Class Members:

Construction:

CL_DomDocument

Constructs a DOM Document.


Attributes:

get_doctype

Returns the Document Type Declaration (see CL_DomDocumentType )associated with this document.

get_implementation

Returns the CL_DomImplementation object that handles this document.

get_document_element

Returns the root document element node.


Operations:

create_element

Creates an element of the type specified.

create_element_ns

Creates an element of the given qualified name and namespace URI.

create_document_fragment

Creates an empty DocumentFragment object.

create_text_node

Creates a Text node given the specified string.

create_comment

Creates a Comment node given the specified string.

create_cdata_section

Creates a CDATASection node whose value is the specified string.

create_processing_instruction

Creates a ProcessingInstruction node given the specified name and data strings.

create_attribute

Creates an Attr of the given name.

create_attribute_ns

Creates an attribute of the given qualified name and namespace URI.

create_entity_reference

Creates an EntityReference object.

get_elements_by_tag_name

Returns a NodeList of all the Elements with a given tag name.

get_elements_by_tag_name_ns

Returns a NodeList of all the Elements with a given local name and namespace URI.

get_element_by_id

Returns the Element whose ID is given by element_id.

import_node

Imports a node from another document to this document.

load

Loads the DOM document as XML from an input source.

save

Saves the DOM document as XML to an input source.

clear_all

Removes all nodes from the DOM document.


Attributes:

get_node_name

Returns the node name.

get_namespace_uri

Returns the namespace URI of this node.

get_prefix

Returns the namespace prefix of the node.

set_prefix

Sets the namespace prefix of the node.

get_local_name

Returns local part of the qualified name of this node.

get_node_value

Returns the node value.

set_node_value

Sets the node value.

get_node_type

Returns the node type (one of those in the NodeType enum).

get_parent_node

Returns the parent of this node.

get_child_nodes

Returns a NodeList that contains all children of this node.

get_first_child

The first child of this node.

get_last_child

The last child of this node.

get_previous_sibling

The node immediately preceding this node.

get_next_sibling

The node immediately following this node.

get_attributes

A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.

get_owner_document

The Document object associated with this node.

is_null

Returns true if this is a null node.

is_element

Returns true if this is an element node.

is_attr

Returns true if this is an attribute node.

is_text

Returns true if this is a text node.

is_cdata_section

Returns true if this is a CDATA section node.

is_entity_reference

Returns true if this is an entity reference node.

is_entity

Returns true if this is an entity node.

is_processing_instruction

Returns true if this is a processing instruction node.

is_comment

Returns true if this is a comment node.

is_document

Returns true if this is a document node.

is_document_type

Returns true if this is a document type node.

is_document_fragment

Returns true if this is a document fragment node.

is_notation

Returns true if this is a notation node.

is_supported

Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.

has_attributes

Returns true if this node (if its an element) has any attributes.

has_child_nodes

Returns true if this node has any children.

NodeType

An integer indicating which type of node this is.


Operations:

operator==

Compare operator.

operator!=

Compare operator.

normalize

Merges any adjacent Text nodes.

insert_before

Inserts the node new_child before the existing child node ref_child.

replace_child

Replaces the child node old_child with new_child in the list of children.

remove_child

Removes the child node indicated by old_child from the list of children, and returns it.

append_child

Adds the node new_child to the end of the list of children of this node.

clone_node

Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.

to_element

Returns the Element interface to this node.

to_attr

Returns the Attribute interface to this node.

to_text

Returns the Text interface to this node.

to_cdata_section

Returns the CDATA Section interface to this node.

to_entity_reference

Returns the Entity Reference interface to this node.

to_entity

Returns the Entity interface to this node.

to_processing_instruction

Returns the Processing Instruction interface to this node.

to_comment

Returns the Comment interface to this node.

to_document

Returns the Document interface to this node.

to_document_type

Returns the Document Type interface to this node.

to_document_fragment

Returns the Document Fragment interface to this node.

to_notation

Returns the Notation interface to this node.

named_item

Returns the first child node with the specified node name.

named_item_ns

Retrieves the first child node with the specified namespace URI and local name.

find_namespace_uri

Searches the node tree upwards for the namespace URI of the given qualified name.

find_prefix

Searches the node tree upwards for the prefix name for the namespace URI.

select_nodes

Returns all the nodes matching the specified xpath expression using this node as the context node.

select_node

Returns the first node matching the specified xpath expression using this node as the context node.

select_string

Returns the first node value matching the specified xpath expression using this node as the context node.

select_int

Returns the first node value (as integer) matching the specified xpath expression using this node as the context node.

select_float

Returns the first node value (as float) matching the specified xpath expression using this node as the context node.

select_bool

Returns the first node value (as boolean) matching the specified xpath expression using this node as the context node.

Detailed description:

The Document interface represents the entire HTML or XML document. Conceptually, it is the root of the document tree, and provides the primary access to the document's data.

Since elements, text nodes, comments, processing instructions, etc. cannot exist outside the context of a Document, the Document interface also contains the factory methods needed to create these objects. The Node objects created have a ownerDocument attribute which associates them with the Document within whose context they were created.