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

#include <tinyxml.h>

Inherited by TiXmlComment, TiXmlDeclaration, TiXmlDocument, TiXmlElement, TiXmlText, and TiXmlUnknown.

Public Types
enum	NodeType
	The types of XML nodes supported by TinyXml. More...
Public Member Functions
const char *	Value () const
	The meaning of 'value' changes for the specific type of TiXmlNode.
const std::string &	ValueStr () const
	Return Value() as a std::string.
void	SetValue (const char *_value)
	Changes the value of the node.
void	SetValue (const std::string &_value)
	STL std::string form.
void	Clear ()
	Delete all the children of this node. Does not affect 'this'.
TiXmlNode *	Parent ()
	One step up the DOM.
const TiXmlNode *	FirstChild () const
	The first child of this node. Will be null if there are no children.
const TiXmlNode *	FirstChild (const char *value) const
	The first child of this node with the matching 'value'.
TiXmlNode *	FirstChild (const char *_value)
	The first child of this node with the matching 'value'. Will be null if none found.
TiXmlNode *	LastChild ()
	The last child of this node. Will be null if there are no children.
TiXmlNode *	LastChild (const char *_value)
	The last child of this node matching 'value'. Will be null if there are no children.
const TiXmlNode *	FirstChild (const std::string &_value) const
	STL std::string form.
TiXmlNode *	FirstChild (const std::string &_value)
	STL std::string form.
const TiXmlNode *	LastChild (const std::string &_value) const
	STL std::string form.
TiXmlNode *	LastChild (const std::string &_value)
	STL std::string form.
const TiXmlNode *	IterateChildren (const TiXmlNode *previous) const
	An alternate way to walk the children of a node.
const TiXmlNode *	IterateChildren (const char value, const TiXmlNode previous) const
	This flavor of IterateChildren searches for children with a particular 'value'.
const TiXmlNode *	IterateChildren (const std::string &_value, const TiXmlNode *previous) const
	STL std::string form.
TiXmlNode *	IterateChildren (const std::string &_value, const TiXmlNode *previous)
	STL std::string form.
TiXmlNode *	InsertEndChild (const TiXmlNode &addThis)
	Add a new node related to this.
TiXmlNode *	LinkEndChild (TiXmlNode *addThis)
	Add a new node related to this.
TiXmlNode *	InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
	Add a new node related to this.
TiXmlNode *	InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
	Add a new node related to this.
TiXmlNode *	ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
	Replace a child of this node.
bool	RemoveChild (TiXmlNode *removeThis)
	Delete a child of this node.
const TiXmlNode *	PreviousSibling () const
	Navigate to a sibling node.
const TiXmlNode *	PreviousSibling (const char *) const
	Navigate to a sibling node.
const TiXmlNode *	PreviousSibling (const std::string &_value) const
	STL std::string form.
TiXmlNode *	PreviousSibling (const std::string &_value)
	STL std::string form.
const TiXmlNode *	NextSibling (const std::string &_value) const
	STL std::string form.
TiXmlNode *	NextSibling (const std::string &_value)
	STL std::string form.
const TiXmlNode *	NextSibling () const
	Navigate to a sibling node.
const TiXmlNode *	NextSibling (const char *) const
	Navigate to a sibling node with the given 'value'.
const TiXmlElement *	NextSiblingElement () const
	Convenience function to get through elements.
const TiXmlElement *	NextSiblingElement (const char *) const
	Convenience function to get through elements.
const TiXmlElement *	NextSiblingElement (const std::string &_value) const
	STL std::string form.
TiXmlElement *	NextSiblingElement (const std::string &_value)
	STL std::string form.
const TiXmlElement *	FirstChildElement () const
	Convenience function to get through elements.
const TiXmlElement *	FirstChildElement (const char *_value) const
	Convenience function to get through elements.
const TiXmlElement *	FirstChildElement (const std::string &_value) const
	STL std::string form.
TiXmlElement *	FirstChildElement (const std::string &_value)
	STL std::string form.
int	Type () const
	Query the type (as an enumerated value, above) of this node.
const TiXmlDocument *	GetDocument () const
	Return a pointer to the Document this node lives in.
bool	NoChildren () const
	Returns true if this node has no children.
virtual const TiXmlDocument *	ToDocument () const
	Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlElement *	ToElement () const
	Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlComment *	ToComment () const
	Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlUnknown *	ToUnknown () const
	Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlText *	ToText () const
	Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlDeclaration *	ToDeclaration () const
	Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlDocument *	ToDocument ()
	Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlElement *	ToElement ()
	Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlComment *	ToComment ()
	Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlUnknown *	ToUnknown ()
	Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlText *	ToText ()
	Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlDeclaration *	ToDeclaration ()
	Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlNode *	Clone () const =0
	Create an exact duplicate of this node and return it.
virtual bool	Accept (TiXmlVisitor *visitor) const =0
	Accept a hierchical visit the nodes in the TinyXML DOM.
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.
int	Row () const
	Return the position, in the original source file, of this node or attribute.
int	Column () const
	See Row()
void	SetUserData (void *user)
	Set a pointer to arbitrary user data.
void *	GetUserData ()
	Get a pointer to arbitrary user data.
const void *	GetUserData () const
	Get a pointer to arbitrary user data.
Static Public Member Functions
static void	SetCondenseWhiteSpace (bool condense)
	The world does not agree on whether white space should be kept or not.
static bool	IsWhiteSpaceCondensed ()
	Return the current white space setting.
static void	EncodeString (const TIXML_STRING &str, TIXML_STRING *out)
	Expands entities in a string.
