RioEngine  0.1
My first attempt to create a 3D WYSIWYG Game Engine
TiXmlComment Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlComment:
TiXmlNode TiXmlBase

Public Member Functions

 TiXmlComment ()
 Constructs an empty comment. More...
 
 TiXmlComment (const char *_value)
 Construct a comment from text. More...
 
 TiXmlComment (const TiXmlComment &)
 
TiXmlComment & operator= (const TiXmlComment &base)
 
virtual ~TiXmlComment ()
 
virtual TiXmlNode * Clone () const
 Returns a copy of this Comment. More...
 
virtual void Print (FILE *cfile, int depth) const
 
virtual const char * Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)
 
virtual const TiXmlComment * ToComment () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
virtual TiXmlComment * ToComment ()
 Cast to a more defined type. Will return null not of the requested type. More...
 
virtual bool Accept (TiXmlVisitor *visitor) const
 
- Public Member Functions inherited from TiXmlNode
virtual ~TiXmlNode ()
 
const char * Value () const
 
const TIXML_STRING & ValueTStr () const
 
void SetValue (const char *_value)
 
void Clear ()
 Delete all the children of this node. Does not affect 'this'. More...
 
TiXmlNode * Parent ()
 One step up the DOM. More...
 
const TiXmlNode * Parent () const
 
const TiXmlNode * FirstChild () const
 The first child of this node. Will be null if there are no children. More...
 
TiXmlNode * FirstChild ()
 
const TiXmlNode * FirstChild (const char *value) const
 
TiXmlNode * FirstChild (const char *_value)
 The first child of this node with the matching 'value'. Will be null if none found. More...
 
const TiXmlNode * LastChild () const
 
TiXmlNode * LastChild ()
 The last child of this node. Will be null if there are no children. More...
 
const TiXmlNode * LastChild (const char *value) const
 
TiXmlNode * LastChild (const char *_value)
 The last child of this node matching 'value'. Will be null if there are no children. More...
 
const TiXmlNode * IterateChildren (const TiXmlNode *previous) const
 
TiXmlNode * IterateChildren (const TiXmlNode *previous)
 
const TiXmlNode * IterateChildren (const char *value, const TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'. More...
 
TiXmlNode * IterateChildren (const char *_value, const TiXmlNode *previous)
 
TiXmlNode * InsertEndChild (const TiXmlNode &addThis)
 
TiXmlNode * LinkEndChild (TiXmlNode *addThis)
 
TiXmlNode * InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
 
TiXmlNode * InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
 
TiXmlNode * ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
 
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node. More...
 
const TiXmlNode * PreviousSibling () const
 Navigate to a sibling node. More...
 
TiXmlNode * PreviousSibling ()
 
const TiXmlNode * PreviousSibling (const char *) const
 Navigate to a sibling node. More...
 
TiXmlNode * PreviousSibling (const char *_prev)
 
const TiXmlNode * NextSibling () const
 Navigate to a sibling node. More...
 
TiXmlNode * NextSibling ()
 
const TiXmlNode * NextSibling (const char *) const
 Navigate to a sibling node with the given 'value'. More...
 
TiXmlNode * NextSibling (const char *_next)
 
const TiXmlElement * NextSiblingElement () const
 
TiXmlElement * NextSiblingElement ()
 
const TiXmlElement * NextSiblingElement (const char *) const
 
TiXmlElement * NextSiblingElement (const char *_next)
 
const TiXmlElement * FirstChildElement () const
 Convenience function to get through elements. More...
 
TiXmlElement * FirstChildElement ()
 
const TiXmlElement * FirstChildElement (const char *_value) const
 Convenience function to get through elements. More...
 
TiXmlElement * FirstChildElement (const char *_value)
 
int Type () const
 
const TiXmlDocument * GetDocument () const
 
TiXmlDocument * GetDocument ()
 
bool NoChildren () const
 Returns true if this node has no children. More...
 
virtual const TiXmlDocument * ToDocument () const
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual const TiXmlElement * ToElement () const
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual const TiXmlUnknown * ToUnknown () const
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual const TiXmlText * ToText () const
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual const TiXmlDeclaration * ToDeclaration () const
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlDocument * ToDocument ()
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlElement * ToElement ()
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlUnknown * ToUnknown ()
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlText * ToText ()
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlDeclaration * ToDeclaration ()
 Cast to a more defined type. Will return null if not of the requested type. More...
 
- Public Member Functions inherited from TiXmlBase
 TiXmlBase ()
 
virtual ~TiXmlBase ()
 
int Row () const
 
int Column () const
 See Row() More...
 
void SetUserData (void *user)
 Set a pointer to arbitrary user data. More...
 
void * GetUserData ()
 Get a pointer to arbitrary user data. More...
 
const void * GetUserData () const
 Get a pointer to arbitrary user data. More...
 

Protected Member Functions

void CopyTo (TiXmlComment *target) const
 
- Protected Member Functions inherited from TiXmlNode
 TiXmlNode (NodeType _type)
 
void CopyTo (TiXmlNode *target) const
 
TiXmlNode * Identify (const char *start, TiXmlEncoding encoding)
 

Additional Inherited Members

- Public Types inherited from TiXmlNode
enum  NodeType {
  TINYXML_DOCUMENT, TINYXML_ELEMENT, TINYXML_COMMENT, TINYXML_UNKNOWN,
  TINYXML_TEXT, TINYXML_DECLARATION, TINYXML_TYPECOUNT
}
 
- Public Types inherited from TiXmlBase
enum  {
  TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, TIXML_ERROR_PARSING_ELEMENT,
  TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME, TIXML_ERROR_READING_ELEMENT_VALUE, TIXML_ERROR_READING_ATTRIBUTES, TIXML_ERROR_PARSING_EMPTY,
  TIXML_ERROR_READING_END_TAG, TIXML_ERROR_PARSING_UNKNOWN, TIXML_ERROR_PARSING_COMMENT, TIXML_ERROR_PARSING_DECLARATION,
  TIXML_ERROR_DOCUMENT_EMPTY, TIXML_ERROR_EMBEDDED_NULL, TIXML_ERROR_PARSING_CDATA, TIXML_ERROR_DOCUMENT_TOP_ONLY,
  TIXML_ERROR_STRING_COUNT
}
 
- Static Public Member Functions inherited from TiXmlBase
static void SetCondenseWhiteSpace (bool condense)
 
static bool IsWhiteSpaceCondensed ()
 Return the current white space setting. More...
 
static void EncodeString (const TIXML_STRING &str, TIXML_STRING *out)
 
- Static Public Attributes inherited from TiXmlBase
static const int utf8ByteTable [256]
 
- Static Protected Member Functions inherited from TiXmlBase
static const char * SkipWhiteSpace (const char *, TiXmlEncoding encoding)
 
static bool IsWhiteSpace (char c)
 
static bool IsWhiteSpace (int c)
 
static const char * ReadName (const char *p, TIXML_STRING *name, TiXmlEncoding encoding)
 
static const char * ReadText (const char *in, TIXML_STRING *text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
 
static const char * GetEntity (const char *in, char *value, int *length, TiXmlEncoding encoding)
 
static const char * GetChar (const char *p, char *_value, int *length, TiXmlEncoding encoding)
 
static bool StringEqual (const char *p, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)
 
static int IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)
 
static int IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding)
 
