TiXmlNode Class Reference

The parent class for everything in the Document Object Model. More...

#include </home/andreas/Development/drewke.net/tdme2/ext/tinyxml/tinyxml.h>

Inheritance diagram for TiXmlNode:

Collaboration diagram for TiXmlNode:

Public Types
enum	NodeType {   TINYXML_DOCUMENT , TINYXML_ELEMENT , TINYXML_COMMENT , TINYXML_UNKNOWN ,   TINYXML_TEXT , TINYXML_DECLARATION , TINYXML_TYPECOUNT }
	The types of XML nodes supported by TinyXml. More...
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 }

Public Member Functions
virtual	~TiXmlNode ()
const char *	Value () const
	The meaning of 'value' changes for the specific type of TiXmlNode. More...
const std::string &	ValueStr () const
	Return Value() as a std::string. More...
const TIXML_STRING &	ValueTStr () const
void	SetValue (const char *_value)
	Changes the value of the node. More...
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
	The first child of this node with the matching 'value'. 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 *	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
	An alternate way to walk the children of a node. More...
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)
	Add a new node related to this. More...
TiXmlNode *	LinkEndChild (TiXmlNode *addThis)
	Add a new node related to this. More...
TiXmlNode *	InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
	Add a new node related to this. More...
TiXmlNode *	InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
	Add a new node related to this. More...
TiXmlNode *	ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
	Replace a child of this node. More...
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
	Convenience function to get through elements. More...
TiXmlElement *	NextSiblingElement ()
const TiXmlElement *	NextSiblingElement (const char *) const
	Convenience function to get through elements. More...
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
	Query the type (as an enumerated value, above) of this node. More...
const TiXmlDocument *	GetDocument () const
	Return a pointer to the Document this node lives in. More...
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
	Create an exact duplicate of this node and return it. More...
virtual bool	Accept (TiXmlVisitor *visitor) const =0
	Accept a hierchical visit the nodes in the TinyXML DOM. More...
virtual void	StreamIn (std::istream *in, TIXML_STRING *tag)=0
Public Member Functions inherited from TiXmlBase
	TiXmlBase ()
virtual	~TiXmlBase ()
virtual void	Print (FILE *cfile, int depth) const =0
	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. More...
int	Row () const
	Return the position, in the original source file, of this node or attribute. More...
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

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

Protected Attributes
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...

Private Member Functions
	TiXmlNode (const TiXmlNode &)
void	operator= (const TiXmlNode &base)

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

Additional Inherited Members
Static Public Member Functions inherited from TiXmlBase
static void	SetCondenseWhiteSpace (bool condense)
	The world does not agree on whether white space should be kept or not. More...
static bool	IsWhiteSpaceCondensed ()
	Return the current white space setting. More...
static void	EncodeString (const TIXML_STRING &str, TIXML_STRING *out)
	Expands entities in a string. 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 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)
Static Protected Attributes inherited from TiXmlBase
static const char *	errorString [TIXML_ERROR_STRING_COUNT]

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.

Definition at line 396 of file tinyxml.h.

Member Enumeration Documentation

NodeType

enum 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

Definition at line 432 of file tinyxml.h.

Constructor & Destructor Documentation

~TiXmlNode()

~TiXmlNode ( )

virtual

Definition at line 139 of file tinyxml.cpp.

TiXmlNode() [1/2]

TiXmlNode ( NodeType  _type )

protected

Definition at line 128 of file tinyxml.cpp.

TiXmlNode() [2/2]

TiXmlNode ( const TiXmlNode &  )

private

Member Function Documentation

Value()

const char* 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.

Definition at line 457 of file tinyxml.h.

ValueStr()

const std::string& 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.

Definition at line 463 of file tinyxml.h.

ValueTStr()

const TIXML_STRING& ValueTStr ( ) const

inline

Definition at line 465 of file tinyxml.h.

SetValue() [1/2]

void 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

Definition at line 476 of file tinyxml.h.

