TiXmlElement Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlElement:

Public Member Functions
	TiXmlElement (const char *in_value)
	Construct an element.
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	QueryDoubleAttribute (const char *name, double *value) const
	QueryDoubleAttribute examines the attribute - see QueryIntAttribute().
int	QueryDoubleAttribute (const char *name, float *value) const
	QueryFloatAttribute examines the attribute - see QueryIntAttribute().
void	SetAttribute (const char *name, const char *value)
void	SetAttribute (const char *name, int value)
void	SetDoubleAttribute (const char *name, double value)
void	RemoveAttribute (const char *name)
const TiXmlAttribute *	FirstAttribute () const
	Access the first attribute in this element.
const TiXmlAttribute *	LastAttribute () const
	Access the last attribute in this element.
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
Public Member Functions inherited from TiXmlNode
const char *	Value () const
void	SetValue (const char *_value)
void	Clear ()
	Delete all the children of this node. Does not affect 'this'.
TiXmlNode *	Parent ()
	One step up the DOM.
const TiXmlNode *	FirstChild () const
	The first child of this node. Will be null if there are no children.
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.
TiXmlNode *	LastChild ()
	The last child of this node. Will be null if there are no children.
TiXmlNode *	LastChild (const char *value)
	The last child of this node matching 'value'. Will be null if there are no children.
const TiXmlNode *	IterateChildren (const TiXmlNode *previous) const
const TiXmlNode *	IterateChildren (const char *value, const TiXmlNode *previous) const
	This flavor of IterateChildren searches for children with a particular 'value'.
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.
const TiXmlNode *	PreviousSibling () const
	Navigate to a sibling node.
const TiXmlNode *	PreviousSibling (const char *) const
	Navigate to a sibling node.
const TiXmlNode *	NextSibling () const
	Navigate to a sibling node.
const TiXmlNode *	NextSibling (const char *) const
	Navigate to a sibling node with the given 'value'.
const TiXmlElement *	NextSiblingElement () const
const TiXmlElement *	NextSiblingElement (const char *) const
const TiXmlElement *	FirstChildElement () const
	Convenience function to get through elements.
const TiXmlElement *	FirstChildElement (const char *value) const
	Convenience function to get through elements.
virtual int	Type () const
const TiXmlDocument *	GetDocument () const
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 TiXmlBase
int	Row () const
int	Column () const
	See Row()

Additional Inherited Members
Public Types inherited from TiXmlNode
enum	NodeType
Static Public Member Functions inherited from TiXmlBase
static void	SetCondenseWhiteSpace (bool condense)
static bool	IsWhiteSpaceCondensed ()
	Return the current white space setting.
Protected Attributes inherited from TiXmlBase
void *	userData
	Field containing a generic user pointer.

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

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

virtual void 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 TiXmlBase.

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

void RemoveAttribute

(

const char *

name

)

Deletes an attribute with the given name.

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

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

---

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

• tinyxml.h