TiXmlNode Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlNode:

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
virtual	~TiXmlNode ()
const char *	Value () const
const std::string &	ValueStr () const
const TIXML_STRING &	ValueTStr () 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...
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 *	FirstChild (const std::string &_value) const
	STL std::string form. More...
TiXmlNode *	FirstChild (const std::string &_value)
	STL std::string form. More...
const TiXmlNode *	LastChild (const std::string &_value) const
	STL std::string form. More...
TiXmlNode *	LastChild (const std::string &_value)
	STL std::string form. 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)
const TiXmlNode *	IterateChildren (const std::string &_value, const TiXmlNode *previous) const
	STL std::string form. More...
TiXmlNode *	IterateChildren (const std::string &_value, const TiXmlNode *previous)
	STL std::string form. More...
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 *	PreviousSibling (const std::string &_value) const
	STL std::string form. More...
TiXmlNode *	PreviousSibling (const std::string &_value)
	STL std::string form. More...
const TiXmlNode *	NextSibling (const std::string &_value) const
	STL std::string form. More...
TiXmlNode *	NextSibling (const std::string &_value)
	STL std::string form. More...
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 *	NextSiblingElement (const std::string &_value) const
	STL std::string form. More...
TiXmlElement *	NextSiblingElement (const std::string &_value)
	STL std::string form. More...
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)
const TiXmlElement *	FirstChildElement (const std::string &_value) const
	STL std::string form. More...
TiXmlElement *	FirstChildElement (const std::string &_value)
	STL std::string form. More...
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 TiXmlComment *	ToComment () 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 TiXmlComment *	ToComment ()
	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...
virtual TiXmlNode *	Clone () const =0
virtual bool	Accept (TiXmlVisitor *visitor) const =0
virtual void	Print (FILE *cfile, int depth) const =0
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...
virtual const char *	Parse (const char *p, TiXmlParsingData *data, TiXmlEncoding encoding)=0

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
	TiXmlNode (NodeType _type)
void	CopyTo (TiXmlNode *target) const
virtual void	StreamIn (std::istream *in, TIXML_STRING *tag)=0
TiXmlNode *	Identify (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
TiXmlNode *	parent
NodeType	type
TiXmlNode *	firstChild
TiXmlNode *	lastChild
TIXML_STRING	value
TiXmlNode *	prev
TiXmlNode *	next
TiXmlCursor	location
void *	userData
	Field containing a generic user pointer. More...

Static Protected Attributes
static const char *	errorString [TIXML_ERROR_STRING_COUNT]

Friends
class	TiXmlDocument
class	TiXmlElement
std::istream &	operator>> (std::istream &in, TiXmlNode &base)
std::ostream &	operator<< (std::ostream &out, const TiXmlNode &base)
std::string &	operator<< (std::string &out, const TiXmlNode &base)
	Appends the XML node or attribute to a std::string. More...

Detailed Description

The parent class for everything in the Document Object Model. (Except for attributes). Nodes have siblings, a parent, and children. A node can be in a document, or stand on its own. The type of a TiXmlNode can be queried, and it can be cast to its more defined type.

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

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

virtual TiXmlNode::~TiXmlNode ( )

virtual

TiXmlNode::TiXmlNode ( NodeType  _type )

protected

Member Function Documentation

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

pure virtual

Accept a hierchical visit the nodes in the TinyXML DOM. Every node in the XML tree will be conditionally visited and the host will be called back via the TiXmlVisitor interface.

This is essentially a SAX interface for TinyXML. (Note however it doesn't re-parse the XML for the callbacks, so the performance of TinyXML is unchanged by using this interface versus any other.)

The interface has been based on ideas from:

• http://www.saxproject.org/
• http://c2.com/cgi/wiki?HierarchicalVisitorPattern

Which are both good references for "visiting".

An example of using Accept():

TiXmlPrinter printer;
tinyxmlDoc.Accept( &printer );
const char* xmlcstr = printer.CStr();

Implemented in TiXmlDocument, TiXmlUnknown, TiXmlDeclaration, TiXmlText, TiXmlComment, and TiXmlElement.

void TiXmlNode::Clear

(

)

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

virtual TiXmlNode* TiXmlNode::Clone ( ) const

pure virtual

Create an exact duplicate of this node and return it. The memory must be deleted by the caller.

Implemented in TiXmlDocument, TiXmlUnknown, TiXmlDeclaration, TiXmlText, TiXmlComment, and TiXmlElement.

int TiXmlBase::Column ( ) const

inlineinherited

See Row()

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

static void TiXmlBase::ConvertUTF32ToUTF8 ( unsigned long  input, char *  output, int *  length  )

staticprotectedinherited

void TiXmlNode::CopyTo ( TiXmlNode *  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

inline

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

References firstChild.

TiXmlNode* TiXmlNode::FirstChild ( )

inline

References firstChild.

const TiXmlNode* TiXmlNode::FirstChild

(

const char *

value

)

const

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

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

inline

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

inline

STL std::string form.

References FirstChild().

Referenced by FirstChild().

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

inline

STL std::string form.

References FirstChild().

Referenced by FirstChild().

const TiXmlElement* TiXmlNode::FirstChildElement

(

)

const

Convenience function to get through elements.

Referenced by TiXmlDocument::RootElement().

TiXmlElement* TiXmlNode::FirstChildElement ( )

inline

const TiXmlElement* TiXmlNode::FirstChildElement

(

const char *

_value

)

const

Convenience function to get through elements.

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

inline

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

inline

STL std::string form.

References FirstChildElement().

Referenced by FirstChildElement().

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

inline

STL std::string form.

References FirstChildElement().

Referenced by FirstChildElement().

static const char* TiXmlBase::GetChar ( const char *  p, char *  _value, int *  length, TiXmlEncoding  encoding  )

inlinestaticprotectedinherited

References TiXmlBase::GetEntity(), and TIXML_ENCODING_UTF8.

const TiXmlDocument* TiXmlNode::GetDocument

(

)

const

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

TiXmlDocument* TiXmlNode::GetDocument ( )

inline

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  )

protected

TiXmlNode* TiXmlNode::InsertAfterChild	(	TiXmlNode *	afterThis,
		const TiXmlNode &	addThis
	)

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
	)

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

)

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

