sipxportlib  Version 3.3
Public Member Functions | Protected Member Functions | List of all members
TiXmlComment Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlComment:
Inheritance graph
[legend]
Collaboration diagram for TiXmlComment:
Collaboration graph
[legend]

Public Member Functions

 TiXmlComment ()
 Constructs an empty comment. More...
 
 TiXmlComment (const TiXmlComment &)
 
void 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
 Write this Comment to a FILE stream. More...
 
virtual const char * Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)
 
- Public Member Functions inherited from TiXmlNode
virtual ~TiXmlNode ()
 
const char * Value () 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
 The first child of this node with the matching 'value'. Will be null if none found. More...
 
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 (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, 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 *)
 
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 *)
 
const TiXmlElement * NextSiblingElement () const
 
TiXmlElement * NextSiblingElement ()
 
const TiXmlElement * NextSiblingElement (const char *) const
 
TiXmlElement * NextSiblingElement (const char *)
 
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)
 
virtual int Type () const
 
const TiXmlDocument * GetDocument () const
 
TiXmlDocument * GetDocument ()
 
bool NoChildren () const
 Returns true if this node has no children. More...
 
const TiXmlDocument * ToDocument () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
const TiXmlElement * ToElement () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
const TiXmlComment * ToComment () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
const TiXmlUnknown * ToUnknown () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
const TiXmlText * ToText () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
const TiXmlDeclaration * ToDeclaration () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlDocument * ToDocument ()
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlElement * ToElement ()
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlComment * ToComment ()
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlUnknown * ToUnknown ()
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlText * ToText ()
 Cast to a more defined type. Will return null not of the requested type. More...
 
TiXmlDeclaration * ToDeclaration ()
 Cast to a more defined type. Will return null 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)
 
void * GetUserData ()
 

Protected Member Functions

void CopyTo (TiXmlComment *target) const
 
virtual void StreamOut (TIXML_OSTREAM *out) const
 
- Protected Member Functions inherited from TiXmlNode
 TiXmlNode (NodeType _type)
 
void CopyTo (TiXmlNode *target) const
 
TiXmlNode * Identify (const char *start, TiXmlEncoding encoding)
 
const TIXML_STRING & SValue () const
 

Additional Inherited Members

- Public Types inherited from TiXmlNode
enum  NodeType {
  DOCUMENT, ELEMENT, COMMENT, UNKNOWN,
  TEXT, DECLARATION, TYPECOUNT
}
 
- Public Types inherited from TiXmlBase
enum  {
  TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, TIXML_ERROR_OUT_OF_MEMORY,
  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_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 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 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 void PutString (const TIXML_STRING &str, TIXML_OSTREAM *out)
 
static void PutString (const TIXML_STRING &str, TIXML_STRING *out)
 
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.

Constructor & Destructor Documentation

TiXmlComment ( )
inline

Constructs an empty comment.

TiXmlComment ( const TiXmlComment &  copy)
virtual ~TiXmlComment ( )
inlinevirtual

Member Function Documentation

void operator= ( const TiXmlComment &  base)
TiXmlNode * Clone ( ) const
virtual

Returns a copy of this Comment.

Implements TiXmlNode.

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

Write this Comment to a FILE stream.

Implements TiXmlBase.

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

Implements TiXmlBase.

void CopyTo ( TiXmlComment *  target) const
protected
void StreamOut ( TIXML_OSTREAM *  out) const
protectedvirtual

Implements TiXmlBase.