#include <tinyxml.h>

Inheritance diagram for TiXmlComment:
Inheritance graph

Public Types

enum  NodeType {
  TINYXML_DOCUMENT, TINYXML_ELEMENT, TINYXML_COMMENT, TINYXML_UNKNOWN,
  TINYXML_TEXT, TINYXML_DECLARATION, TINYXML_TYPECOUNT
}
 
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
}
 

Public Member Functions

 TiXmlComment ()
 Constructs an empty comment. More...
 
 TiXmlComment (const char *_value)
 Construct a comment from text. More...
 
 TiXmlComment (const TiXmlComment &)
 
TiXmlCommentoperator= (const TiXmlComment &base)
 
virtual ~TiXmlComment ()
 
virtual TiXmlNodeClone () 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 TiXmlCommentToComment () const
 Cast to a more defined type. Will return null not of the requested type. More...
 
virtual TiXmlCommentToComment ()
 Cast to a more defined type. Will return null not of the requested type. More...
 
virtual bool Accept (TiXmlVisitor *visitor) const
 
const char * Value () const
 
const std::string & ValueStr () const
 
const TIXML_STRINGValueTStr () const
 
void SetValue (const char *_value)
 
void SetValue (const std::string &_value)
 STL std::string form. More...
 
void Clear ()
 Delete all the children of this node. Does not affect 'this'. More...
 
TiXmlNodeParent ()
 One step up the DOM. More...
 
const TiXmlNodeParent () const
 
const TiXmlNodeFirstChild () const
 The first child of this node. Will be null if there are no children. More...
 
TiXmlNodeFirstChild ()
 
const TiXmlNodeFirstChild (const char *value) const
 
TiXmlNodeFirstChild (const char *_value)
 The first child of this node with the matching 'value'. Will be null if none found. More...
 
const TiXmlNodeFirstChild (const std::string &_value) const
 STL std::string form. More...
 
TiXmlNodeFirstChild (const std::string &_value)
 STL std::string form. More...
 
const TiXmlNodeLastChild () const
 
TiXmlNodeLastChild ()
 The last child of this node. Will be null if there are no children. More...
 
const TiXmlNodeLastChild (const char *value) const
 
TiXmlNodeLastChild (const char *_value)
 The last child of this node matching 'value'. Will be null if there are no children. More...
 
const TiXmlNodeLastChild (const std::string &_value) const
 STL std::string form. More...
 
TiXmlNodeLastChild (const std::string &_value)
 STL std::string form. More...
 
const TiXmlNodeIterateChildren (const TiXmlNode *previous) const
 
TiXmlNodeIterateChildren (const TiXmlNode *previous)
 
const TiXmlNodeIterateChildren (const char *value, const TiXmlNode *previous) const
 This flavor of IterateChildren searches for children with a particular 'value'. More...
 
TiXmlNodeIterateChildren (const char *_value, const TiXmlNode *previous)
 
const TiXmlNodeIterateChildren (const std::string &_value, const TiXmlNode *previous) const
 STL std::string form. More...
 
TiXmlNodeIterateChildren (const std::string &_value, const TiXmlNode *previous)
 STL std::string form. More...
 
TiXmlNodeInsertEndChild (const TiXmlNode &addThis)
 
TiXmlNodeLinkEndChild (TiXmlNode *addThis)
 
TiXmlNodeInsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
 
TiXmlNodeInsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
 
TiXmlNodeReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
 
bool RemoveChild (TiXmlNode *removeThis)
 Delete a child of this node. More...
 
const TiXmlNodePreviousSibling () const
 Navigate to a sibling node. More...
 
TiXmlNodePreviousSibling ()
 
const TiXmlNodePreviousSibling (const char *) const
 Navigate to a sibling node. More...
 
TiXmlNodePreviousSibling (const char *_prev)
 
const TiXmlNodePreviousSibling (const std::string &_value) const
 STL std::string form. More...
 
