rwlogo

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
List of all members | Public Member Functions
IlXmlCommentI Class Referenceabstract

Interface for XML comments. More...

#include <ilog/xml.h>

Inheritance diagram for IlXmlCommentI:
IlXmlNodeI IlXmlComment

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.

Returns
The type of this element.

Implements IlXmlNodeI.

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

Sets the comment content.

Parameters
commentThe 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
commentThe new content of this comment. This string is not copied before it is stored.

Implemented in IlXmlComment.


© Copyright 2015, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.