#include <tinyxml2.h>

Inheritance diagram for BT_TinyXML2::XMLElement:

Public Types
enum	ElementClosingType { OPEN, CLOSED, CLOSING }
Public Member Functions
virtual bool	Accept (XMLVisitor *visitor) const
const char *	Attribute (const char name, const char value=0) const
bool	BoolAttribute (const char *name, bool defaultValue=false) const
	See IntAttribute()
bool	BoolText (bool defaultValue=false) const
	See QueryIntText()
ElementClosingType	ClosingType () const
void	DeleteAttribute (const char *name)
double	DoubleAttribute (const char *name, double defaultValue=0) const
	See IntAttribute()
double	DoubleText (double defaultValue=0) const
	See QueryIntText()
const XMLAttribute *	FindAttribute (const char *name) const
	Query a specific attribute in the list.
const XMLAttribute *	FirstAttribute () const
	Return the first attribute in the list.
float	FloatAttribute (const char *name, float defaultValue=0) const
	See IntAttribute()
float	FloatText (float defaultValue=0) const
	See QueryIntText()
const char *	GetText () const
int64_t	Int64Attribute (const char *name, int64_t defaultValue=0) const
	See IntAttribute()
int64_t	Int64Text (int64_t defaultValue=0) const
	See QueryIntText()
int	IntAttribute (const char *name, int defaultValue=0) const
int	IntText (int defaultValue=0) const
const char *	Name () const
	Get the name of an element (which is the Value() of the node.)
XMLError	QueryAttribute (const char name, int value) const
XMLError	QueryAttribute (const char name, unsigned int value) const
XMLError	QueryAttribute (const char name, int64_t value) const
XMLError	QueryAttribute (const char name, bool value) const
XMLError	QueryAttribute (const char name, double value) const
XMLError	QueryAttribute (const char name, float value) const
XMLError	QueryBoolAttribute (const char name, bool value) const
	See QueryIntAttribute()
XMLError	QueryBoolText (bool *bval) const
	See QueryIntText()
XMLError	QueryDoubleAttribute (const char name, double value) const
	See QueryIntAttribute()
XMLError	QueryDoubleText (double *dval) const
	See QueryIntText()
XMLError	QueryFloatAttribute (const char name, float value) const
	See QueryIntAttribute()
XMLError	QueryFloatText (float *fval) const
	See QueryIntText()
XMLError	QueryInt64Attribute (const char name, int64_t value) const
	See QueryIntAttribute()
XMLError	QueryInt64Text (int64_t *uval) const
	See QueryIntText()
XMLError	QueryIntAttribute (const char name, int value) const
XMLError	QueryIntText (int *ival) const
XMLError	QueryStringAttribute (const char name, const char *value) const
	See QueryIntAttribute()
XMLError	QueryUnsignedAttribute (const char name, unsigned int value) const
	See QueryIntAttribute()
XMLError	QueryUnsignedText (unsigned *uval) const
	See QueryIntText()
void	SetAttribute (const char name, const char value)
	Sets the named attribute to value.
void	SetAttribute (const char *name, int value)
	Sets the named attribute to value.
void	SetAttribute (const char *name, unsigned value)
	Sets the named attribute to value.
void	SetAttribute (const char *name, int64_t value)
	Sets the named attribute to value.
void	SetAttribute (const char *name, bool value)
	Sets the named attribute to value.
void	SetAttribute (const char *name, double value)
	Sets the named attribute to value.
void	SetAttribute (const char *name, float value)
	Sets the named attribute to value.
void	SetName (const char *str, bool staticMem=false)
	Set the name of the element.
void	SetText (const char *inText)
void	SetText (int value)
	Convenience method for setting text inside an element. See SetText() for important limitations.
void	SetText (unsigned value)
	Convenience method for setting text inside an element. See SetText() for important limitations.
void	SetText (int64_t value)
	Convenience method for setting text inside an element. See SetText() for important limitations.
void	SetText (bool value)
	Convenience method for setting text inside an element. See SetText() for important limitations.
void	SetText (double value)
	Convenience method for setting text inside an element. See SetText() for important limitations.
void	SetText (float value)
	Convenience method for setting text inside an element. See SetText() for important limitations.
virtual XMLNode *	ShallowClone (XMLDocument *document) const
virtual bool	ShallowEqual (const XMLNode *compare) const
virtual XMLElement *	ToElement ()
	Safely cast to an Element, or null.
