#include <tinyxml.h>

Inheritance diagram for TiXmlElement:

Public Member Functions
	TiXmlElement (const char *in_value)
	Construct an element. More...

	TiXmlElement (const std::string &_value)
	std::string constructor. More...

	TiXmlElement (const TiXmlElement &)

TiXmlElement &	operator= (const TiXmlElement &base)

virtual	~TiXmlElement ()

const char *	Attribute (const char *name) const

const char *	Attribute (const char name, int i) const

const char *	Attribute (const char name, double d) const

int	QueryIntAttribute (const char name, int _value) const

int	QueryUnsignedAttribute (const char name, unsigned _value) const
	QueryUnsignedAttribute examines the attribute - see QueryIntAttribute(). More...

int	QueryBoolAttribute (const char name, bool _value) const

int	QueryDoubleAttribute (const char name, double _value) const
	QueryDoubleAttribute examines the attribute - see QueryIntAttribute(). More...

int	QueryFloatAttribute (const char name, float _value) const
	QueryFloatAttribute examines the attribute - see QueryIntAttribute(). More...

int	QueryStringAttribute (const char name, std::string _value) const
	QueryStringAttribute examines the attribute - see QueryIntAttribute(). More...

template<typename T >
int	QueryValueAttribute (const std::string &name, T *outValue) const

int	QueryValueAttribute (const std::string &name, std::string *outValue) const

void	SetAttribute (const char name, const char _value)

const std::string *	Attribute (const std::string &name) const

const std::string *	Attribute (const std::string &name, int *i) const

const std::string *	Attribute (const std::string &name, double *d) const

int	QueryIntAttribute (const std::string &name, int *_value) const

int	QueryDoubleAttribute (const std::string &name, double *_value) const

void	SetAttribute (const std::string &name, const std::string &_value)
	STL std::string form. More...

void	SetAttribute (const std::string &name, int _value)
	STL std::string form. More...

void	SetDoubleAttribute (const std::string &name, double value)

void	SetAttribute (const char *name, int value)

void	SetDoubleAttribute (const char *name, double value)

void	RemoveAttribute (const char *name)

void	RemoveAttribute (const std::string &name)
	STL std::string form. More...

const TiXmlAttribute *	FirstAttribute () const
	Access the first attribute in this element. More...

TiXmlAttribute *	FirstAttribute ()

const TiXmlAttribute *	LastAttribute () const
	Access the last attribute in this element. More...

TiXmlAttribute *	LastAttribute ()

const char *	GetText () const

virtual TiXmlNode *	Clone () const
	Creates a new Element and returns it - the returned element is a copy. More...

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

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

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

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

virtual bool	Accept (TiXmlVisitor *visitor) const

const char *	Value () const

const std::string &	ValueStr () const

const TIXML_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 TiXmlDocument *	ToDocument () 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 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
void	CopyTo (TiXmlElement *target) const

void	ClearThis ()

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

const char *	ReadValue (const char in, TiXmlParsingData prevData, TiXmlEncoding encoding)

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

The element is a container class. It has a value, the element name, and can contain other elements, text, comments, and unknowns. Elements also contain an arbitrary number of attributes.

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

TiXmlElement::TiXmlElement ( const char * in_value )

Construct an element.

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

std::string constructor.

TiXmlElement::TiXmlElement ( const TiXmlElement & )

virtual TiXmlElement::~TiXmlElement ( )

virtual

Member Function Documentation

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

virtual

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

Implements TiXmlNode.

const char* TiXmlElement::Attribute ( const char * name ) const

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.

const char* TiXmlElement::Attribute	(	const char *	name,
		int *	i
	)		const

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists. If the attribute exists and can be converted to an integer, the integer value will be put in the return 'i', if 'i' is non-null.

const char* TiXmlElement::Attribute	(	const char *	name,
		double *	d
	)		const

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists. If the attribute exists and can be converted to an double, the double value will be put in the return 'd', if 'd' is non-null.