TiXmlNodePreviousSibling (const std::string &_value)
 STL std::string form. More...
 
const TiXmlNodeNextSibling (const std::string &_value) const
 STL std::string form. More...
 
TiXmlNodeNextSibling (const std::string &_value)
 STL std::string form. More...
 
const TiXmlNodeNextSibling () const
 Navigate to a sibling node. More...
 
TiXmlNodeNextSibling ()
 
const TiXmlNodeNextSibling (const char *) const
 Navigate to a sibling node with the given 'value'. More...
 
TiXmlNodeNextSibling (const char *_next)
 
const TiXmlElementNextSiblingElement () const
 
TiXmlElementNextSiblingElement ()
 
const TiXmlElementNextSiblingElement (const char *) const
 
TiXmlElementNextSiblingElement (const char *_next)
 
const TiXmlElementNextSiblingElement (const std::string &_value) const
 STL std::string form. More...
 
TiXmlElementNextSiblingElement (const std::string &_value)
 STL std::string form. More...
 
const TiXmlElementFirstChildElement () const
 Convenience function to get through elements. More...
 
TiXmlElementFirstChildElement ()
 
const TiXmlElementFirstChildElement (const char *_value) const
 Convenience function to get through elements. More...
 
TiXmlElementFirstChildElement (const char *_value)
 
const TiXmlElementFirstChildElement (const std::string &_value) const
 STL std::string form. More...
 
TiXmlElementFirstChildElement (const std::string &_value)
 STL std::string form. More...
 
int Type () const
 
const TiXmlDocumentGetDocument () const
 
TiXmlDocumentGetDocument ()
 
bool NoChildren () const
 Returns true if this node has no children. More...
 
virtual const TiXmlDocumentToDocument () const
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlDocumentToDocument ()
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual const TiXmlElementToElement () const
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlElementToElement ()
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual const TiXmlUnknownToUnknown () const
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlUnknownToUnknown ()
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual const TiXmlTextToText () const
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlTextToText ()
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual const TiXmlDeclarationToDeclaration () const
 Cast to a more defined type. Will return null if not of the requested type. More...
 
virtual TiXmlDeclarationToDeclaration ()
 Cast to a more defined type. Will return null if not of the requested type. More...
 
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...
 

Static Public Member Functions

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

static const int utf8ByteTable [256]
 

Protected Member Functions

void CopyTo (TiXmlComment *target) const
 
virtual void StreamIn (std::istream *in, TIXML_STRING *tag)
 
void CopyTo (TiXmlNode *target) const
 
TiXmlNodeIdentify (const char *start, TiXmlEncoding encoding)
 

Static Protected Member Functions

static const char * SkipWhiteSpace (const char *, TiXmlEncoding encoding)
 
static bool IsWhiteSpace (char c)
 
static bool IsWhiteSpace (int c)
 
static bool StreamWhiteSpace (std::istream *in, TIXML_STRING *tag)
 
static bool StreamTo (std::istream *in, int character, TIXML_STRING *tag)
 
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

TiXmlNodeparent
 
NodeType type
 
TiXmlNodefirstChild
 
TiXmlNodelastChild
 
TIXML_STRING value
 
TiXmlNodeprev
 
TiXmlNodenext
 
TiXmlCursor location
 
void * userData
 Field containing a generic user pointer. More...
 

Static Protected Attributes

static const char * errorString [TIXML_ERROR_STRING_COUNT]
 

Detailed Description

An XML comment.

Member Enumeration Documentation

anonymous enum
inherited
Enumerator
TIXML_NO_ERROR 
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 
enum TiXmlNode::NodeType
inherited

The types of XML nodes supported by TinyXml. (All the unsupported types are picked up by UNKNOWN.)

