#include <tinyxml.h>

Inheritance diagram for TiXmlDocument:

Public Member Functions
	TiXmlDocument ()
	Create an empty document, that has no name. More...

	TiXmlDocument (const char *documentName)
	Create a document with a name. The name of the document is also the filename of the xml. More...

	TiXmlDocument (const std::string &documentName)
	Constructor. More...

	TiXmlDocument (const TiXmlDocument &copy)

TiXmlDocument &	operator= (const TiXmlDocument &copy)

virtual	~TiXmlDocument ()

bool	LoadFile (TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)

bool	SaveFile () const
	Save a file using the current document value. Returns true if successful. More...

bool	LoadFile (const char *filename, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)
	Load a file using the given filename. Returns true if successful. More...

bool	SaveFile (const char *filename) const
	Save a file using the given filename. Returns true if successful. More...

bool	LoadFile (FILE *, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)

bool	SaveFile (FILE *) const
	Save a file using the given FILE*. Returns true if successful. More...

bool	LoadFile (const std::string &filename, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)

bool	SaveFile (const std::string &filename) const
	< STL std::string version. More...

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

const TiXmlElement *	RootElement () const

TiXmlElement *	RootElement ()

bool	Error () const

const char *	ErrorDesc () const
	Contains a textual (english) description of the error if one occurs. More...

int	ErrorId () const

int	ErrorRow () const

int	ErrorCol () const
	The column where the error occured. See ErrorRow() More...

void	SetTabSize (int _tabsize)

int	TabSize () const

void	ClearError ()

void	Print () const

virtual void	Print (FILE *cfile, int depth=0) const
	Print this Document to a FILE stream. More...

void	SetError (int err, const char errorLocation, TiXmlParsingData prevData, TiXmlEncoding encoding)

virtual const TiXmlDocument *	ToDocument () const
	Cast to a more defined type. Will return null not of the requested type. More...

virtual TiXmlDocument *	ToDocument ()
	Cast to a more defined type. Will return null not of the requested type. More...

virtual bool	Accept (TiXmlVisitor *content) const

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 *	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

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 *	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 TiXmlElement *	ToElement () const
	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 const TiXmlComment *	ToComment () const
	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 const TiXmlUnknown *	ToUnknown () const
	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 const TiXmlText *	ToText () const
	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 const TiXmlDeclaration *	ToDeclaration () const
	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...

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
virtual TiXmlNode *	Clone () const

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

void	CopyTo (TiXmlNode *target) const

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]

Detailed Description

Always the top level node. A document binds together all the XML pieces. It can be saved, loaded, and printed to the screen. The 'value' of a document node is the xml file name.

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

TiXmlDocument::TiXmlDocument ( )

Create an empty document, that has no name.

TiXmlDocument::TiXmlDocument ( const char * documentName )

Create a document with a name. The name of the document is also the filename of the xml.

TiXmlDocument::TiXmlDocument ( const std::string & documentName )

Constructor.

TiXmlDocument::TiXmlDocument ( const TiXmlDocument & copy )

virtual TiXmlDocument::~TiXmlDocument ( )

inlinevirtual

Member Function Documentation

virtual bool TiXmlDocument::Accept ( TiXmlVisitor * content ) 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'.

void TiXmlDocument::ClearError ( )

inline

If you have handled the error, it can be reset with this call. The error state is automatically cleared if you Parse a new XML block.

References TiXmlCursor::col, and TiXmlCursor::row.

virtual TiXmlNode* TiXmlDocument::Clone ( ) const

protectedvirtual

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

Implements TiXmlNode.

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

protectedinherited

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!

bool TiXmlDocument::Error ( ) const

inline

If an error occurs, Error will be set to true. Also,

The ErrorId() will contain the integer identifier of the error (not generally useful)
The ErrorDesc() method will return the name of the error. (very useful)
The ErrorRow() and ErrorCol() will return the location of the error (if known)

int TiXmlDocument::ErrorCol ( ) const

inline

The column where the error occured. See ErrorRow()

References TiXmlCursor::col.

const char* TiXmlDocument::ErrorDesc ( ) const

inline

Contains a textual (english) description of the error if one occurs.

int TiXmlDocument::ErrorId ( ) const

inline

Generally, you probably want the error string ( ErrorDesc() ). But if you prefer the ErrorId, this function will fetch it.

int TiXmlDocument::ErrorRow ( ) const

inline

Returns the location (if known) of the error. The first column is column 1, and the first row is row 1. A value of 0 means the row and column wasn't applicable (memory errors, for example, have no row/column) or the parser lost the error. (An error in the error reporting, in that case.)

See also: SetTabSize, Row, Column

References TiXmlCursor::row.

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

References TiXmlBase::GetEntity(), and TIXML_ENCODING_UTF8.

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

