Interface for XML comments. More...

#include <ilog/xml.h>

Inheritance diagram for IlXmlCommentI:

Public Member Functions
virtual const char *	getComment () const =0
	Retrieves the comment content. More...

virtual Type	getType () const
	Retrieves the type of this element. More...

virtual void	setComment (const char *comment)
	Sets the comment content. More...

virtual void	storeComment (char *comment)=0
	Sets the comment content. More...

Public Member Functions inherited from IlXmlNodeI
virtual std::ostream &	write (std::ostream &stream) const =0
	Writes the XML code for this node. More...

Additional Inherited Members
Public Types inherited from IlXmlNodeI
enum	Type { Attribute, Element, Text, Comment, CData, PI, CharRef, EntityRef }
	The different types of XML nodes. More...

Detailed Description

Interface for XML comments.

Library: ilog

This class is an interface that describes an XML comment node.

Member Function Documentation

virtual const char* IlXmlCommentI::getComment ( ) const

pure virtual

Retrieves the comment content.

Returns: The comment content. The user must not modify or delete the returned string.

Implemented in IlXmlComment.

virtual Type IlXmlCommentI::getType ( ) const

virtual

Retrieves the type of this element.

Implements IlXmlNodeI.

virtual void IlXmlCommentI::setComment ( const char * comment )

virtual

Sets the comment content.

Parameters

comment The new content of this comment. The default implementation calls storeTag with a copy of the string comment.

virtual void IlXmlCommentI::storeComment ( char * comment )

pure virtual

Sets the comment content.

Parameters

comment The new content of this comment. This string is not copied before it is stored.

Implemented in IlXmlComment.