Enumerator
TINYXML_DOCUMENT 
TINYXML_ELEMENT 
TINYXML_COMMENT 
TINYXML_UNKNOWN 
TINYXML_TEXT 
TINYXML_DECLARATION 
TINYXML_TYPECOUNT 

Constructor & Destructor Documentation

TiXmlComment::TiXmlComment ( )
inline

Constructs an empty comment.

TiXmlComment::TiXmlComment ( const char *  _value)
inline

Construct a comment from text.

References TiXmlNode::SetValue().

TiXmlComment::TiXmlComment ( const TiXmlComment )
virtual TiXmlComment::~TiXmlComment ( )
inlinevirtual

Member Function Documentation

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

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

Implements TiXmlNode.

void TiXmlNode::Clear ( )
inherited

Delete all the children of this node. Does not affect 'this'.

virtual TiXmlNode* TiXmlComment::Clone ( ) const
virtual

Returns a copy of this Comment.

Implements TiXmlNode.

int TiXmlBase::Column ( ) const
inlineinherited
static void TiXmlBase::ConvertUTF32ToUTF8 ( unsigned long  input,
char *  output,
int *  length 
)
staticprotectedinherited
void TiXmlNode::CopyTo ( TiXmlNode target) const
protectedinherited
void TiXmlComment::CopyTo ( TiXmlComment target) const
protected
static void TiXmlBase::EncodeString ( const TIXML_STRING str,
TIXML_STRING out 
)
staticinherited

Expands entities in a string. Note this should not contian the tag's '<', '>', etc, or they will be transformed into entities!

const TiXmlNode* TiXmlNode::FirstChild ( ) const
inlineinherited

The first child of this node. Will be null if there are no children.

References TiXmlNode::firstChild.

TiXmlNode* TiXmlNode::FirstChild ( )
inlineinherited

References TiXmlNode::firstChild.

const TiXmlNode* TiXmlNode::FirstChild ( const char *  value) const
inherited

The first child of this node with the matching 'value'. Will be null if none found.

TiXmlNode* TiXmlNode::FirstChild ( const char *  _value)
inlineinherited

The first child of this node with the matching 'value'. Will be null if none found.

const TiXmlNode* TiXmlNode::FirstChild ( const std::string &  _value) const
inlineinherited

STL std::string form.

References TiXmlNode::FirstChild().

Referenced by TiXmlNode::FirstChild().

TiXmlNode* TiXmlNode::FirstChild ( const std::string &  _value)
inlineinherited

STL std::string form.

References TiXmlNode::FirstChild().

Referenced by TiXmlNode::FirstChild().

const TiXmlElement* TiXmlNode::FirstChildElement ( ) const
inherited

Convenience function to get through elements.

Referenced by TiXmlDocument::RootElement().

TiXmlElement* TiXmlNode::FirstChildElement ( )
inlineinherited
const TiXmlElement* TiXmlNode::FirstChildElement ( const char *  _value) const
inherited

Convenience function to get through elements.

TiXmlElement* TiXmlNode::FirstChildElement ( const char *  _value)
inlineinherited
const TiXmlElement* TiXmlNode::FirstChildElement ( const std::string &  _value) const
inlineinherited

STL std::string form.

References TiXmlNode::FirstChildElement().

Referenced by TiXmlNode::FirstChildElement().

TiXmlElement* TiXmlNode::FirstChildElement ( const std::string &  _value)
inlineinherited

STL std::string form.

References TiXmlNode::FirstChildElement().

Referenced by TiXmlNode::FirstChildElement().

static const char* TiXmlBase::GetChar ( const char *  p,
char *  _value,
int *  length,
TiXmlEncoding  encoding 
)
inlinestaticprotectedinherited
const TiXmlDocument* TiXmlNode::GetDocument ( ) const
inherited

Return a pointer to the Document this node lives in. Returns null if not in a document.

TiXmlDocument* TiXmlNode::GetDocument ( )
inlineinherited
static const char* TiXmlBase::GetEntity ( const char *  in,
char *  value,
int *  length,
TiXmlEncoding  encoding 
)
staticprotectedinherited

