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
IlXmlComment Class Reference

Default implementation of XML comments. More...

#include <ilog/xml.h>

Inheritance diagram for IlXmlComment:
IlXmlCommentI IlXmlNodeI

Public Member Functions

virtual const char * getComment () const
 Retrieves the comment content. More...
 
virtual void storeComment (char *)
 Sets the comment content. More...
 
- Public Member Functions inherited from IlXmlCommentI
virtual Type getType () const
 Retrieves the type of this element. More...
 
virtual void setComment (const char *comment)
 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

Default implementation of XML comments.

Library: ilog

This class implements the interface IlXmlCommentI to provide the basic functionality of an XML comment node.

Member Function Documentation

virtual const char* IlXmlComment::getComment ( ) const
virtual

Retrieves the comment content.

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

Implements IlXmlCommentI.

virtual void IlXmlComment::storeComment ( char *  comment)
virtual

Sets the comment content.

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

Implements IlXmlCommentI.


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