SetValue() [2/2]

void SetValue ( const std::string &  _value )

inline

STL std::string form.

Definition at line 479 of file tinyxml.h.

Clear()

void Clear

(

)

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

Definition at line 161 of file tinyxml.cpp.

Parent() [1/2]

TiXmlNode* Parent ( )

inline

One step up the DOM.

Definition at line 485 of file tinyxml.h.

Parent() [2/2]

const TiXmlNode* Parent ( ) const

inline

Definition at line 486 of file tinyxml.h.

FirstChild() [1/6]

const TiXmlNode* FirstChild ( ) const

inline

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

Definition at line 488 of file tinyxml.h.

FirstChild() [2/6]

TiXmlNode* FirstChild ( )

inline

Definition at line 489 of file tinyxml.h.

FirstChild() [3/6]

const TiXmlNode * FirstChild

(

const char *

value

)

const

The first child of this node with the matching 'value'.

Will be null if none found.

Definition at line 353 of file tinyxml.cpp.

FirstChild() [4/6]

TiXmlNode* FirstChild ( const char *  _value )

inline

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

Definition at line 492 of file tinyxml.h.

LastChild() [1/6]

const TiXmlNode* LastChild ( ) const

inline

Definition at line 497 of file tinyxml.h.

LastChild() [2/6]

TiXmlNode* LastChild ( )

inline

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

Definition at line 498 of file tinyxml.h.

LastChild() [3/6]

const TiXmlNode * LastChild

(

const char *

value

)

const

Definition at line 365 of file tinyxml.cpp.

LastChild() [4/6]

TiXmlNode* LastChild ( const char *  _value )

inline

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

Definition at line 501 of file tinyxml.h.

FirstChild() [5/6]

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

inline

STL std::string form.

Definition at line 505 of file tinyxml.h.

FirstChild() [6/6]

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

inline

STL std::string form.

Definition at line 506 of file tinyxml.h.

LastChild() [5/6]

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

inline

STL std::string form.

Definition at line 507 of file tinyxml.h.

LastChild() [6/6]

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

inline

STL std::string form.

Definition at line 508 of file tinyxml.h.

IterateChildren() [1/6]

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

Definition at line 377 of file tinyxml.cpp.

IterateChildren() [2/6]

TiXmlNode* IterateChildren ( const TiXmlNode *  previous )

inline

Definition at line 527 of file tinyxml.h.

IterateChildren() [3/6]

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

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

Definition at line 391 of file tinyxml.cpp.

IterateChildren() [4/6]

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

inline

Definition at line 533 of file tinyxml.h.

IterateChildren() [5/6]

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

inline

STL std::string form.

Definition at line 537 of file tinyxml.h.

IterateChildren() [6/6]

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

inline

STL std::string form.

Definition at line 538 of file tinyxml.h.

InsertEndChild()

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.

Definition at line 206 of file tinyxml.cpp.

LinkEndChild()

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

Definition at line 178 of file tinyxml.cpp.

InsertBeforeChild()

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.

Definition at line 222 of file tinyxml.cpp.

InsertAfterChild()

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.

Definition at line 255 of file tinyxml.cpp.

ReplaceChild()

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.

Definition at line 288 of file tinyxml.cpp.

RemoveChild()

bool RemoveChild

(

TiXmlNode *

removeThis

)

Delete a child of this node.

Definition at line 327 of file tinyxml.cpp.

PreviousSibling() [1/6]

const TiXmlNode* PreviousSibling ( ) const

inline

Navigate to a sibling node.

Definition at line 576 of file tinyxml.h.

PreviousSibling() [2/6]

TiXmlNode* PreviousSibling ( )

inline

Definition at line 577 of file tinyxml.h.

PreviousSibling() [3/6]

const TiXmlNode * PreviousSibling

(

const char *

_value

)

const

Navigate to a sibling node.

Definition at line 417 of file tinyxml.cpp.

PreviousSibling() [4/6]