virtual const XMLElement *	ToElement () const
unsigned	UnsignedAttribute (const char *name, unsigned defaultValue=0) const
	See IntAttribute()
unsigned	UnsignedText (unsigned defaultValue=0) const
	See QueryIntText()
Protected Member Functions
char *	ParseDeep (char p, StrPair parentEndTag, int *curLineNumPtr)
Private Types
enum	{ BUF_SIZE = 200 }
Private Member Functions
XMLAttribute *	CreateAttribute ()
XMLAttribute *	FindOrCreateAttribute (const char *name)
void	operator= (const XMLElement &)
char *	ParseAttributes (char p, int curLineNumPtr)
	XMLElement (XMLDocument *doc)
	XMLElement (const XMLElement &)
virtual	~XMLElement ()
Static Private Member Functions
static void	DeleteAttribute (XMLAttribute *attribute)
Private Attributes
ElementClosingType	_closingType
XMLAttribute *	_rootAttribute
Friends
class	XMLDocument

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.

Definition at line 1247 of file tinyxml2.h.

Member Enumeration Documentation

anonymous enum [private]

Enumerator:

BUF_SIZE

Definition at line 1633 of file tinyxml2.h.

enum BT_TinyXML2::XMLElement::ElementClosingType

Enumerator:

OPEN
CLOSED
CLOSING

Definition at line 1608 of file tinyxml2.h.

Constructor & Destructor Documentation

BT_TinyXML2::XMLElement::XMLElement ( XMLDocument * doc ) [private]

Definition at line 1498 of file tinyxml2.cpp.

BT_TinyXML2::XMLElement::~XMLElement ( ) [private, virtual]

Definition at line 1505 of file tinyxml2.cpp.

BT_TinyXML2::XMLElement::XMLElement ( const XMLElement & ) [private]

Member Function Documentation

bool BT_TinyXML2::XMLElement::Accept ( XMLVisitor * visitor ) const [virtual]

Accept a hierarchical visit of the nodes in the TinyXML-2 DOM. Every node in the XML tree will be conditionally visited and the host will be called back via the XMLVisitor interface.