const std::string* TiXmlElement::Attribute ( const std::string & name ) const

const std::string* TiXmlElement::Attribute	(	const std::string &	name,
		int *	i
	)		const

const std::string* TiXmlElement::Attribute	(	const std::string &	name,
		double *	d
	)		const

void TiXmlNode::Clear ( )

inherited

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

void TiXmlElement::ClearThis ( )

protected

virtual TiXmlNode* TiXmlElement::Clone ( ) const

virtual

Creates a new Element and returns it - the returned element is a copy.

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

void TiXmlElement::CopyTo ( TiXmlElement * 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 TiXmlAttribute* TiXmlElement::FirstAttribute ( ) const

inline

Access the first attribute in this element.

References TiXmlAttributeSet::First().

TiXmlAttribute* TiXmlElement::FirstAttribute ( )

inline

References TiXmlAttributeSet::First().

const TiXmlNode* TiXmlNode::FirstChild ( ) const

inlineinherited

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

References TiXmlNode::firstChild.

TiXmlNode* TiXmlNode::FirstChild ( )

inlineinherited

References TiXmlNode::firstChild.

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

inherited

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

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

inlineinherited

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

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

inlineinherited

STL std::string form.

References TiXmlNode::FirstChild().

Referenced by TiXmlNode::FirstChild().

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

inlineinherited

STL std::string form.

References TiXmlNode::FirstChild().

Referenced by TiXmlNode::FirstChild().

const TiXmlElement* TiXmlNode::FirstChildElement ( ) const

inherited

Convenience function to get through elements.

Referenced by TiXmlDocument::RootElement().

TiXmlElement* TiXmlNode::FirstChildElement ( )

inlineinherited

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

inherited

Convenience function to get through elements.

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

inlineinherited

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

inlineinherited

STL std::string form.

References TiXmlNode::FirstChildElement().

Referenced by TiXmlNode::FirstChildElement().

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

inlineinherited

STL std::string form.

References TiXmlNode::FirstChildElement().

Referenced by TiXmlNode::FirstChildElement().

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

inlinestaticprotectedinherited

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

const char* TiXmlElement::GetText ( ) const

Convenience function for easy access to the text inside an element. Although easy and concise, GetText() is limited compared to getting the TiXmlText child and accessing it directly.

If the first child of 'this' is a TiXmlText, the GetText() returns the character string of the Text node, else null is returned.

This is a convenient method for getting the text of simple contained text:

<foo>This is text</foo>
const char* str = fooElement->GetText();

'str' will be a pointer to "This is text".

Note that this function can be misleading. If the element foo was created from this XML:

<foo><b>This is text</b></foo>

then the value of str would be null. The first child node isn't a text node, it is another element. From this XML:

<foo>This is <b>text</b></foo>

GetText() will return "This is ".

WARNING: GetText() accesses a child node - don't become confused with the similarly named TiXmlHandle::Text() and TiXmlNode::ToText() which are safe type casts on the referenced node.

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 TiXmlAttribute* TiXmlElement::LastAttribute ( ) const

inline

Access the last attribute in this element.

References TiXmlAttributeSet::Last().

TiXmlAttribute* TiXmlElement::LastAttribute ( )

inline

References TiXmlAttributeSet::Last().

const TiXmlNode* TiXmlNode::LastChild ( ) const

inlineinherited

References TiXmlNode::lastChild.

TiXmlNode* TiXmlNode::LastChild ( )

inlineinherited

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

References TiXmlNode::lastChild.

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

inherited

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

inlineinherited

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

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

inlineinherited

STL std::string form.

References TiXmlNode::LastChild().

Referenced by TiXmlNode::LastChild().

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

inlineinherited

STL std::string form.

References TiXmlNode::LastChild().

Referenced by TiXmlNode::LastChild().

TiXmlNode* TiXmlNode::LinkEndChild ( TiXmlNode * addThis )

inherited

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

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

See also: InsertEndChild

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

inlineinherited

STL std::string form.

References TiXmlNode::NextSibling().

Referenced by TiXmlNode::NextSibling().

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

inlineinherited

STL std::string form.

References TiXmlNode::NextSibling().

Referenced by TiXmlNode::NextSibling().

const TiXmlNode* TiXmlNode::NextSibling ( ) const

inlineinherited

Navigate to a sibling node.

References TiXmlNode::next.

TiXmlNode* TiXmlNode::NextSibling ( )

inlineinherited

References TiXmlNode::next.

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

inherited

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

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

inlineinherited

const TiXmlElement* TiXmlNode::NextSiblingElement ( ) const

inherited

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

TiXmlElement* TiXmlNode::NextSiblingElement ( )

inlineinherited

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

inherited

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

TiXmlElement* TiXmlNode::NextSiblingElement ( const char * _next )

inlineinherited

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

inlineinherited

STL std::string form.

References TiXmlNode::NextSiblingElement().

Referenced by TiXmlNode::NextSiblingElement().

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

inlineinherited

STL std::string form.

References TiXmlNode::NextSiblingElement().

Referenced by TiXmlNode::NextSiblingElement().

bool TiXmlNode::NoChildren ( ) const

inlineinherited

Returns true if this node has no children.

References TiXmlNode::firstChild.

TiXmlElement& TiXmlElement::operator= ( const TiXmlElement & base )

TiXmlNode* TiXmlNode::Parent ( )

inlineinherited

One step up the DOM.

References TiXmlNode::parent.

const TiXmlNode* TiXmlNode::Parent ( ) const

inlineinherited

References TiXmlNode::parent.

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

virtual

Implements TiXmlBase.

const TiXmlNode* TiXmlNode::PreviousSibling ( ) const

inlineinherited

Navigate to a sibling node.

References TiXmlNode::prev.

TiXmlNode* TiXmlNode::PreviousSibling ( )

inlineinherited

References TiXmlNode::prev.

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

inherited

Navigate to a sibling node.

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

inlineinherited

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

inlineinherited

STL std::string form.

References TiXmlNode::PreviousSibling().

Referenced by TiXmlNode::PreviousSibling().

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

inlineinherited

STL std::string form.

References TiXmlNode::PreviousSibling().

Referenced by TiXmlNode::PreviousSibling().

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

virtual

All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null.

This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

Implements TiXmlBase.

int TiXmlElement::QueryBoolAttribute	(	const char *	name,
		bool *	_value
	)		const

QueryBoolAttribute examines the attribute - see QueryIntAttribute(). Note that '1', 'true', or 'yes' are considered true, while '0', 'false' and 'no' are considered false.

int TiXmlElement::QueryDoubleAttribute	(	const char *	name,
		double *	_value
	)		const

QueryDoubleAttribute examines the attribute - see QueryIntAttribute().

Referenced by QueryFloatAttribute().

int TiXmlElement::QueryDoubleAttribute	(	const std::string &	name,
		double *	_value
	)		const

int TiXmlElement::QueryFloatAttribute	(	const char *	name,
		float *	_value
	)		const

inline

QueryFloatAttribute examines the attribute - see QueryIntAttribute().

References QueryDoubleAttribute(), and TIXML_SUCCESS.

int TiXmlElement::QueryIntAttribute	(	const char *	name,
		int *	_value
	)		const

QueryIntAttribute examines the attribute - it is an alternative to the Attribute() method with richer error checking. If the attribute is an integer, it is stored in 'value' and the call returns TIXML_SUCCESS. If it is not an integer, it returns TIXML_WRONG_TYPE. If the attribute does not exist, then TIXML_NO_ATTRIBUTE is returned.

int TiXmlElement::QueryIntAttribute	(	const std::string &	name,
		int *	_value
	)		const

int TiXmlElement::QueryStringAttribute	(	const char *	name,
		std::string *	_value
	)		const

inline

QueryStringAttribute examines the attribute - see QueryIntAttribute().

int TiXmlElement::QueryUnsignedAttribute	(	const char *	name,
		unsigned *	_value
	)		const

QueryUnsignedAttribute examines the attribute - see QueryIntAttribute().

template<typename T >

int TiXmlElement::QueryValueAttribute	(	const std::string &	name,
		T *	outValue
	)		const

inline

Template form of the attribute query which will try to read the attribute into the specified type. Very easy, very powerful, but be careful to make sure to call this with the correct type.

NOTE: This method doesn't work correctly for 'string' types that contain spaces.

Returns: TIXML_SUCCESS, TIXML_WRONG_TYPE, or TIXML_NO_ATTRIBUTE

References TiXmlAttributeSet::Find(), TIXML_NO_ATTRIBUTE, TIXML_SUCCESS, TIXML_WRONG_TYPE, and TiXmlAttribute::ValueStr().

int TiXmlElement::QueryValueAttribute	(	const std::string &	name,
		std::string *	outValue
	)		const

inline

References TiXmlAttributeSet::Find(), TIXML_NO_ATTRIBUTE, TIXML_SUCCESS, and TiXmlAttribute::ValueStr().

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

const char* TiXmlElement::ReadValue	(	const char *	in,
		TiXmlParsingData *	prevData,
		TiXmlEncoding	encoding
	)

protected

void TiXmlElement::RemoveAttribute ( const char * name )

Deletes an attribute with the given name.

void TiXmlElement::RemoveAttribute ( const std::string & name )

inline

STL std::string form.

References RemoveAttribute().

Referenced by RemoveAttribute().

bool TiXmlNode::RemoveChild ( TiXmlNode * removeThis )

inherited

Delete a child of this node.

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

inherited

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

int TiXmlBase::Row ( ) const

inlineinherited

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

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

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

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

See also: TiXmlDocument::SetTabSize()

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

void TiXmlElement::SetAttribute	(	const char *	name,
		const char *	_value
	)

Sets an attribute of name to a given value. The attribute will be created if it does not exist, or changed if it does.

void TiXmlElement::SetAttribute	(	const std::string &	name,
		const std::string &	_value
	)

STL std::string form.

void TiXmlElement::SetAttribute	(	const std::string &	name,
		int	_value
	)

STL std::string form.

void TiXmlElement::SetAttribute	(	const char *	name,
		int	value
	)

Sets an attribute of name to a given value. The attribute will be created if it does not exist, or changed if it does.

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 TiXmlElement::SetDoubleAttribute	(	const std::string &	name,
		double	value
	)

void TiXmlElement::SetDoubleAttribute	(	const char *	name,
		double	value
	)

Sets an attribute of name to a given value. The attribute will be created if it does not exist, or changed if it does.

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 TiXmlElement::StreamIn	(	std::istream *	in,
		TIXML_STRING *	tag
	)

protectedvirtual

Implements TiXmlNode.

static bool TiXmlBase::StreamTo	(	std::istream *	in,
		int	character,
		TIXML_STRING *	tag
	)

staticprotectedinherited

static bool TiXmlBase::StreamWhiteSpace	(	std::istream *	in,
		TIXML_STRING *	tag
	)

staticprotectedinherited

static bool TiXmlBase::StringEqual	(	const char *	p,
		const char *	endTag,
		bool	ignoreCase,
		TiXmlEncoding	encoding
	)

staticprotectedinherited

virtual const TiXmlComment* 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* TiXmlNode::ToDocument ( ) const

inlinevirtualinherited

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

Reimplemented in TiXmlDocument.

virtual TiXmlDocument* TiXmlNode::ToDocument ( )

inlinevirtualinherited

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

Reimplemented in TiXmlDocument.

virtual const TiXmlElement* TiXmlElement::ToElement ( ) const

inlinevirtual

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

Reimplemented from TiXmlNode.

virtual TiXmlElement* TiXmlElement::ToElement ( )

inlinevirtual

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

Reimplemented from TiXmlNode.

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.