TiXmlNode* PreviousSibling ( const char *  _prev )

inline

Definition at line 581 of file tinyxml.h.

PreviousSibling() [5/6]

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

inline

STL std::string form.

Definition at line 585 of file tinyxml.h.

PreviousSibling() [6/6]

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

inline

STL std::string form.

Definition at line 586 of file tinyxml.h.

NextSibling() [1/6]

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

inline

STL std::string form.

Definition at line 587 of file tinyxml.h.

NextSibling() [2/6]

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

inline

STL std::string form.

Definition at line 588 of file tinyxml.h.

NextSibling() [3/6]

const TiXmlNode* NextSibling ( ) const

inline

Navigate to a sibling node.

Definition at line 591 of file tinyxml.h.

NextSibling() [4/6]

TiXmlNode* NextSibling ( )

inline

Definition at line 592 of file tinyxml.h.

NextSibling() [5/6]

const TiXmlNode * NextSibling

(

const char *

_value

)

const

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

Definition at line 405 of file tinyxml.cpp.

NextSibling() [6/6]

TiXmlNode* NextSibling ( const char *  _next )

inline

Definition at line 596 of file tinyxml.h.

NextSiblingElement() [1/6]

const TiXmlElement * 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.

Definition at line 471 of file tinyxml.cpp.

NextSiblingElement() [2/6]

TiXmlElement* NextSiblingElement ( )

inline

Definition at line 605 of file tinyxml.h.

NextSiblingElement() [3/6]

const TiXmlElement * NextSiblingElement

(

const char *

_value

)

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.

Definition at line 486 of file tinyxml.cpp.

NextSiblingElement() [4/6]

TiXmlElement* NextSiblingElement ( const char *  _next )

inline

Definition at line 614 of file tinyxml.h.

NextSiblingElement() [5/6]

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

inline

STL std::string form.

Definition at line 618 of file tinyxml.h.

NextSiblingElement() [6/6]

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

inline

STL std::string form.

Definition at line 619 of file tinyxml.h.

FirstChildElement() [1/6]

const TiXmlElement * FirstChildElement

(

)

const

Convenience function to get through elements.

Definition at line 441 of file tinyxml.cpp.

FirstChildElement() [2/6]

TiXmlElement* FirstChildElement ( )

inline

Definition at line 623 of file tinyxml.h.

FirstChildElement() [3/6]

const TiXmlElement * FirstChildElement

(

const char *

_value

)

const

Convenience function to get through elements.

Definition at line 456 of file tinyxml.cpp.

FirstChildElement() [4/6]

TiXmlElement* FirstChildElement ( const char *  _value )

inline

Definition at line 629 of file tinyxml.h.

FirstChildElement() [5/6]

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

inline

STL std::string form.

Definition at line 633 of file tinyxml.h.

FirstChildElement() [6/6]

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

inline

STL std::string form.

Definition at line 634 of file tinyxml.h.

Type()

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

Definition at line 640 of file tinyxml.h.

GetDocument() [1/2]

const TiXmlDocument * GetDocument

(

)

const

Return a pointer to the Document this node lives in.

Returns null if not in a document.

Definition at line 501 of file tinyxml.cpp.

GetDocument() [2/2]

TiXmlDocument* GetDocument ( )

inline

Definition at line 646 of file tinyxml.h.

NoChildren()

bool NoChildren ( ) const

inline

Returns true if this node has no children.

Definition at line 651 of file tinyxml.h.

ToDocument() [1/2]

virtual const TiXmlDocument* ToDocument ( ) const

inlinevirtual

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

Reimplemented in TiXmlDocument.

Definition at line 653 of file tinyxml.h.

ToElement() [1/2]

virtual const TiXmlElement* ToElement ( ) const

inlinevirtual

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

Reimplemented in TiXmlElement.

Definition at line 654 of file tinyxml.h.

ToComment() [1/2]

virtual const TiXmlComment* ToComment ( ) const

inlinevirtual

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

Reimplemented in TiXmlComment.