Referenced by TiXmlBase::GetChar().

void* TiXmlBase::GetUserData ( )
inlineinherited

Get a pointer to arbitrary user data.

References TiXmlBase::userData.

const void* TiXmlBase::GetUserData ( ) const
inlineinherited

Get a pointer to arbitrary user data.

References TiXmlBase::userData.

TiXmlNode* TiXmlNode::Identify ( const char *  start,
TiXmlEncoding  encoding 
)
protectedinherited
TiXmlNode* TiXmlNode::InsertAfterChild ( TiXmlNode afterThis,
const TiXmlNode addThis 
)
inherited

Add a new node related to this. Adds a child after the specified child. Returns a pointer to the new object or NULL if an error occured.

TiXmlNode* TiXmlNode::InsertBeforeChild ( TiXmlNode beforeThis,
const TiXmlNode addThis 
)
inherited

Add a new node related to this. Adds a child before the specified child. Returns a pointer to the new object or NULL if an error occured.

TiXmlNode* TiXmlNode::InsertEndChild ( const TiXmlNode addThis)
inherited

Add a new node related to this. Adds a child past the LastChild. Returns a pointer to the new object or NULL if an error occured.

static int TiXmlBase::IsAlpha ( unsigned char  anyByte,
TiXmlEncoding  encoding 
)
staticprotectedinherited
static int TiXmlBase::IsAlphaNum ( unsigned char  anyByte,
TiXmlEncoding  encoding 
)
staticprotectedinherited
static bool TiXmlBase::IsWhiteSpace ( char  c)
inlinestaticprotectedinherited

Referenced by TiXmlBase::IsWhiteSpace().

static bool TiXmlBase::IsWhiteSpace ( int  c)
inlinestaticprotectedinherited
static bool TiXmlBase::IsWhiteSpaceCondensed ( )
inlinestaticinherited

Return the current white space setting.

const TiXmlNode* TiXmlNode::IterateChildren ( const TiXmlNode previous) const
inherited

An alternate way to walk the children of a node. One way to iterate over nodes is:

    for( child = parent->FirstChild(); child; child = child->NextSibling() )

IterateChildren does the same thing with the syntax:

    child = 0;
    while( child = parent->IterateChildren( child ) )

IterateChildren takes the previous child as input and finds the next one. If the previous child is null, it returns the first. IterateChildren will return null when done.

TiXmlNode* TiXmlNode::IterateChildren ( const TiXmlNode previous)
inlineinherited
const TiXmlNode* TiXmlNode::IterateChildren ( const char *  value,
const TiXmlNode previous 
) const
inherited

This flavor of IterateChildren searches for children with a particular 'value'.

TiXmlNode* TiXmlNode::IterateChildren ( const char *  _value,
const TiXmlNode previous 
)
inlineinherited
const TiXmlNode* TiXmlNode::IterateChildren ( const std::string &  _value,
const TiXmlNode previous 
) const
inlineinherited

STL std::string form.

References TiXmlNode::IterateChildren().

Referenced by TiXmlNode::IterateChildren().

TiXmlNode* TiXmlNode::IterateChildren ( const std::string &  _value,
const TiXmlNode previous 
)
inlineinherited

STL std::string form.

References TiXmlNode::IterateChildren().

Referenced by TiXmlNode::IterateChildren().

const TiXmlNode* TiXmlNode::LastChild ( ) const
inlineinherited

References TiXmlNode::lastChild.

TiXmlNode* TiXmlNode::LastChild ( )
inlineinherited

The last child of this node. Will be null if there are no children.

References TiXmlNode::lastChild.

const TiXmlNode* TiXmlNode::LastChild ( const char *  value) const
inherited
TiXmlNode* TiXmlNode::LastChild ( const char *  _value)
inlineinherited

