#include <tinyxml.h>

Inheritance diagram for TiXmlElement:

Public Member Functions
virtual bool	Accept (TiXmlVisitor *visitor) const
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
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
virtual TiXmlNode *	Clone () const
	Creates a new Element and returns it - the returned element is a copy.
const TiXmlAttribute *	FirstAttribute () const
	Access the first attribute in this element.
TiXmlAttribute *	FirstAttribute ()
const char *	GetText () const
const TiXmlAttribute *	LastAttribute () const
	Access the last attribute in this element.
TiXmlAttribute *	LastAttribute ()
TiXmlElement &	operator= (const TiXmlElement &base)
virtual const char *	Parse (const char p, TiXmlParsingData data, TiXmlEncoding encoding)
virtual void	Print (FILE *cfile, int depth) const
int	QueryBoolAttribute (const char name, bool _value) const
int	QueryDoubleAttribute (const char name, double _value) const
	QueryDoubleAttribute examines the attribute - see QueryIntAttribute().
int	QueryDoubleAttribute (const std::string &name, double *_value) const
int	QueryFloatAttribute (const char name, float _value) const
	QueryFloatAttribute examines the attribute - see QueryIntAttribute().
int	QueryIntAttribute (const char name, int _value) const
int	QueryIntAttribute (const std::string &name, int *_value) const
int	QueryStringAttribute (const char name, std::string _value) const
	QueryStringAttribute examines the attribute - see QueryIntAttribute().
int	QueryUnsignedAttribute (const char name, unsigned _value) const
	QueryUnsignedAttribute examines the attribute - see QueryIntAttribute().
template<typename T >
int	QueryValueAttribute (const std::string &name, T *outValue) const
int	QueryValueAttribute (const std::string &name, std::string *outValue) const
void	RemoveAttribute (const char *name)
void	RemoveAttribute (const std::string &name)
	STL std::string form.
void	SetAttribute (const char name, const char _value)
void	SetAttribute (const std::string &name, const std::string &_value)
void	SetAttribute (const std::string &name, int _value)
	STL std::string form.
void	SetAttribute (const char *name, int value)
void	SetDoubleAttribute (const std::string &name, double value)
void	SetDoubleAttribute (const char *name, double value)
	TiXmlElement (const char *in_value)
	Construct an element.
	TiXmlElement (const std::string &_value)
	std::string constructor.
	TiXmlElement (const TiXmlElement &)
virtual const TiXmlElement *	ToElement () const
	Cast to a more defined type. Will return null not of the requested type.
virtual TiXmlElement *	ToElement ()
	Cast to a more defined type. Will return null not of the requested type.
virtual	~TiXmlElement ()
Protected Member Functions
void	ClearThis ()
void	CopyTo (TiXmlElement *target) const
const char *	ReadValue (const char in, TiXmlParsingData prevData, TiXmlEncoding encoding)
virtual void	StreamIn (std::istream in, TIXML_STRING tag)
Private Attributes
TiXmlAttributeSet	attributeSet

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

Constructor & Destructor Documentation

TiXmlElement::TiXmlElement ( const char * in_value )

Construct an element.

Definition at line 525 of file tinyxml.cpp.

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

std::string constructor.

Definition at line 534 of file tinyxml.cpp.

TiXmlElement::TiXmlElement ( const TiXmlElement & copy )

Definition at line 543 of file tinyxml.cpp.

TiXmlElement::~TiXmlElement ( ) [virtual]

Definition at line 559 of file tinyxml.cpp.

Member Function Documentation

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

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

Implements TiXmlNode.

Definition at line 875 of file tinyxml.cpp.

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.

Definition at line 577 of file tinyxml.cpp.

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.

Definition at line 597 of file tinyxml.cpp.

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.

Definition at line 629 of file tinyxml.cpp.

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

Definition at line 587 of file tinyxml.cpp.

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

Definition at line 613 of file tinyxml.cpp.

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

Definition at line 645 of file tinyxml.cpp.

void TiXmlElement::ClearThis ( ) [protected]

Definition at line 565 of file tinyxml.cpp.