Protected Attributes
void *	userData
	Field containing a generic user pointer.
Friends
class	TiXmlDocument
class	TiXmlElement
std::istream &	operator>> (std::istream &in, TiXmlNode &base)
	An input stream operator, for every class.
std::ostream &	operator<< (std::ostream &out, const TiXmlNode &base)
	An output stream operator, for every class.
std::string &	operator<< (std::string &out, const TiXmlNode &base)
	Appends the XML node or attribute to a std::string.

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 423 of file tinyxml.h.

Member Enumeration Documentation

enum NodeType

The types of XML nodes supported by TinyXml.

(All the unsupported types are picked up by UNKNOWN.)

Definition at line 462 of file tinyxml.h.

Member Function Documentation

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:

Which are both good references for "visiting".

An example of using Accept():

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

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

void Clear ( )

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

Definition at line 169 of file tinyxml.cpp.

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

int Column ( ) const [inherited]

See Row()

Definition at line 245 of file tinyxml.h.

void EncodeString	(	const TIXML_STRING &	str,
		TIXML_STRING *	out
	)		`[static, inherited]`

Expands entities in a string.

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

Definition at line 52 of file tinyxml.cpp.

const TiXmlNode* FirstChild ( ) const

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

Definition at line 522 of file tinyxml.h.

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

STL std::string form.

Definition at line 540 of file tinyxml.h.

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

STL std::string form.

Definition at line 541 of file tinyxml.h.

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 357 of file tinyxml.cpp.

TiXmlNode* FirstChild ( const char * _value )

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

Definition at line 526 of file tinyxml.h.

const TiXmlElement * FirstChildElement ( ) const

Convenience function to get through elements.

Definition at line 448 of file tinyxml.cpp.

const TiXmlElement * FirstChildElement ( const char * _value ) const

Convenience function to get through elements.

Definition at line 463 of file tinyxml.cpp.

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

STL std::string form.

Definition at line 676 of file tinyxml.h.

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

STL std::string form.

Definition at line 677 of file tinyxml.h.

const TiXmlDocument * GetDocument ( ) const

Return a pointer to the Document this node lives in.

Returns null if not in a document.

Definition at line 508 of file tinyxml.cpp.

const void* GetUserData ( ) const [inherited]

Get a pointer to arbitrary user data.

Definition at line 249 of file tinyxml.h.

void* GetUserData ( ) [inherited]

Get a pointer to arbitrary user data.

Definition at line 248 of file tinyxml.h.

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 260 of file tinyxml.cpp.

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 228 of file tinyxml.cpp.

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 213 of file tinyxml.cpp.

static bool IsWhiteSpaceCondensed ( ) [static, inherited]

Return the current white space setting.

Definition at line 224 of file tinyxml.h.

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 381 of file tinyxml.cpp.

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

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

Definition at line 395 of file tinyxml.cpp.

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

STL std::string form.

Definition at line 574 of file tinyxml.h.

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

STL std::string form.

Definition at line 575 of file tinyxml.h.

TiXmlNode* LastChild ( const char * _value )

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

Definition at line 535 of file tinyxml.h.

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

STL std::string form.

Definition at line 542 of file tinyxml.h.

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

STL std::string form.

Definition at line 543 of file tinyxml.h.

TiXmlNode* LastChild ( )

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

Definition at line 532 of file tinyxml.h.

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 186 of file tinyxml.cpp.

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

STL std::string form.

Definition at line 626 of file tinyxml.h.

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

STL std::string form.

Definition at line 627 of file tinyxml.h.

const TiXmlNode * NextSibling ( const char * _value ) const

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

Definition at line 409 of file tinyxml.cpp.

const TiXmlNode* NextSibling ( ) const

Navigate to a sibling node.

Definition at line 631 of file tinyxml.h.

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

STL std::string form.

Definition at line 660 of file tinyxml.h.

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 493 of file tinyxml.cpp.

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 478 of file tinyxml.cpp.

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

STL std::string form.

Definition at line 659 of file tinyxml.h.

bool NoChildren ( ) const

Returns true if this node has no children.

Definition at line 695 of file tinyxml.h.

TiXmlNode* Parent ( )

One step up the DOM.

Definition at line 519 of file tinyxml.h.

const TiXmlNode* PreviousSibling ( ) const

Navigate to a sibling node.

Definition at line 614 of file tinyxml.h.

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

STL std::string form.

Definition at line 625 of file tinyxml.h.

const TiXmlNode * PreviousSibling ( const char * _value ) const

Navigate to a sibling node.

Definition at line 421 of file tinyxml.cpp.

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

STL std::string form.

Definition at line 624 of file tinyxml.h.

virtual void Print	(	FILE *	cfile,
		int	depth
	)		const `[pure virtual, inherited]`

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

bool RemoveChild ( TiXmlNode * removeThis )

Delete a child of this node.

Definition at line 331 of file tinyxml.cpp.

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 292 of file tinyxml.cpp.

int Row ( ) const [inherited]

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

Definition at line 244 of file tinyxml.h.

static void SetCondenseWhiteSpace ( bool condense ) [static, inherited]

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.

Definition at line 221 of file tinyxml.h.

void SetUserData ( void * user ) [inherited]

Set a pointer to arbitrary user data.

Definition at line 247 of file tinyxml.h.

void SetValue ( const std::string & _value )

STL std::string form.

Definition at line 512 of file tinyxml.h.

void SetValue ( const char * _value )

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 508 of file tinyxml.h.

virtual TiXmlComment* ToComment ( ) [virtual]