The last child of this node matching 'value'. Will be null if there are no children.

const TiXmlNode* TiXmlNode::LastChild ( const std::string &  _value) const
inlineinherited

STL std::string form.

References TiXmlNode::LastChild().

Referenced by TiXmlNode::LastChild().

TiXmlNode* TiXmlNode::LastChild ( const std::string &  _value)
inlineinherited

STL std::string form.

References TiXmlNode::LastChild().

Referenced by TiXmlNode::LastChild().

TiXmlNode* TiXmlNode::LinkEndChild ( TiXmlNode addThis)
inherited

Add a new node related to this. Adds a child past the LastChild.

NOTE: the node to be added is passed by pointer, and will be henceforth owned (and deleted) by tinyXml. This method is efficient and avoids an extra copy, but should be used with care as it uses a different memory model than the other insert functions.

See also
InsertEndChild
const TiXmlNode* TiXmlNode::NextSibling ( const std::string &  _value) const
inlineinherited

STL std::string form.

References TiXmlNode::NextSibling().

Referenced by TiXmlNode::NextSibling().

TiXmlNode* TiXmlNode::NextSibling ( const std::string &  _value)
inlineinherited

STL std::string form.

References TiXmlNode::NextSibling().

Referenced by TiXmlNode::NextSibling().

const TiXmlNode* TiXmlNode::NextSibling ( ) const
inlineinherited

Navigate to a sibling node.

References TiXmlNode::next.

TiXmlNode* TiXmlNode::NextSibling ( )
inlineinherited

References TiXmlNode::next.

const TiXmlNode* TiXmlNode::NextSibling ( const char *  ) const
inherited

Navigate to a sibling node with the given 'value'.

TiXmlNode* TiXmlNode::NextSibling ( const char *  _next)
inlineinherited
const TiXmlElement* TiXmlNode::NextSiblingElement ( ) const
inherited

Convenience function to get through elements. Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.

TiXmlElement* TiXmlNode::NextSiblingElement ( )
inlineinherited
const TiXmlElement* TiXmlNode::NextSiblingElement ( const char *  ) const
inherited

Convenience function to get through elements. Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.

TiXmlElement* TiXmlNode::NextSiblingElement ( const char *  _next)
inlineinherited
const TiXmlElement* TiXmlNode::NextSiblingElement ( const std::string &  _value) const
inlineinherited

STL std::string form.

References TiXmlNode::NextSiblingElement().

Referenced by TiXmlNode::NextSiblingElement().

TiXmlElement* TiXmlNode::NextSiblingElement ( const std::string &  _value)
inlineinherited

STL std::string form.

References TiXmlNode::NextSiblingElement().

Referenced by TiXmlNode::NextSiblingElement().

bool TiXmlNode::NoChildren ( ) const
inlineinherited

Returns true if this node has no children.

References TiXmlNode::firstChild.

TiXmlComment& TiXmlComment::operator= ( const TiXmlComment base)
TiXmlNode* TiXmlNode::Parent ( )
inlineinherited

One step up the DOM.

References TiXmlNode::parent.

const TiXmlNode* TiXmlNode::Parent ( ) const
inlineinherited

References TiXmlNode::parent.

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

Implements TiXmlBase.

const TiXmlNode* TiXmlNode::PreviousSibling ( ) const
inlineinherited

Navigate to a sibling node.

References TiXmlNode::prev.

TiXmlNode* TiXmlNode::PreviousSibling ( )
inlineinherited

References TiXmlNode::prev.

const TiXmlNode* TiXmlNode::PreviousSibling ( const char *  ) const
inherited

Navigate to a sibling node.

TiXmlNode* TiXmlNode::PreviousSibling ( const char *  _prev)
inlineinherited
const TiXmlNode* TiXmlNode::PreviousSibling ( const std::string &  _value) const
inlineinherited

STL std::string form.

References TiXmlNode::PreviousSibling().

