rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlXmlCommentI Class Reference

Interface for XML comments. More...

#include <ilog/xml.h>

Inheritance diagram for IlXmlCommentI:
IlXmlNodeI IlXmlComment

List of all members.

Public Member Functions

virtual const char * getComment () const =0
 Retrieves the comment content.
virtual Type getType () const
 Retrieves the type of this element.
virtual void setComment (const char *comment)
 Sets the comment content.
virtual void storeComment (char *comment)=0
 Sets the comment content.
virtual ostream & write (ostream &) const
 Writes the XML code for this node.

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:
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.

virtual ostream& IlXmlCommentI::write ( ostream &  stream  )  const [virtual]

Writes the XML code for this node.

Each subclass of this class implements its own version of write, depending on its type.

Parameters:
stream The output stream where the XML code will be sent.
Returns:
A reference to the provided output stream.

Implements IlXmlNodeI.


© Copyright 2012, 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.