Main Page   Class Hierarchy   Compound List   File List   Compound Members  

DOM_Comment Class Reference

Inheritance diagram for DOM_Comment:

DOM_CharacterData DOM_Node List of all members.

Public Methods

Constructors and assignment operators
 DOM_Comment ()
 DOM_Comment (const DOM_Comment &other)
DOM_Comment & operator= (const DOM_Comment &other)
DOM_Comment & operator= (const DOM_NullPtr *val)
Destructor.
 ~DOM_Comment ()

Protected Methods

 DOM_Comment (CommentImpl *comment)

Friends

class DOM_Document

Detailed Description

Class to refer to XML comment nodes in the DOM.

The string value contains all of the characters between the starting '<!--' and ending '-->'.


Constructor & Destructor Documentation

DOM_Comment::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::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::~DOM_Comment  
 

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


Member Function Documentation

DOM_Comment & 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.

Reimplemented from DOM_CharacterData.

DOM_Comment & DOM_Comment::operator= const DOM_Comment &    other
 

Assignment operator.

Parameters:
other The object to be copied.


The documentation for this class was generated from the following files:
Generated on Tue Nov 19 09:36:38 2002 by doxygen1.3-rc1