Rogue Wave Views
Foundation Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlXmlCharRefI Class Referenceabstract

Interface for XML CharRefs. More...

#include <ilog/xml.h>

Inheritance diagram for IlXmlCharRefI:
IlXmlNodeI IlXmlCharRef

Public Member Functions

virtual int getRefCode () const =0
 Retrieves the character code. More...
 
virtual const char * getRefName () const =0
 Retrieves the name of this CharRef. More...
 
virtual Type getType () const
 Retrieves the type of this element. More...
 
virtual void setRefCode (int code)=0
 Sets the character code. More...
 
virtual void setRefName (const char *name)
 Sets the CharRef name. More...
 
virtual void storeRefName (char *name)=0
 Sets the CharRef name. 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 CharRefs.

Library: ilog

This class is an interface that describes an XML character reference node.

Member Function Documentation

§ getRefCode()

virtual int IlXmlCharRefI::getRefCode ( ) const
pure virtual

Retrieves the character code.

Returns
The character code, or 0 if this CharRef does not correspond to a code (then getRefName() returns a meaningful value).
See also
getRefName().

Implemented in IlXmlCharRef.

§ getRefName()

virtual const char* IlXmlCharRefI::getRefName ( ) const
pure virtual

Retrieves the name of this CharRef.

Returns
The name of this CharRef. The user must not modify or delete the returned string. This is meaningful only if this CharRef does not correspond to a character code.

Implemented in IlXmlCharRef.

§ getType()

virtual Type IlXmlCharRefI::getType ( ) const
virtual

Retrieves the type of this element.

Returns
The type of this element.

Implements IlXmlNodeI.

§ setRefCode()

virtual void IlXmlCharRefI::setRefCode ( int  code)
pure virtual

Sets the character code.

Parameters
codeThe new character code for this CharRef.

Implemented in IlXmlCharRef.

§ setRefName()

virtual void IlXmlCharRefI::setRefName ( const char *  name)
virtual

Sets the CharRef name.

Parameters
nameThe new name of this CharRef. The default implementation calls storeRefName() with a copy of the string name.

§ storeRefName()

virtual void IlXmlCharRefI::storeRefName ( char *  name)
pure virtual

Sets the CharRef name.

Parameters
nameThe new name of this CharRef. This string is not copied before it is stored.

Implemented in IlXmlCharRef.


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