The element is a container class. More...

#include <tinyxml.h>

Inheritance diagram for gear::TiXmlElement:

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

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

	TiXmlElement (const TiXmlElement &)

TiXmlElement &	operator= (const TiXmlElement &base)

const char *	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 *	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. More...

const char *	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. More...

int	QueryIntAttribute (const char name, int value) const
	QueryIntAttribute examines the attribute - it is an alternative to the Attribute() method with richer error checking. More...

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

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

void	SetAttribute (const char name, const char value)
	Sets an attribute of name to a given value. More...

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

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

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

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

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

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

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

void	SetAttribute (const char *name, int value)
	Sets an attribute of name to a given value. More...

void	SetDoubleAttribute (const char *name, double value)
	Sets an attribute of name to a given value. More...

void	RemoveAttribute (const char *name)
	Deletes an attribute with the given name.

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

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

TiXmlAttribute *	FirstAttribute ()

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

TiXmlAttribute *	LastAttribute ()

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

virtual void	Print (FILE *cfile, int depth) const
	All TinyXml classes can print themselves to a filestream. More...

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

Public Member Functions inherited from gear::TiXmlNode
const char *	Value () const
	The meaning of 'value' changes for the specific type of TiXmlNode. More...

void	SetValue (const char *_value)
	Changes the value of the node. More...

void	SetValue (const std::string &_value)
	STL std::string form.

void	Clear ()
	Delete all the children of this node. Does not affect 'this'.

TiXmlNode *	Parent ()
	One step up the DOM.

const TiXmlNode *	Parent () const

const TiXmlNode *	FirstChild () const
	The first child of this node. Will be null if there are no children.

TiXmlNode *	FirstChild ()

const TiXmlNode *	FirstChild (const char *value) const
	The first child of this node with the matching 'value'. Will be null if none found.

TiXmlNode *	FirstChild (const char *value)
	The first child of this node with the matching 'value'. Will be null if none found.

const TiXmlNode *	LastChild () const

TiXmlNode *	LastChild ()
	The last child of this node. Will be null if there are no children.

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.

const TiXmlNode *	FirstChild (const std::string &_value) const
	STL std::string form.

TiXmlNode *	FirstChild (const std::string &_value)
	STL std::string form.

const TiXmlNode *	LastChild (const std::string &_value) const
	STL std::string form.

TiXmlNode *	LastChild (const std::string &_value)
	STL std::string form.

const TiXmlNode *	IterateChildren (const TiXmlNode *previous) const
	An alternate way to walk the children of a node. More...

TiXmlNode *	IterateChildren (TiXmlNode *previous)

const TiXmlNode *	IterateChildren (const char value, const TiXmlNode previous) const
	This flavor of IterateChildren searches for children with a particular 'value'.

TiXmlNode *	IterateChildren (const char value, TiXmlNode previous)

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

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

TiXmlNode *	InsertEndChild (const TiXmlNode &addThis)
	Add a new node related to this. More...

TiXmlNode *	LinkEndChild (TiXmlNode *addThis)
	Add a new node related to this. More...

TiXmlNode *	InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
	Add a new node related to this. More...

TiXmlNode *	InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
	Add a new node related to this. More...

TiXmlNode *	ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
	Replace a child of this node. More...

bool	RemoveChild (TiXmlNode *removeThis)
	Delete a child of this node.

const TiXmlNode *	PreviousSibling () const
	Navigate to a sibling node.

TiXmlNode *	PreviousSibling ()

const TiXmlNode *	PreviousSibling (const char *) const
	Navigate to a sibling node.

TiXmlNode *	PreviousSibling (const char *)

const TiXmlNode *	PreviousSibling (const std::string &_value) const
	STL std::string form.

TiXmlNode *	PreviousSibling (const std::string &_value)
	STL std::string form.

const TiXmlNode *	NextSibling (const std::string &_value) const
	STL std::string form.

TiXmlNode *	NextSibling (const std::string &_value)
	STL std::string form.

const TiXmlNode *	NextSibling () const
	Navigate to a sibling node.

TiXmlNode *	NextSibling ()

const TiXmlNode *	NextSibling (const char *) const
	Navigate to a sibling node with the given 'value'.

TiXmlNode *	NextSibling (const char *)

const TiXmlElement *	NextSiblingElement () const
	Convenience function to get through elements. More...

TiXmlElement *	NextSiblingElement ()

const TiXmlElement *	NextSiblingElement (const char *) const
	Convenience function to get through elements. More...

TiXmlElement *	NextSiblingElement (const char *)

const TiXmlElement *	NextSiblingElement (const std::string &_value) const
	STL std::string form.

TiXmlElement *	NextSiblingElement (const std::string &_value)
	STL std::string form.