Referenced by TiXmlNode::PreviousSibling().

TiXmlNode* TiXmlNode::PreviousSibling ( const std::string &  _value)
inlineinherited

STL std::string form.

References TiXmlNode::PreviousSibling().

Referenced by TiXmlNode::PreviousSibling().

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

static const char* TiXmlBase::ReadName ( const char *  p,
TIXML_STRING name,
TiXmlEncoding  encoding 
)
staticprotectedinherited
static const char* TiXmlBase::ReadText ( const char *  in,
TIXML_STRING text,
bool  ignoreWhiteSpace,
const char *  endTag,
bool  ignoreCase,
TiXmlEncoding  encoding 
)
staticprotectedinherited
bool TiXmlNode::RemoveChild ( TiXmlNode removeThis)
inherited

Delete a child of this node.

TiXmlNode* TiXmlNode::ReplaceChild ( TiXmlNode replaceThis,
const TiXmlNode withThis 
)
inherited

Replace a child of this node. Returns a pointer to the new object or NULL if an error occured.

int TiXmlBase::Row ( ) const
inlineinherited

Return the position, in the original source file, of this node or attribute. The row and column are 1-based. (That is the first row and first column is 1,1). If the returns values are 0 or less, then the parser does not have a row and column value.

Generally, the row and column value will be set when the TiXmlDocument::Load(), TiXmlDocument::LoadFile(), or any TiXmlNode::Parse() is called. It will NOT be set when the DOM was created from operator>>.

The values reflect the initial load. Once the DOM is modified programmatically (by adding or changing nodes and attributes) the new values will NOT update to reflect changes in the document.

There is a minor performance cost to computing the row and column. Computation can be disabled if TiXmlDocument::SetTabSize() is called with 0 as the value.

See also
TiXmlDocument::SetTabSize()

References TiXmlBase::location, and TiXmlCursor::row.

static void TiXmlBase::SetCondenseWhiteSpace ( bool  condense)
inlinestaticinherited

The world does not agree on whether white space should be kept or not. In order to make everyone happy, these global, static functions are provided to set whether or not TinyXml will condense all white space into a single space or not. The default is to condense. Note changing this value is not thread safe.

void TiXmlBase::SetUserData ( void *  user)
inlineinherited

Set a pointer to arbitrary user data.

References TiXmlBase::userData.

void TiXmlNode::SetValue ( const char *  _value)
inlineinherited

Changes the value of the node. Defined as:

Document:   filename of the xml file
Element:    name of the element
Comment:    the comment text
Unknown:    the tag contents
Text:       the text string

References TiXmlNode::value.

Referenced by TiXmlComment(), and TiXmlText::TiXmlText().

void TiXmlNode::SetValue ( const std::string &  _value)
inlineinherited

STL std::string form.

static const char* TiXmlBase::SkipWhiteSpace ( const char *  ,
TiXmlEncoding  encoding 
)
staticprotectedinherited
virtual void TiXmlComment::StreamIn ( std::istream *  in,
TIXML_STRING tag 
)
protectedvirtual

Implements TiXmlNode.

static bool TiXmlBase::StreamTo ( std::istream *  in,
int  character,
TIXML_STRING tag 
)
staticprotectedinherited
static bool TiXmlBase::StreamWhiteSpace ( std::istream *  in,
TIXML_STRING tag 
)
staticprotectedinherited
static bool TiXmlBase::StringEqual ( const char *  p,
const char *  endTag,
bool  ignoreCase,
TiXmlEncoding  encoding 
)
staticprotectedinherited
virtual const TiXmlComment* TiXmlComment::ToComment ( ) const
inlinevirtual

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

Reimplemented from TiXmlNode.

virtual TiXmlComment* TiXmlComment::ToComment ( )
inlinevirtual

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

Reimplemented from TiXmlNode.

virtual const TiXmlDeclaration* TiXmlNode::ToDeclaration ( ) const
inlinevirtualinherited

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