This is essentially a SAX interface for TinyXML-2. (Note however it doesn't re-parse the XML for the callbacks, so the performance of TinyXML-2 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():

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

Implements BT_TinyXML2::XMLNode.

Definition at line 1966 of file tinyxml2.cpp.

const char * BT_TinyXML2::XMLElement::Attribute	(	const char *	name,
		const char *	value = `0`
	)		const

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

    	const char* value = ele->Attribute( "foo" );

The 'value' parameter is normally null. However, if specified, the attribute will only be returned if the 'name' and 'value' match. This allow you to write code:

    	if ( ele->Attribute( "foo", "bar" ) ) callFooIsBar();

rather than:

    	if ( ele->Attribute( "foo" ) ) {
    		if ( strcmp( ele->Attribute( "foo" ), "bar" ) == 0 ) callFooIsBar();
    	}

Definition at line 1526 of file tinyxml2.cpp.

bool BT_TinyXML2::XMLElement::BoolAttribute	(	const char *	name,
		bool	defaultValue = `false`
	)		const

See IntAttribute()

Definition at line 1559 of file tinyxml2.cpp.

bool BT_TinyXML2::XMLElement::BoolText ( bool defaultValue = false ) const

See QueryIntText()

Definition at line 1746 of file tinyxml2.cpp.

ElementClosingType BT_TinyXML2::XMLElement::ClosingType ( ) const [inline]

Definition at line 1613 of file tinyxml2.h.

XMLAttribute * BT_TinyXML2::XMLElement::CreateAttribute ( ) [private]

Definition at line 1884 of file tinyxml2.cpp.

void BT_TinyXML2::XMLElement::DeleteAttribute ( const char * name )

Delete an attribute.

Definition at line 1796 of file tinyxml2.cpp.

void BT_TinyXML2::XMLElement::DeleteAttribute ( XMLAttribute * attribute ) [static, private]

Definition at line 1874 of file tinyxml2.cpp.

double BT_TinyXML2::XMLElement::DoubleAttribute	(	const char *	name,
		double	defaultValue = `0`
	)		const

See IntAttribute()

Definition at line 1566 of file tinyxml2.cpp.

double BT_TinyXML2::XMLElement::DoubleText ( double defaultValue = 0 ) const

See QueryIntText()

Definition at line 1753 of file tinyxml2.cpp.

const XMLAttribute * BT_TinyXML2::XMLElement::FindAttribute ( const char * name ) const

Query a specific attribute in the list.

Definition at line 1515 of file tinyxml2.cpp.

XMLAttribute * BT_TinyXML2::XMLElement::FindOrCreateAttribute ( const char * name ) [private]

Definition at line 1768 of file tinyxml2.cpp.

const XMLAttribute* BT_TinyXML2::XMLElement::FirstAttribute ( ) const [inline]

Return the first attribute in the list.

Definition at line 1472 of file tinyxml2.h.

float BT_TinyXML2::XMLElement::FloatAttribute	(	const char *	name,
		float	defaultValue = `0`
	)		const

See IntAttribute()

Definition at line 1573 of file tinyxml2.cpp.

float BT_TinyXML2::XMLElement::FloatText ( float defaultValue = 0 ) const

See QueryIntText()

Definition at line 1760 of file tinyxml2.cpp.

const char * BT_TinyXML2::XMLElement::GetText ( ) const

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

If the first child of 'this' is a XMLText, 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 ".

Definition at line 1580 of file tinyxml2.cpp.

int64_t BT_TinyXML2::XMLElement::Int64Attribute	(	const char *	name,
		int64_t	defaultValue = `0`
	)		const

See IntAttribute()

Definition at line 1552 of file tinyxml2.cpp.

int64_t BT_TinyXML2::XMLElement::Int64Text ( int64_t defaultValue = 0 ) const

See QueryIntText()

Definition at line 1739 of file tinyxml2.cpp.

int BT_TinyXML2::XMLElement::IntAttribute	(	const char *	name,
		int	defaultValue = `0`
	)		const

Given an attribute name, IntAttribute() returns the value of the attribute interpreted as an integer. The default value will be returned if the attribute isn't present, or if there is an error. (For a method with error checking, see QueryIntAttribute()).

Definition at line 1538 of file tinyxml2.cpp.

int BT_TinyXML2::XMLElement::IntText ( int defaultValue = 0 ) const

Definition at line 1725 of file tinyxml2.cpp.

const char* BT_TinyXML2::XMLElement::Name ( ) const [inline]

Get the name of an element (which is the Value() of the node.)

Definition at line 1252 of file tinyxml2.h.

void BT_TinyXML2::XMLElement::operator= ( const XMLElement & ) [private]

char * BT_TinyXML2::XMLElement::ParseAttributes	(	char *	p,
		int *	curLineNumPtr
	)		`[private]`

Definition at line 1815 of file tinyxml2.cpp.

char * BT_TinyXML2::XMLElement::ParseDeep	(	char *	p,
		StrPair *	parentEndTag,
		int *	curLineNumPtr
	)		`[protected, virtual]`

Reimplemented from BT_TinyXML2::XMLNode.

Definition at line 1898 of file tinyxml2.cpp.

XMLError BT_TinyXML2::XMLElement::QueryAttribute	(	const char *	name,
		int *	value
	)		const `[inline]`

Given an attribute name, QueryAttribute() returns XML_SUCCESS, XML_WRONG_ATTRIBUTE_TYPE if the conversion can't be performed, or XML_NO_ATTRIBUTE if the attribute doesn't exist. It is overloaded for the primitive types, and is a generally more convenient replacement of QueryIntAttribute() and related functions.

If successful, the result of the conversion will be written to 'value'. If not successful, nothing will be written to 'value'. This allows you to provide default value:

    	int value = 10;
    	QueryAttribute( "foo", &value );		// if "foo" isn't found, value will still be 10

Definition at line 1404 of file tinyxml2.h.

XMLError BT_TinyXML2::XMLElement::QueryAttribute	(	const char *	name,
		unsigned int *	value
	)		const `[inline]`

Definition at line 1408 of file tinyxml2.h.

XMLError BT_TinyXML2::XMLElement::QueryAttribute	(	const char *	name,
		int64_t *	value
	)		const `[inline]`

Definition at line 1412 of file tinyxml2.h.

XMLError BT_TinyXML2::XMLElement::QueryAttribute	(	const char *	name,
		bool *	value
	)		const `[inline]`

Definition at line 1416 of file tinyxml2.h.

XMLError BT_TinyXML2::XMLElement::QueryAttribute	(	const char *	name,
		double *	value
	)		const `[inline]`

Definition at line 1420 of file tinyxml2.h.

XMLError BT_TinyXML2::XMLElement::QueryAttribute	(	const char *	name,
		float *	value
	)		const `[inline]`

Definition at line 1424 of file tinyxml2.h.

XMLError BT_TinyXML2::XMLElement::QueryBoolAttribute	(	const char *	name,
		bool *	value
	)		const `[inline]`

See QueryIntAttribute()

Definition at line 1351 of file tinyxml2.h.

XMLError BT_TinyXML2::XMLElement::QueryBoolText ( bool * bval ) const

See QueryIntText()

Definition at line 1687 of file tinyxml2.cpp.

XMLError BT_TinyXML2::XMLElement::QueryDoubleAttribute	(	const char *	name,
		double *	value
	)		const `[inline]`

See QueryIntAttribute()

Definition at line 1359 of file tinyxml2.h.

XMLError BT_TinyXML2::XMLElement::QueryDoubleText ( double * dval ) const

See QueryIntText()

Definition at line 1700 of file tinyxml2.cpp.

XMLError BT_TinyXML2::XMLElement::QueryFloatAttribute	(	const char *	name,
		float *	value
	)		const `[inline]`

See QueryIntAttribute()

Definition at line 1367 of file tinyxml2.h.

XMLError BT_TinyXML2::XMLElement::QueryFloatText ( float * fval ) const

See QueryIntText()

Definition at line 1713 of file tinyxml2.cpp.

XMLError BT_TinyXML2::XMLElement::QueryInt64Attribute	(	const char *	name,
		int64_t *	value
	)		const `[inline]`

See QueryIntAttribute()

Definition at line 1342 of file tinyxml2.h.

XMLError BT_TinyXML2::XMLElement::QueryInt64Text ( int64_t * uval ) const

See QueryIntText()

Definition at line 1674 of file tinyxml2.cpp.

XMLError BT_TinyXML2::XMLElement::QueryIntAttribute	(	const char *	name,
		int *	value
	)		const `[inline]`

Given an attribute name, QueryIntAttribute() returns XML_SUCCESS, XML_WRONG_ATTRIBUTE_TYPE if the conversion can't be performed, or XML_NO_ATTRIBUTE if the attribute doesn't exist. If successful, the result of the conversion will be written to 'value'. If not successful, nothing will be written to 'value'. This allows you to provide default value:

    	int value = 10;
    	QueryIntAttribute( "foo", &value );		// if "foo" isn't found, value will still be 10

Definition at line 1324 of file tinyxml2.h.

XMLError BT_TinyXML2::XMLElement::QueryIntText ( int * ival ) const

Convenience method to query the value of a child text node. This is probably best shown by example. Given you have a document is this form:

    		<point>
    			<x>1</x>
    			<y>1.4</y>
    		</point>

The QueryIntText() and similar functions provide a safe and easier way to get to the "value" of x and y.

    		int x = 0;
    		float y = 0;	// types of x and y are contrived for example
    		const XMLElement* xElement = pointElement->FirstChildElement( "x" );
    		const XMLElement* yElement = pointElement->FirstChildElement( "y" );
    		xElement->QueryIntText( &x );
    		yElement->QueryFloatText( &y );

Returns:: XML_SUCCESS (0) on success, XML_CAN_NOT_CONVERT_TEXT if the text cannot be converted to the requested type, and XML_NO_TEXT_NODE if there is no child text to query.

Definition at line 1648 of file tinyxml2.cpp.

XMLError BT_TinyXML2::XMLElement::QueryStringAttribute	(	const char *	name,
		const char **	value
	)		const `[inline]`

See QueryIntAttribute()

Definition at line 1376 of file tinyxml2.h.

XMLError BT_TinyXML2::XMLElement::QueryUnsignedAttribute	(	const char *	name,
		unsigned int *	value
	)		const `[inline]`

See QueryIntAttribute()

Definition at line 1333 of file tinyxml2.h.

XMLError BT_TinyXML2::XMLElement::QueryUnsignedText ( unsigned * uval ) const

See QueryIntText()

Definition at line 1661 of file tinyxml2.cpp.

void BT_TinyXML2::XMLElement::SetAttribute	(	const char *	name,
		const char *	value
	)		`[inline]`