const TiXmlElement *	FirstChildElement () const
	Convenience function to get through elements.

TiXmlElement *	FirstChildElement ()

const TiXmlElement *	FirstChildElement (const char *value) const
	Convenience function to get through elements.

TiXmlElement *	FirstChildElement (const char *value)

const TiXmlElement *	FirstChildElement (const std::string &_value) const
	STL std::string form.

TiXmlElement *	FirstChildElement (const std::string &_value)
	STL std::string form.

virtual int	Type () const
	Query the type (as an enumerated value, above) of this node. More...

const TiXmlDocument *	GetDocument () const
	Return a pointer to the Document this node lives in. More...

TiXmlDocument *	GetDocument ()

bool	NoChildren () const
	Returns true if this node has no children.

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

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

const TiXmlComment *	ToComment () const
	Cast to a more defined type. Will return null not of the requested type.

const TiXmlUnknown *	ToUnknown () const
	Cast to a more defined type. Will return null not of the requested type.

const TiXmlText *	ToText () const
	Cast to a more defined type. Will return null not of the requested type.

const TiXmlDeclaration *	ToDeclaration () const
	Cast to a more defined type. Will return null not of the requested type.

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

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

TiXmlComment *	ToComment ()
	Cast to a more defined type. Will return null not of the requested type.

TiXmlUnknown *	ToUnknown ()
	Cast to a more defined type. Will return null not of the requested type.

TiXmlText *	ToText ()
	Cast to a more defined type. Will return null not of the requested type.

TiXmlDeclaration *	ToDeclaration ()
	Cast to a more defined type. Will return null not of the requested type.

Public Member Functions inherited from gear::TiXmlBase
int	Row () const
	Return the position, in the original source file, of this node or attribute. More...

int	Column () const
	See Row()

void	SetUserData (void *user)

void *	GetUserData ()

Protected Member Functions
void	CopyTo (TiXmlElement *target) const

void	ClearThis ()

virtual void	StreamIn (TIXML_ISTREAM in, TIXML_STRING tag)

virtual void	StreamOut (TIXML_OSTREAM *out) const

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

Protected Member Functions inherited from gear::TiXmlNode
	TiXmlNode (NodeType _type)

void	CopyTo (TiXmlNode *target) const

TiXmlNode *	Identify (const char *start, TiXmlEncoding encoding)

const TIXML_STRING &	SValue () const

Additional Inherited Members
Public Types inherited from gear::TiXmlNode
enum	NodeType { DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, DECLARATION, TYPECOUNT }
	The types of XML nodes supported by TinyXml. More...

Public Types inherited from gear::TiXmlBase
enum	{ TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, TIXML_ERROR_OUT_OF_MEMORY, 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_STRING_COUNT }

Static Public Member Functions inherited from gear::TiXmlBase
static void	SetCondenseWhiteSpace (bool condense)
	The world does not agree on whether white space should be kept or not. More...

static bool	IsWhiteSpaceCondensed ()
	Return the current white space setting.

Static Public Attributes inherited from gear::TiXmlBase
static const int	utf8ByteTable [256]

Static Protected Member Functions inherited from gear::TiXmlBase
static const char *	SkipWhiteSpace (const char *, TiXmlEncoding encoding)

static bool	IsWhiteSpace (char c)

static bool	StreamWhiteSpace (TIXML_ISTREAM in, TIXML_STRING tag)

static bool	StreamTo (TIXML_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 void	PutString (const TIXML_STRING &str, TIXML_OSTREAM *out)

static void	PutString (const TIXML_STRING &str, TIXML_STRING *out)

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 inherited from gear::TiXmlNode
TiXmlNode *	parent {}

NodeType	type {}

TiXmlNode *	firstChild {}

TiXmlNode *	lastChild {}

TIXML_STRING	value {}

TiXmlNode *	prev {}

TiXmlNode *	next {}

Protected Attributes inherited from gear::TiXmlBase
TiXmlCursor	location {}

void *	userData
	Field containing a generic user pointer.

Static Protected Attributes inherited from gear::TiXmlBase
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.

Definition at line 827 of file tinyxml.h.

Member Function Documentation

const char * gear::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 682 of file tinyxml.cc.

References Attribute().

const char * gear::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 696 of file tinyxml.cc.

References Attribute().

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

virtual

All TinyXml classes can print themselves to a filestream.

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

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

Implements gear::TiXmlBase.

Definition at line 767 of file tinyxml.cc.

References gear::TiXmlAttribute::Next(), gear::TiXmlNode::NextSibling(), gear::TiXmlBase::Print(), and gear::TiXmlNode::ToText().

int gear::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 710 of file tinyxml.cc.

References gear::TiXmlAttribute::QueryIntValue().