References TiXmlBase::IsWhiteSpace().

static bool TiXmlBase::IsWhiteSpaceCondensed ( )

inlinestaticinherited

Return the current white space setting.

const TiXmlNode* TiXmlNode::IterateChildren

(

const TiXmlNode *

previous

)

const

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 )

inline

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

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

TiXmlNode* TiXmlNode::IterateChildren ( const char *  _value, const TiXmlNode *  previous  )

inline

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

inline

STL std::string form.

References IterateChildren().

Referenced by IterateChildren().

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

inline

STL std::string form.

References IterateChildren().

Referenced by IterateChildren().

const TiXmlNode* TiXmlNode::LastChild ( ) const

inline

References lastChild.

TiXmlNode* TiXmlNode::LastChild ( )

inline

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

References lastChild.

const TiXmlNode* TiXmlNode::LastChild

(

const char *

value

)

const

TiXmlNode* TiXmlNode::LastChild ( const char *  _value )

inline

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

inline

STL std::string form.

References LastChild().

Referenced by LastChild().

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

inline

STL std::string form.

References LastChild().

Referenced by LastChild().

TiXmlNode* TiXmlNode::LinkEndChild

(

TiXmlNode *

addThis

)

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

inline

STL std::string form.

References NextSibling().

Referenced by NextSibling().

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

inline

STL std::string form.

References NextSibling().

Referenced by NextSibling().

const TiXmlNode* TiXmlNode::NextSibling ( ) const

inline

Navigate to a sibling node.

References next.

TiXmlNode* TiXmlNode::NextSibling ( )

inline

References next.

const TiXmlNode* TiXmlNode::NextSibling

(

const char *

)

const

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

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

inline

const TiXmlElement* TiXmlNode::NextSiblingElement

(

)

const

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 ( )

inline

const TiXmlElement* TiXmlNode::NextSiblingElement

(

const char *

)

const

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 )

inline

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

inline

STL std::string form.

References NextSiblingElement().

Referenced by NextSiblingElement().

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

inline

STL std::string form.

References NextSiblingElement().

Referenced by NextSiblingElement().

bool TiXmlNode::NoChildren ( ) const

inline

Returns true if this node has no children.

References firstChild.

TiXmlNode* TiXmlNode::Parent ( )

inline

One step up the DOM.

References parent.

const TiXmlNode* TiXmlNode::Parent ( ) const

inline

References parent.

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

pure virtualinherited

Implemented in TiXmlDocument, TiXmlUnknown, TiXmlDeclaration, TiXmlText, TiXmlComment, TiXmlElement, and TiXmlAttribute.

const TiXmlNode* TiXmlNode::PreviousSibling ( ) const

inline

Navigate to a sibling node.

References prev.

