Xerces-C++: DOMComment Class Reference (original) (raw)

This interface inherits from CharacterData and represents the content of a comment, i.e., all the characters between the starting ' <!–' and ending '–>'. More...

Public Member Functions

Destructor

virtual

~DOMComment ()

Destructor.

- Public Member Functions inherited from DOMCharacterData

virtual

~DOMCharacterData ()

Destructor.

virtual const XMLCh *

getData () const =0

Returns the character data of the node that implements this interface.

virtual XMLSize_t

getLength () const =0

Returns the number of characters that are available through data and the substringData method below.

virtual const XMLCh *

substringData (XMLSize_t offset, XMLSize_t count) const =0

Extracts a range of data from the node.

virtual void

appendData (const XMLCh *arg)=0

Append the string to the end of the character data of the node.

virtual void

insertData (XMLSize_t offset, const XMLCh *arg)=0

Insert a string at the specified character offset.

virtual void

deleteData (XMLSize_t offset, XMLSize_t count)=0

Remove a range of characters from the node.

virtual void

replaceData (XMLSize_t offset, XMLSize_t count, const XMLCh *arg)=0

Replace the characters starting at the specified character offset with the specified string.

virtual void

setData (const XMLCh *data)=0

Sets the character data of the node that implements this interface.

- Public Member Functions inherited from DOMNode

virtual

~DOMNode ()

Destructor.

virtual const XMLCh *

getNodeName () const =0

The name of this node, depending on its type; see the table above.

virtual const XMLCh *

getNodeValue () const =0

Gets the value of this node, depending on its type.

virtual NodeType

getNodeType () const =0

An enum value representing the type of the underlying object.

virtual DOMNode *

getParentNode () const =0

Gets the parent of this node.

virtual DOMNodeList *

getChildNodes () const =0

Gets a [DOMNodeList](classDOMNodeList.html "The DOMNodeList interface provides the abstraction of an ordered collection of nodes.") that contains all children of this node.

virtual DOMNode *

getFirstChild () const =0

Gets the first child of this node.

virtual DOMNode *

getLastChild () const =0

Gets the last child of this node.

virtual DOMNode *

getPreviousSibling () const =0

Gets the node immediately preceding this node.

virtual DOMNode *

getNextSibling () const =0

Gets the node immediately following this node.

virtual DOMNamedNodeMap *

getAttributes () const =0

Gets a [DOMNamedNodeMap](classDOMNamedNodeMap.html "DOMNamedNodeMaps are used to represent collections of nodes that can be accessed by name.") containing the attributes of this node (if it is an [DOMElement](classDOMElement.html "By far the vast majority of objects (apart from text) that authors encounter when traversing a docume...")) or null otherwise.

virtual DOMDocument *

getOwnerDocument () const =0

Gets the [DOMDocument](classDOMDocument.html "The DOMDocument interface represents the entire XML document.") object associated with this node.

virtual DOMNode *

cloneNode (bool deep) const =0

Returns a duplicate of this node.

virtual DOMNode *

insertBefore (DOMNode *newChild, DOMNode *refChild)=0

Inserts the node newChild before the existing child node refChild.

virtual DOMNode *

replaceChild (DOMNode *newChild, DOMNode *oldChild)=0

Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.

virtual DOMNode *

removeChild (DOMNode *oldChild)=0

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

virtual DOMNode *

appendChild (DOMNode *newChild)=0

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

virtual bool

hasChildNodes () const =0

This is a convenience method to allow easy determination of whether a node has any children.

virtual void

setNodeValue (const XMLCh *nodeValue)=0

Sets the value of the node.

virtual void

normalize ()=0

Puts all [DOMText](classDOMText.html "The DOMText interface inherits from DOMCharacterData and represents the textual content (termed chara...") nodes in the full depth of the sub-tree underneath this [DOMNode](classDOMNode.html "The DOMNode interface is the primary datatype for the entire Document Object Model."), including attribute nodes, into a "normal" form where only markup (e.g., tags, comments, processing instructions, CDATA sections, and entity references) separates [DOMText](classDOMText.html "The DOMText interface inherits from DOMCharacterData and represents the textual content (termed chara...") nodes, i.e., there are neither adjacent [DOMText](classDOMText.html "The DOMText interface inherits from DOMCharacterData and represents the textual content (termed chara...") nodes nor empty [DOMText](classDOMText.html "The DOMText interface inherits from DOMCharacterData and represents the textual content (termed chara...") nodes.

virtual bool

isSupported (const XMLCh *feature, const XMLCh *version) const =0

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

virtual const XMLCh *

getNamespaceURI () const =0

Get the namespace URI of this node, or null if it is unspecified.

virtual const XMLCh *

getPrefix () const =0

Get the namespace prefix of this node, or null if it is unspecified.

virtual const XMLCh *

getLocalName () const =0

Returns the local part of the qualified name of this node.

virtual void

setPrefix (const XMLCh *prefix)=0

Set the namespace prefix of this node.

virtual bool

hasAttributes () const =0

Returns whether this node (if it is an element) has any attributes.

virtual bool

isSameNode (const DOMNode *other) const =0

Returns whether this node is the same node as the given one.

virtual bool

isEqualNode (const DOMNode *arg) const =0

Tests whether two nodes are equal.

virtual void *

setUserData (const XMLCh *key, void *data, DOMUserDataHandler *handler)=0

Associate an object to a key on this node.

virtual void *

getUserData (const XMLCh *key) const =0

Retrieves the object associated to a key on a this node.

virtual const XMLCh *

getBaseURI () const =0

The absolute base URI of this node or null if undefined.

virtual short

compareDocumentPosition (const DOMNode *other) const =0

Compares the reference node, i.e.

virtual const XMLCh *

getTextContent () const =0

WARNING: This method is known to be buggy and does not produce accurate results under a variety of conditions.

virtual void

setTextContent (const XMLCh *textContent)=0

This attribute removes any possible children this node may have and, if the new string is not empty or null, replaced by a single [DOMText](classDOMText.html "The DOMText interface inherits from DOMCharacterData and represents the textual content (termed chara...") node containing the string this attribute is set to.

virtual const XMLCh *

lookupPrefix (const XMLCh *namespaceURI) const =0

Look up the prefix associated to the given namespace URI, starting from this node.

virtual bool

isDefaultNamespace (const XMLCh *namespaceURI) const =0

This method checks if the specified namespaceURI is the default namespace or not.

virtual const XMLCh *

lookupNamespaceURI (const XMLCh *prefix) const =0

Look up the namespace URI associated to the given prefix, starting from this node.

virtual void *

getFeature (const XMLCh *feature, const XMLCh *version) const =0

This method makes available a [DOMNode](classDOMNode.html "The DOMNode interface is the primary datatype for the entire Document Object Model.")'s specialized interface.

virtual void

release ()=0

Called to indicate that this Node (and its associated children) is no longer in use and that the implementation may relinquish any resources associated with it and its associated children.

This interface inherits from CharacterData and represents the content of a comment, i.e., all the characters between the starting ' <!–' and ending '–>'.

See also the Document Object Model (DOM) Level 2 Core Specification.

Since

DOM Level 1