Definition at line 655 of file tinyxml.h.

ToUnknown() [1/2]

virtual const TiXmlUnknown* ToUnknown ( ) const

inlinevirtual

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

Reimplemented in TiXmlUnknown.

Definition at line 656 of file tinyxml.h.

ToText() [1/2]

virtual const TiXmlText* ToText ( ) const

inlinevirtual

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

Reimplemented in TiXmlText.

Definition at line 657 of file tinyxml.h.

ToDeclaration() [1/2]

virtual const TiXmlDeclaration* ToDeclaration ( ) const

inlinevirtual

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

Reimplemented in TiXmlDeclaration.

Definition at line 658 of file tinyxml.h.

ToDocument() [2/2]

virtual TiXmlDocument* ToDocument ( )

inlinevirtual

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

Reimplemented in TiXmlDocument.

Definition at line 660 of file tinyxml.h.

ToElement() [2/2]

virtual TiXmlElement* ToElement ( )

inlinevirtual

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

Reimplemented in TiXmlElement.

Definition at line 661 of file tinyxml.h.

ToComment() [2/2]

virtual TiXmlComment* ToComment ( )

inlinevirtual

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

Reimplemented in TiXmlComment.

Definition at line 662 of file tinyxml.h.

ToUnknown() [2/2]

virtual TiXmlUnknown* ToUnknown ( )

inlinevirtual

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

Reimplemented in TiXmlUnknown.

Definition at line 663 of file tinyxml.h.

ToText() [2/2]

virtual TiXmlText* ToText ( )

inlinevirtual

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

Reimplemented in TiXmlText.

Definition at line 664 of file tinyxml.h.

ToDeclaration() [2/2]

virtual TiXmlDeclaration* ToDeclaration ( )

inlinevirtual

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

Reimplemented in TiXmlDeclaration.

Definition at line 665 of file tinyxml.h.

Clone()

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

Accept()

virtual bool 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 TiXmlDeclaration, TiXmlComment, TiXmlElement, TiXmlDocument, TiXmlUnknown, and TiXmlText.

StreamIn()

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

pure virtual

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

CopyTo()

void CopyTo ( TiXmlNode *  target ) const

protected

Definition at line 153 of file tinyxml.cpp.

Identify()

TiXmlNode * Identify ( const char *  start, TiXmlEncoding  encoding  )

protected

Definition at line 814 of file tinyxmlparser.cpp.

operator=()

void operator= ( const TiXmlNode &  base )

private

Friends And Related Function Documentation

TiXmlDocument

friend class TiXmlDocument

friend

Definition at line 398 of file tinyxml.h.

TiXmlElement

friend class TiXmlElement

friend

Definition at line 399 of file tinyxml.h.

operator>>

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.

Definition at line 1555 of file tinyxml.cpp.

operator<< [1/2]

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.

Definition at line 1566 of file tinyxml.cpp.

operator<< [2/2]

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

friend

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

Definition at line 1577 of file tinyxml.cpp.

Member Data Documentation

parent

TiXmlNode* parent

protected

Definition at line 709 of file tinyxml.h.

type

NodeType type

protected

Definition at line 710 of file tinyxml.h.

firstChild

TiXmlNode* firstChild

protected

Definition at line 712 of file tinyxml.h.

lastChild

TiXmlNode* lastChild

protected

Definition at line 713 of file tinyxml.h.

value

TIXML_STRING value

protected

Definition at line 715 of file tinyxml.h.

prev

TiXmlNode* prev

protected

Definition at line 717 of file tinyxml.h.

next

TiXmlNode* next

protected

Definition at line 718 of file tinyxml.h.

---

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

• /home/andreas/Development/drewke.net/tdme2/ext/tinyxml/tinyxml.h
• /home/andreas/Development/drewke.net/tdme2/ext/tinyxml/tinyxml.cpp
• /home/andreas/Development/drewke.net/tdme2/ext/tinyxml/tinyxmlparser.cpp