TiXmlNode* TiXmlNode::PreviousSibling ( )

inline

References prev.

const TiXmlNode* TiXmlNode::PreviousSibling

(

const char *

)

const

Navigate to a sibling node.

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

inline

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

inline

STL std::string form.

References PreviousSibling().

Referenced by PreviousSibling().

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

inline

STL std::string form.

References PreviousSibling().

Referenced by PreviousSibling().

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

pure virtualinherited

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

Implemented in TiXmlDocument, TiXmlUnknown, TiXmlDeclaration, TiXmlText, TiXmlComment, TiXmlElement, and TiXmlAttribute.

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

)

Delete a child of this node.

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

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 )

inline

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

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

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

inline

STL std::string form.

static const char* TiXmlBase::SkipWhiteSpace ( const char *  , TiXmlEncoding  encoding  )

staticprotectedinherited

virtual void TiXmlNode::StreamIn ( std::istream *  in, TIXML_STRING *  tag  )

protectedpure virtual

Implemented in TiXmlDocument, TiXmlUnknown, TiXmlDeclaration, TiXmlText, TiXmlComment, and TiXmlElement.

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* TiXmlNode::ToComment ( ) const

inlinevirtual

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

Reimplemented in TiXmlComment.

virtual TiXmlComment* TiXmlNode::ToComment ( )

inlinevirtual

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

Reimplemented in TiXmlComment.

virtual const TiXmlDeclaration* TiXmlNode::ToDeclaration ( ) const

inlinevirtual

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

Reimplemented in TiXmlDeclaration.

virtual TiXmlDeclaration* TiXmlNode::ToDeclaration ( )

inlinevirtual

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

Reimplemented in TiXmlDeclaration.

virtual const TiXmlDocument* TiXmlNode::ToDocument ( ) const

inlinevirtual

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

Reimplemented in TiXmlDocument.

virtual TiXmlDocument* TiXmlNode::ToDocument ( )

inlinevirtual

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

Reimplemented in TiXmlDocument.

virtual const TiXmlElement* TiXmlNode::ToElement ( ) const

inlinevirtual

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 ( )

inlinevirtual

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

inlinevirtual

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 ( )

inlinevirtual

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

Reimplemented in TiXmlText.

virtual const TiXmlUnknown* TiXmlNode::ToUnknown ( ) const

inlinevirtual

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 ( )

inlinevirtual

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

Reimplemented in TiXmlUnknown.

int TiXmlNode::Type ( ) const

inline

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

const char* TiXmlNode::Value ( ) const

inline

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

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

inline

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

References value.

const TIXML_STRING& TiXmlNode::ValueTStr ( ) const

inline

References value.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  out, const TiXmlNode &  base  )

friend

An output stream operator, for every class. Note that this outputs without any newlines or formatting, as opposed to Print(), which includes tabs and new lines.

The operator<< and operator>> are not completely symmetric. Writing a node to a stream is very well defined. You'll get a nice stream of output, without any extra whitespace or newlines.

But reading is not as well defined. (As it always is.) If you create a TiXmlElement (for example) and read that from an input stream, the text needs to define an element or junk will result. This is true of all input streams, but it's worth keeping in mind.

A TiXmlDocument will read nodes until it reads a root element, and all the children of that root element.

std::string& operator<< ( std::string &  out, const TiXmlNode &  base  )

friend

Appends the XML node or attribute to a std::string.

std::istream& operator>> ( std::istream &  in, TiXmlNode &  base  )

friend

An input stream operator, for every class. Tolerant of newlines and formatting, but doesn't expect them.

friend class TiXmlDocument

friend

friend class TiXmlElement

friend

Member Data Documentation

const char* TiXmlBase::errorString[TIXML_ERROR_STRING_COUNT]

staticprotectedinherited

TiXmlNode* TiXmlNode::firstChild

protected

Referenced by FirstChild(), and NoChildren().

TiXmlNode* TiXmlNode::lastChild

protected

Referenced by LastChild().

TiXmlCursor TiXmlBase::location

protectedinherited

Referenced by TiXmlBase::Column(), and TiXmlBase::Row().

TiXmlNode* TiXmlNode::next

protected

Referenced by NextSibling().

TiXmlNode* TiXmlNode::parent

protected

Referenced by Parent().

TiXmlNode* TiXmlNode::prev

protected

Referenced by PreviousSibling().

NodeType TiXmlNode::type

protected

Referenced by 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

protected

Referenced by SetValue(), Value(), ValueStr(), and ValueTStr().

---

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

• tinyxml.h