Reimplemented in TiXmlDeclaration.

virtual TiXmlDeclaration* TiXmlNode::ToDeclaration ( )
inlinevirtualinherited

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

Reimplemented in TiXmlDeclaration.

virtual const TiXmlDocument* TiXmlNode::ToDocument ( ) const
inlinevirtualinherited

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

Reimplemented in TiXmlDocument.

virtual TiXmlDocument* TiXmlNode::ToDocument ( )
inlinevirtualinherited

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

Reimplemented in TiXmlDocument.

virtual const TiXmlElement* TiXmlNode::ToElement ( ) const
inlinevirtualinherited

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

Reimplemented in TiXmlElement.

Referenced by TiXmlHandle::ToElement().

virtual TiXmlElement* TiXmlNode::ToElement ( )
inlinevirtualinherited

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

Reimplemented in TiXmlElement.

static int TiXmlBase::ToLower ( int  v,
TiXmlEncoding  encoding 
)
inlinestaticprotectedinherited

References TIXML_ENCODING_UTF8.

virtual const TiXmlText* TiXmlNode::ToText ( ) const
inlinevirtualinherited

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

Reimplemented in TiXmlText.

Referenced by TiXmlHandle::ToText().

virtual TiXmlText* TiXmlNode::ToText ( )
inlinevirtualinherited

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

Reimplemented in TiXmlText.

virtual const TiXmlUnknown* TiXmlNode::ToUnknown ( ) const
inlinevirtualinherited

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

Reimplemented in TiXmlUnknown.

Referenced by TiXmlHandle::ToUnknown().

virtual TiXmlUnknown* TiXmlNode::ToUnknown ( )
inlinevirtualinherited

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

Reimplemented in TiXmlUnknown.

int TiXmlNode::Type ( ) const
inlineinherited

Query the type (as an enumerated value, above) of this node. The possible types are: TINYXML_DOCUMENT, TINYXML_ELEMENT, TINYXML_COMMENT, TINYXML_UNKNOWN, TINYXML_TEXT, and TINYXML_DECLARATION.

References TiXmlNode::type.

const char* TiXmlNode::Value ( ) const
inlineinherited

The meaning of 'value' changes for the specific type of TiXmlNode.

Document:   filename of the xml file
Element:    name of the element
Comment:    the comment text
Unknown:    the tag contents
Text:       the text string

The subclasses will wrap this function.

References TiXmlNode::value.

const std::string& TiXmlNode::ValueStr ( ) const
inlineinherited

Return Value() as a std::string. If you only use STL, this is more efficient than calling Value(). Only available in STL mode.

References TiXmlNode::value.

const TIXML_STRING& TiXmlNode::ValueTStr ( ) const
inlineinherited

References TiXmlNode::value.

Member Data Documentation

const char* TiXmlBase::errorString[TIXML_ERROR_STRING_COUNT]
staticprotectedinherited
TiXmlNode* TiXmlNode::firstChild
protectedinherited
TiXmlNode* TiXmlNode::lastChild
protectedinherited

Referenced by TiXmlNode::LastChild().

TiXmlCursor TiXmlBase::location
protectedinherited
TiXmlNode* TiXmlNode::next
protectedinherited

Referenced by TiXmlNode::NextSibling().

TiXmlNode* TiXmlNode::parent
protectedinherited

Referenced by TiXmlNode::Parent().

TiXmlNode* TiXmlNode::prev
protectedinherited
NodeType TiXmlNode::type
protectedinherited

Referenced by TiXmlNode::Type().

void* TiXmlBase::userData
protectedinherited

Field containing a generic user pointer.

Referenced by TiXmlBase::GetUserData(), and TiXmlBase::SetUserData().

const int TiXmlBase::utf8ByteTable[256]
staticinherited
TIXML_STRING TiXmlNode::value
protectedinherited

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