static int ToLower (int v, TiXmlEncoding encoding)
 
static void ConvertUTF32ToUTF8 (unsigned long input, char *output, int *length)
 
- Protected Attributes inherited from TiXmlNode
TiXmlNode * parent
 
NodeType type
 
TiXmlNode * firstChild
 
TiXmlNode * lastChild
 
TIXML_STRING value
 
TiXmlNode * prev
 
TiXmlNode * next
 
- Protected Attributes inherited from TiXmlBase
TiXmlCursor location
 
void * userData
 Field containing a generic user pointer. More...
 
- Static Protected Attributes inherited from TiXmlBase
static const char * errorString [TIXML_ERROR_STRING_COUNT]
 

Detailed Description

An XML comment.

Definition at line 1162 of file tinyxml.h.

Constructor & Destructor Documentation

TiXmlComment::TiXmlComment ( )
inline

Constructs an empty comment.

Definition at line 1166 of file tinyxml.h.

TiXmlComment::TiXmlComment ( const char *  _value)
inline

Construct a comment from text.

Definition at line 1168 of file tinyxml.h.

TiXmlComment::TiXmlComment ( const TiXmlComment &  copy)

Definition at line 1282 of file tinyxml.cpp.

virtual TiXmlComment::~TiXmlComment ( )
inlinevirtual

Definition at line 1174 of file tinyxml.h.

Member Function Documentation

bool TiXmlComment::Accept ( TiXmlVisitor *  visitor) const
virtual

Walk the XML tree visiting this node and all of its children.

Implements TiXmlNode.

Definition at line 1313 of file tinyxml.cpp.

TiXmlNode * TiXmlComment::Clone ( ) const
virtual

Returns a copy of this Comment.

Implements TiXmlNode.

Definition at line 1319 of file tinyxml.cpp.

void TiXmlComment::CopyTo ( TiXmlComment *  target) const
protected

Definition at line 1307 of file tinyxml.cpp.

TiXmlComment & TiXmlComment::operator= ( const TiXmlComment &  base)

Definition at line 1288 of file tinyxml.cpp.

const char * TiXmlComment::Parse ( const char *  p,
TiXmlParsingData *  data,
TiXmlEncoding  encoding 
)
virtual

Implements TiXmlBase.

Definition at line 1337 of file tinyxmlparser.cpp.

void TiXmlComment::Print ( FILE *  cfile,
int  depth 
) const
virtual

All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null.

This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

Implements TiXmlBase.

Definition at line 1296 of file tinyxml.cpp.

virtual const TiXmlComment* TiXmlComment::ToComment ( ) const
inlinevirtual

Cast to a more defined type. Will return null not of the requested type.

Reimplemented from TiXmlNode.

Definition at line 1186 of file tinyxml.h.

virtual TiXmlComment* TiXmlComment::ToComment ( )
inlinevirtual

Cast to a more defined type. Will return null not of the requested type.

Reimplemented from TiXmlNode.

Definition at line 1187 of file tinyxml.h.


The documentation for this class was generated from the following files: