TiXmlElement Class Reference

#include <tinyxml.h>

Inheritance diagram for TiXmlElement:

Collaboration diagram for TiXmlElement:

List of all members.

Public Member Functions

TiXmlElement (const char *in_value)

Construct an element.

TiXmlElement (const TiXmlElement &)

void 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 QueryDoubleAttribute (const char *name, double *_value) const

QueryDoubleAttribute examines the attribute - see QueryIntAttribute().

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

TiXmlAttribute * FirstAttribute ()

const TiXmlAttribute * LastAttribute () const

Access the last attribute in this element.

TiXmlAttribute * LastAttribute ()

const char * GetText () const

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

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.

virtual TiXmlElement * ToElement ()

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

Protected Member Functions

void CopyTo (TiXmlElement *target) const

void ClearThis ()

virtual void StreamOut (TIXML_OSTREAM *out) const

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

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

Constructor & Destructor Documentation

TiXmlElement::TiXmlElement ( const char * in_value )

Construct an element.

Definition at line 616 of file tinyxml.cpp.

References TiXmlNode::firstChild, TiXmlNode::lastChild, and TiXmlNode::value.

Referenced by Clone().

TiXmlElement::TiXmlElement ( const TiXmlElement & copy )

Definition at line 634 of file tinyxml.cpp.

References CopyTo(), TiXmlNode::firstChild, and TiXmlNode::lastChild.

TiXmlElement::~TiXmlElement ( ) [virtual]

Definition at line 649 of file tinyxml.cpp.

References ClearThis().

Member Function Documentation

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

Definition at line 642 of file tinyxml.cpp.

References ClearThis(), and CopyTo().

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 667 of file tinyxml.cpp.

References attributeSet, TiXmlAttributeSet::Find(), TIXML_STRING, and TiXmlAttribute::Value().

Referenced by Attribute().

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 679 of file tinyxml.cpp.

References Attribute().

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 693 of file tinyxml.cpp.

References Attribute().

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 707 of file tinyxml.cpp.

References attributeSet, TiXmlAttributeSet::Find(), TiXmlAttribute::QueryIntValue(), TIXML_NO_ATTRIBUTE, and TIXML_STRING.

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

QueryDoubleAttribute examines the attribute - see QueryIntAttribute().

Definition at line 718 of file tinyxml.cpp.

References attributeSet, TiXmlAttributeSet::Find(), TiXmlAttribute::QueryDoubleValue(), TIXML_NO_ATTRIBUTE, and TIXML_STRING.

Referenced by QueryFloatAttribute().

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

QueryFloatAttribute examines the attribute - see QueryIntAttribute().

Definition at line 887 of file tinyxml.h.

References QueryDoubleAttribute(), and TIXML_SUCCESS.

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 763 of file tinyxml.cpp.

References TiXmlAttributeSet::Add(), attributeSet, TiXmlAttributeSet::Find(), TiXmlNode::GetDocument(), TiXmlDocument::SetError(), TiXmlAttribute::SetValue(), TIXML_ENCODING_UNKNOWN, TiXmlBase::TIXML_ERROR_OUT_OF_MEMORY, and TIXML_STRING.

Referenced by CopyTo(), Lugre::LuaXML_FillNode(), SetAttribute(), and SetDoubleAttribute().

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 729 of file tinyxml.cpp.

References SetAttribute().

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 751 of file tinyxml.cpp.

References SetAttribute().

void TiXmlElement::RemoveAttribute ( const char * name )

Deletes an attribute with the given name.

Definition at line 468 of file tinyxml.cpp.

References attributeSet, TiXmlAttributeSet::Find(), TiXmlAttributeSet::Remove(), and TIXML_STRING.

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

Access the first attribute in this element.

Definition at line 931 of file tinyxml.h.

References attributeSet, and TiXmlAttributeSet::First().

Referenced by Lugre::LuaXML_ParseNode().

TiXmlAttribute* TiXmlElement::FirstAttribute ( ) [inline]

Definition at line 932 of file tinyxml.h.

References attributeSet, and TiXmlAttributeSet::First().

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

Access the last attribute in this element.

Definition at line 933 of file tinyxml.h.

References attributeSet, and TiXmlAttributeSet::Last().

TiXmlAttribute* TiXmlElement::LastAttribute ( ) [inline]

Definition at line 934 of file tinyxml.h.

References attributeSet, and TiXmlAttributeSet::Last().

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 928 of file tinyxml.cpp.

References TiXmlNode::FirstChild(), TiXmlNode::ToText(), and TiXmlNode::Value().

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

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

Implements TiXmlNode.

Definition at line 917 of file tinyxml.cpp.

References CopyTo(), TiXmlElement(), and TiXmlNode::Value().

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

Definition at line 812 of file tinyxml.cpp.

References attributeSet, TiXmlAttributeSet::First(), TiXmlNode::firstChild, TiXmlNode::lastChild, TiXmlAttribute::Next(), TiXmlNode::NextSibling(), TiXmlBase::Print(), TiXmlNode::ToText(), and TiXmlNode::value.

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

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

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

Definition at line 894 of file tinyxml.cpp.

References attributeSet, TiXmlNode::Clone(), TiXmlNode::CopyTo(), TiXmlAttributeSet::First(), TiXmlNode::firstChild, TiXmlNode::LinkEndChild(), TiXmlAttribute::Name(), TiXmlAttribute::Next(), TiXmlNode::NextSibling(), SetAttribute(), and TiXmlAttribute::Value().

Referenced by Clone(), operator=(), and TiXmlElement().

void TiXmlElement::ClearThis ( ) [protected]

Definition at line 655 of file tinyxml.cpp.

References attributeSet, TiXmlNode::Clear(), TiXmlAttributeSet::First(), and TiXmlAttributeSet::Remove().

Referenced by operator=(), and ~TiXmlElement().

void TiXmlElement::StreamOut ( TIXML_OSTREAM * out ) const [protected, virtual]

Implements TiXmlBase.

Definition at line 863 of file tinyxml.cpp.

References attributeSet, TiXmlAttributeSet::First(), TiXmlNode::firstChild, TiXmlAttribute::Next(), TiXmlNode::NextSibling(), TiXmlBase::StreamOut(), TiXmlAttribute::StreamOut(), and TiXmlNode::value.

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

Definition at line 1142 of file tinyxmlparser.cpp.

References TiXmlText::Blank(), TiXmlNode::GetDocument(), TiXmlNode::Identify(), TiXmlBase::IsWhiteSpaceCondensed(), TiXmlNode::LinkEndChild(), TiXmlBase::Parse(), TiXmlText::Parse(), TiXmlDocument::SetError(), TiXmlBase::SkipWhiteSpace(), TiXmlBase::StringEqual(), TiXmlBase::TIXML_ERROR_OUT_OF_MEMORY, and TiXmlBase::TIXML_ERROR_READING_ELEMENT_VALUE.

Referenced by Parse().

Member Data Documentation

TiXmlAttributeSet TiXmlElement::attributeSet [private]

Definition at line 1002 of file tinyxml.h.

Referenced by Attribute(), ClearThis(), CopyTo(), FirstAttribute(), LastAttribute(), Parse(), Print(), QueryDoubleAttribute(), QueryIntAttribute(), RemoveAttribute(), SetAttribute(), and StreamOut().

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

/var/www/sfz/trunk/lugre/include/tinyxml.h
/var/www/sfz/trunk/lugre/src/tinyxml.cpp
/var/www/sfz/trunk/lugre/src/tinyxmlparser.cpp


Public Member Functions
	TiXmlElement (const char *in_value)
	Construct an element.
	TiXmlElement (const TiXmlElement &)
void	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	QueryDoubleAttribute (const char name, double _value) const
	QueryDoubleAttribute examines the attribute - see QueryIntAttribute().
int	QueryFloatAttribute (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.
TiXmlAttribute *	FirstAttribute ()
const TiXmlAttribute *	LastAttribute () const
	Access the last attribute in this element.
TiXmlAttribute *	LastAttribute ()
const char *	GetText () const
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
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.
virtual TiXmlElement *	ToElement ()
	Cast to a more defined type. Will return null not of the requested type.
Protected Member Functions
void	CopyTo (TiXmlElement *target) const
void	ClearThis ()
virtual void	StreamOut (TIXML_OSTREAM *out) const
const char *	ReadValue (const char in, TiXmlParsingData prevData, TiXmlEncoding encoding)
Private Attributes
TiXmlAttributeSet	attributeSet