List of all members
clan::DomComment Class Reference
clanCore XML

DOM Comment class. More...

`#include <dom_comment.h>`

Inheritance diagram for clan::DomComment:

## Public Member Functions
Construction
| DomComment ()
| Constructs a DOM Comment handle. More...
| DomComment (DomDocument &doc, const DomString &data)
| Constructs a DomComment. More...
| DomComment (const std::shared_ptr< DomNode_Impl > &impl)
| Constructs a DomComment. More...
| ~DomComment ()
Public Member Functions inherited from clan::DomCharacterData
| DomCharacterData ()
| Constructs a DOM CharacterData handle. More...
| DomCharacterData (const std::shared_ptr< DomNode_Impl > &impl)
| Constructs a DomCharacterData. More...
| ~DomCharacterData ()
unsigned long | get_length ()
| The number of characters that are available through data and the substringData method below. More...
DomString | substring_data (unsigned long offset, unsigned long count)
| Extracts a range of data from the node. More...
void | append_data (const DomString &arg)
| Append the string to the end of the character data of the node. More...
void | insert_data (unsigned long offset, const DomString &arg)
| Insert a string at the specified character offset. More...
void | delete_data (unsigned long offset, unsigned long count)
| Remove a range of characters from the node. More...
void | replace_data (unsigned long offset, unsigned long count, const DomString &arg)
| Replace the characters starting at the specified character offset with the specified string. More...
Public Member Functions inherited from clan::DomNode
| DomNode ()
| DomNode (const DomNode &copy)
| Constructs a DomNode. More...
| ~DomNode ()
DomNode & | operator= (const DomNode &copy)
| Copy assignment operator. More...
bool | operator== (const DomNode &other) const
| Compare operator. More...
bool | operator!= (const DomNode &other) const
| Compare operator. More...
void | normalize ()
| Merges any adjacent Text nodes. More...
DomNode | insert_before (DomNode &new_child, DomNode &ref_child)
| Inserts the node new_child before the existing child node ref_child. More...
DomNode | replace_child (DomNode &new_child, DomNode &old_child)
| Replaces the child node old_child with new_child in the list of children. More...
DomNode | remove_child (DomNode &old_child)
| Removes the child node indicated by old_child from the list of children, and returns it. More...
DomNode | append_child (DomNode new_child)
| Adds the node new_child to the end of the list of children of this node. More...
DomNode | clone_node (bool deep) const
| Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. More...
DomElement | to_element () const
| Returns the Element interface to this node. More...
DomAttr | to_attr () const
| Returns the Attribute interface to this node. More...
DomText | to_text () const
| Returns the Text interface to this node. More...
DomCDATASection | to_cdata_section () const
| Returns the CDATA Section interface to this node. More...
DomEntityReference | to_entity_reference () const
| Returns the Entity Reference interface to this node. More...
DomEntity | to_entity () const
| Returns the Entity interface to this node. More...
DomProcessingInstruction | to_processing_instruction () const
| Returns the Processing Instruction interface to this node. More...
DomComment | to_comment () const
| Returns the Comment interface to this node. More...
DomDocument | to_document () const
| Returns the Document interface to this node. More...
DomDocumentType | to_document_type () const
| Returns the Document Type interface to this node. More...
DomDocumentFragment | to_document_fragment () const
| Returns the Document Fragment interface to this node. More...
DomNotation | to_notation () const
| Returns the Notation interface to this node. More...
DomNode | named_item (const DomString &name) const
| Returns the first child node with the specified node name. More...
DomNode | named_item_ns (const DomString &namespace_uri, const DomString &local_name) const
| Retrieves the first child node with the specified namespace URI and local name. More...
DomString | find_namespace_uri (const DomString &qualified_name) const
| Searches the node tree upwards for the namespace URI of the given qualified name. More...
DomString | find_prefix (const DomString &namespace_uri) const
| Searches the node tree upwards for the prefix name for the namespace URI. More...
std::vector< DomNode > | select_nodes (const DomString &xpath_expression) const
| Returns all the nodes matching the specified xpath expression using this node as the context node. More...
DomNode | select_node (const DomString &xpath_expression) const
| Returns the first node matching the specified xpath expression using this node as the context node. More...
std::string | select_string (const DomString &xpath_expression) const
| Returns the first node value matching the specified xpath expression using this node as the context node. More...
int | select_int (const DomString &xpath_expression) const
| Returns the first node value (as integer) matching the specified xpath expression using this node as the context node. More...
float | select_float (const DomString &xpath_expression) const
| Returns the first node value (as float) matching the specified xpath expression using this node as the context node. More...
bool | select_bool (const DomString &xpath_expression) const
| Returns the first node value (as boolean) matching the specified xpath expression using this node as the context node. More...
DomString | get_node_name () const
| Returns the node name. More...
DomString | get_namespace_uri () const
| Returns the namespace URI of this node. More...
DomString | get_prefix () const
| Returns the namespace prefix of the node. More...
void | set_prefix (const DomString &prefix)
| Sets the namespace prefix of the node. More...
DomString | get_local_name () const
| Returns local part of the qualified name of this node. More...
DomString | get_node_value () const
| Returns the node value. More...
void | set_node_value (const DomString &value)
| Sets the node value. More...
unsigned short | get_node_type () const
| Returns the node type (one of those in the NodeType enum). More...
DomNode | get_parent_node () const
| Returns the parent of this node. More...
DomNodeList | get_child_nodes () const
| Returns a NodeList that contains all children of this node. More...
DomNode | get_first_child () const
| The first child of this node. More...
DomNode | get_last_child () const
| The last child of this node. More...
DomNode | get_previous_sibling () const
| The node immediately preceding this node. More...
DomNode | get_next_sibling () const
| The node immediately following this node. More...
DomNamedNodeMap | get_attributes () const
| A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise. More...
DomDocument | get_owner_document () const
| The Document object associated with this node. More...
bool | is_null () const
| Returns true if this is a null node. More...
bool | is_element () const
| Returns true if this is an element node. More...
bool | is_attr () const
| Returns true if this is an attribute node. More...
bool | is_text () const
| Returns true if this is a text node. More...
bool | is_cdata_section () const
| Returns true if this is a CDATA section node. More...
bool | is_entity_reference () const
| Returns true if this is an entity reference node. More...
bool | is_entity () const
| Returns true if this is an entity node. More...
bool | is_processing_instruction () const
| Returns true if this is a processing instruction node. More...
bool | is_comment () const
| Returns true if this is a comment node. More...
bool | is_document () const
| Returns true if this is a document node. More...
bool | is_document_type () const
| Returns true if this is a document type node. More...
bool | is_document_fragment () const
| Returns true if this is a document fragment node. More...
bool | is_notation () const
| Returns true if this is a notation node. More...
bool | is_supported (const DomString &feature, const DomString &version) const
| Tests whether the DOM implementation implements a specific feature and that feature is supported by this node. More...
bool | has_attributes () const
| Returns true if this node (if its an element) has any attributes. More...
bool | has_child_nodes () const
| Returns true if this node has any children. More...

## Additional Inherited Members
Public Types inherited from clan::DomNode
enum | NodeType { NULL_NODE = 0, 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 }
| An integer indicating which type of node this is. More...
Protected Member Functions inherited from clan::DomCharacterData
| DomCharacterData (DomDocument &doc, unsigned short node_type)
| Constructs a DomCharacterData. More...
Protected Member Functions inherited from clan::DomNode
| DomNode (DomDocument doc, unsigned short node_type)
| Constructs a DomNode. More...
| DomNode (const std::shared_ptr< DomNode_Impl > &impl)
| Constructs a DomNode. More...
Protected Attributes inherited from clan::DomNode
std::shared_ptr< DomNode_Impl > | impl

## Detailed Description

DOM Comment class.

This represents the content of a comment, i.e., all the characters between the starting '<!–' and ending '–>'. Note that this is the definition of a comment in XML, and, in practice, HTML, although some HTML tools may implement the full SGML comment structure.

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

- dom_comment.h