class DOM_Comment : public DOM_CharacterData

Class to refer to XML comment nodes in the DOM

Inheritance:

Public

	Constructors and assignment operators DOM_Comment () Default constructor for DOM_Comment DOM_Comment (const DOM_Comment &other) Copy constructor DOM_Comment& operator = (const DOM_Comment &other) Assignment operator DOM_Comment& operator = (const DOM_NullPtr *val) Assignment operator
	Destructor. ~DOM_Comment () Destructor for DOM_Comment

Inherited from DOM_CharacterData:

Public

Constructors and assignment operator

DOM_CharacterData()

Default constructor for DOM_CharacterData

DOM_CharacterData(const DOM_CharacterData &other)

Copy constructor

DOM_CharacterData& operator = (const DOM_CharacterData &other)

Assignment operator

Functions that set or change data.

void appendData(const DOMString &arg)

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

void insertData(int offset, const DOMString &arg)

Insert a string at the specified character offset

void deleteData(int offset, int count)

Remove a range of characters from the node

void replaceData(int offset, int count, const DOMString &arg)

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

void setData(const DOMString &data)

Sets the character data of the node that implements this interface

Getter functions.

DOMString getData() const

Returns the character data of the node that implements this interface

int getLength() const

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

DOMString substringData(int offset, int count) const

Extracts a range of data from the node

Inherited from DOM_Node:

Public

Cloning function.

DOM_Node cloneNode(bool deep) const

Returns a duplicate of this node

Equality and Inequality operators.

bool operator == (const DOM_Node & other) const

The equality operator

bool operator == (const DOM_NullPtr *other) const

Compare with a pointer

bool operator != (const DOM_Node & other) const

The inequality operator

bool operator != (const DOM_NullPtr * other) const

Compare with a pointer

Functions to modify the DOM Node.

DOM_Node insertBefore(const DOM_Node &newChild, const DOM_Node &refChild)

Inserts the node newChild before the existing child node refChild

DOM_Node replaceChild(const DOM_Node &newChild, const DOM_Node &oldChild)

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

DOM_Node removeChild(const DOM_Node &oldChild)

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

DOM_Node appendChild(const DOM_Node &newChild)

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

Get functions.

DOMString getNodeName() const

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

DOMString getNodeValue() const

Gets the value of this node, depending on its type

short getNodeType() const

An enum value representing the type of the underlying object

DOM_Node getParentNode() const

Gets the parent of this node

DOM_NodeList getChildNodes() const

Gets a NodeList that contains all children of this node

DOM_Node getFirstChild() const

Gets the first child of this node

DOM_Node getLastChild() const

Gets the last child of this node

DOM_Node getPreviousSibling() const

Gets the node immediately preceding this node

DOM_Node getNextSibling() const

Gets the node immediately following this node

DOM_NamedNodeMap getAttributes() const

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

DOM_Document getOwnerDocument() const

Gets the Document object associated with this node

void* getUserData() const

Return the user data pointer

Query functions.

bool hasChildNodes() const

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

bool isNull() const

Test whether this node is null

Set functions.

void setNodeValue(const DOMString &nodeValue)

Sets the value of the node

void setUserData(void *p)

Set the user data for a node

Constructors and assignment operators

DOM_Comment()

Default constructor for DOM_Comment. The resulting object does not refer to an actual Comment node; it will compare == to 0, and is similar to a null object reference variable in Java. It may subsequently be assigned to refer to an actual comment node.

New comment nodes are created by DOM_Document::createComment().

DOM_Comment(const DOM_Comment &other)

Copy constructor. Creates a new DOM_Comment that refers to the same underlying node as the original. See also DOM_Node::clone(), which will copy the actual Comment node, rather than just creating a new reference to the original node.

Parameters:

other - The object to be copied.

DOM_Comment& operator = (const DOM_Comment &other)

Assignment operator.

Parameters:

other - The object to be copied.

DOM_Comment& operator = (const DOM_NullPtr *val)

Assignment operator. This overloaded variant is provided for the sole purpose of setting a DOM_Node reference variable to zero. Nulling out a reference variable in this way will decrement the reference count on the underlying Node object that the variable formerly referenced. This effect is normally obtained when reference variable goes out of scope, but zeroing them can be useful for global instances, or for local instances that will remain in scope for an extended time, when the storage belonging to the underlying node needs to be reclaimed.

Parameters:

val. - Only a value of 0, or null, is allowed.

Destructor.

~DOM_Comment()

Destructor for DOM_Comment. The object being destroyed is the reference object, not the underlying Comment node itself.

alphabetic index hierarchy of classes