References TiXmlBase::IsWhiteSpace().

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

bool TiXmlDocument::LoadFile ( TiXmlEncoding encoding = TIXML_DEFAULT_ENCODING )

Load a file using the current document value. Returns true if successful. Will delete any existing document data before loading.

Referenced by LoadFile().

bool TiXmlDocument::LoadFile	(	const char *	filename,
		TiXmlEncoding	encoding = `TIXML_DEFAULT_ENCODING`
	)

Load a file using the given filename. Returns true if successful.

bool TiXmlDocument::LoadFile	(	FILE *	,
		TiXmlEncoding	encoding = `TIXML_DEFAULT_ENCODING`
	)

Load a file using the given FILE*. Returns true if successful. Note that this method doesn't stream - the entire object pointed at by the FILE* will be interpreted as an XML file. TinyXML doesn't stream in XML from the current file location. Streaming may be added in the future.

bool TiXmlDocument::LoadFile	(	const std::string &	filename,
		TiXmlEncoding	encoding = `TIXML_DEFAULT_ENCODING`
	)

inline

Parameters

encoding STL std::string version.

References LoadFile().

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.

TiXmlDocument& TiXmlDocument::operator= ( const TiXmlDocument & copy )

TiXmlNode* TiXmlNode::Parent ( )

inlineinherited

One step up the DOM.

References TiXmlNode::parent.

const TiXmlNode* TiXmlNode::Parent ( ) const

inlineinherited

References TiXmlNode::parent.

virtual const char* TiXmlDocument::Parse	(	const char *	p,
		TiXmlParsingData *	data = `0`,
		TiXmlEncoding	encoding = `TIXML_DEFAULT_ENCODING`
	)

virtual

Parse the given null terminated block of xml data. Passing in an encoding to this method (either TIXML_ENCODING_LEGACY or TIXML_ENCODING_UTF8 will force TinyXml to use that encoding, regardless of what TinyXml might otherwise try to detect.

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

void TiXmlDocument::Print ( ) const

inline

Write the document to standard out using formatted printing ("pretty print").

References Print().

Referenced by Print().

virtual void TiXmlDocument::Print	(	FILE *	cfile,
		int	depth = `0`
	)		const

virtual

Print this Document to a FILE stream.

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.

const TiXmlElement* TiXmlDocument::RootElement ( ) const

inline

Get the root element – the only top level element – of the document. In well formed XML, there should only be one. TinyXml is tolerant of multiple elements at the document level.

References TiXmlNode::FirstChildElement().

TiXmlElement* TiXmlDocument::RootElement ( )

inline

References TiXmlNode::FirstChildElement().

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.

bool TiXmlDocument::SaveFile ( ) const

Save a file using the current document value. Returns true if successful.

Referenced by SaveFile().

bool TiXmlDocument::SaveFile ( const char * filename ) const

Save a file using the given filename. Returns true if successful.

bool TiXmlDocument::SaveFile ( FILE * ) const

Save a file using the given FILE*. Returns true if successful.

bool TiXmlDocument::SaveFile ( const std::string & filename ) const

inline

< STL std::string version.

References SaveFile().

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 TiXmlDocument::SetError	(	int	err,
		const char *	errorLocation,
		TiXmlParsingData *	prevData,
		TiXmlEncoding	encoding
	)

void TiXmlDocument::SetTabSize ( int _tabsize )

inline

SetTabSize() allows the error reporting functions (ErrorRow() and ErrorCol()) to report the correct values for row and column. It does not change the output or input in any way.

By calling this method, with a tab size greater than 0, the row and column of each node and attribute is stored when the file is loaded. Very useful for tracking the DOM back in to the source file.

The tab size is required for calculating the location of nodes. If not set, the default of 4 is used. The tabsize is set per document. Setting the tabsize to 0 disables row/column tracking.

Note that row and column tracking is not supported when using operator>>.

The tab size needs to be enabled before the parse or load. Correct usage:

TiXmlDocument doc;
doc.SetTabSize( 8 );
doc.Load( "myfile.xml" );

See also: Row, Column

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::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 TiXmlDocument::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

int TiXmlDocument::TabSize ( ) const

inline

virtual const TiXmlComment* TiXmlNode::ToComment ( ) const

inlinevirtualinherited

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

Reimplemented in TiXmlComment.

virtual TiXmlComment* TiXmlNode::ToComment ( )

inlinevirtualinherited

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

Reimplemented in TiXmlComment.

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* TiXmlDocument::ToDocument ( ) const

inlinevirtual

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

Reimplemented from TiXmlNode.

virtual TiXmlDocument* TiXmlDocument::ToDocument ( )

inlinevirtual

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

Reimplemented from TiXmlNode.

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.