TiXmlNode * TiXmlElement::Clone ( ) const [virtual]

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

Implements TiXmlNode.

Definition at line 889 of file tinyxml.cpp.

void TiXmlElement::CopyTo ( TiXmlElement * target ) const [protected]

Definition at line 853 of file tinyxml.cpp.

const TiXmlAttribute* TiXmlElement::FirstAttribute ( ) const [inline]

Access the first attribute in this element.

Definition at line 1089 of file tinyxml.h.

TiXmlAttribute* TiXmlElement::FirstAttribute ( ) [inline]

Definition at line 1090 of file tinyxml.h.

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.

Definition at line 900 of file tinyxml.cpp.

const TiXmlAttribute* TiXmlElement::LastAttribute ( ) const [inline]

Access the last attribute in this element.

Definition at line 1091 of file tinyxml.h.

TiXmlAttribute* TiXmlElement::LastAttribute ( ) [inline]

Definition at line 1092 of file tinyxml.h.

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

Definition at line 551 of file tinyxml.cpp.

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

Implements TiXmlBase.

Definition at line 1043 of file tinyxmlparser.cpp.

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.

Definition at line 800 of file tinyxml.cpp.

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.

Definition at line 683 of file tinyxml.cpp.

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

QueryDoubleAttribute examines the attribute - see QueryIntAttribute().

Definition at line 720 of file tinyxml.cpp.

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

Definition at line 730 of file tinyxml.cpp.

int TiXmlElement::QueryFloatAttribute	(	const char *	name,
		float *	_value
	)		const `[inline]`

QueryFloatAttribute examines the attribute - see QueryIntAttribute().

Definition at line 1001 of file tinyxml.h.

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.

Definition at line 661 of file tinyxml.cpp.

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

Definition at line 710 of file tinyxml.cpp.

int TiXmlElement::QueryStringAttribute	(	const char *	name,
		std::string *	_value
	)		const `[inline]`

QueryStringAttribute examines the attribute - see QueryIntAttribute().

Definition at line 1012 of file tinyxml.h.

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

QueryUnsignedAttribute examines the attribute - see QueryIntAttribute().

Definition at line 670 of file tinyxml.cpp.

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

Definition at line 1029 of file tinyxml.h.

int TiXmlElement::QueryValueAttribute	(	const std::string &	name,
		std::string *	outValue
	)		const `[inline]`

Definition at line 1042 of file tinyxml.h.

const char * TiXmlElement::ReadValue	(	const char *	in,
		TiXmlParsingData *	prevData,
		TiXmlEncoding	encoding
	)		`[protected]`

Definition at line 1179 of file tinyxmlparser.cpp.

void TiXmlElement::RemoveAttribute ( const char * name )

Deletes an attribute with the given name.

Definition at line 437 of file tinyxml.cpp.

void TiXmlElement::RemoveAttribute ( const std::string & name ) [inline]

STL std::string form.

Definition at line 1086 of file tinyxml.h.

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.

Definition at line 780 of file tinyxml.cpp.

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

STL std::string form.

Definition at line 790 of file tinyxml.cpp.

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

STL std::string form.

Definition at line 750 of file tinyxml.cpp.

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.

Definition at line 740 of file tinyxml.cpp.

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

Definition at line 770 of file tinyxml.cpp.

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.

Definition at line 760 of file tinyxml.cpp.

void TiXmlElement::StreamIn	(	std::istream *	in,
		TIXML_STRING *	tag
	)		`[protected, virtual]`

Implements TiXmlNode.

Definition at line 903 of file tinyxmlparser.cpp.

virtual const TiXmlElement* TiXmlElement::ToElement ( ) const [inline, virtual]

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

Reimplemented from TiXmlNode.

Definition at line 1138 of file tinyxml.h.

virtual TiXmlElement* TiXmlElement::ToElement ( ) [inline, virtual]

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

Reimplemented from TiXmlNode.

Definition at line 1139 of file tinyxml.h.

Member Data Documentation

TiXmlAttributeSet TiXmlElement::attributeSet [private]

Definition at line 1161 of file tinyxml.h.

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

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation