#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLElement:

Public Member Functions
const char *	Name () const
	Get the name of an element (which is the Value() of the node.)
void	SetName (const char *str, bool staticMem=false)
	Set the name of the element.
virtual XMLElement *	ToElement ()
	Safely cast to an Element, or null.
virtual bool	Accept (XMLVisitor *visitor) const
const char *	Attribute (const char name, const char value=0) const
int	IntAttribute (const char *name) const
unsigned	UnsignedAttribute (const char *name) const
	See IntAttribute()
bool	BoolAttribute (const char *name) const
	See IntAttribute()
double	DoubleAttribute (const char *name) const
	See IntAttribute()
float	FloatAttribute (const char *name) const
	See IntAttribute()
int	QueryIntAttribute (const char name, int _value) const
int	QueryUnsignedAttribute (const char name, unsigned int _value) const
	See QueryIntAttribute()
int	QueryBoolAttribute (const char name, bool _value) const
	See QueryIntAttribute()
int	QueryDoubleAttribute (const char name, double _value) const
	See QueryIntAttribute()
int	QueryFloatAttribute (const char name, float _value) const
	See QueryIntAttribute()
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, bool _value)
	Sets the named attribute to value.
void	SetAttribute (const char *name, double _value)
	Sets the named attribute to value.
void	DeleteAttribute (const char *name)
const XMLAttribute *	FirstAttribute () const
	Return the first attribute in the list.
const XMLAttribute *	FindAttribute (const char *name) const
	Query a specific attribute in the list.
const char *	GetText () const
virtual XMLNode *	ShallowClone (XMLDocument *document) const
virtual bool	ShallowEqual (const XMLNode *compare) const

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

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

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

This is essentially a SAX interface for TinyXML. (Note however it doesn't re-parse the XML for the callbacks, so the performance of TinyXML is unchanged by using this interface versus any other.)

The interface has been based on ideas from:

http://www.saxproject.org/
- http://c2.com/cgi/wiki?HierarchicalVisitorPattern

Which are both good references for "visiting".

An example of using Accept():

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

Implements tinyxml2::XMLNode.

const char* 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();
        }

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

Delete an attribute.

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

int tinyxml2::XMLElement::IntAttribute ( const char * name ) const [inline]

Given an attribute name, IntAttribute() returns the value of the attribute interpreted as an integer. 0 will be returned if there is an error. For a method with error checking, see QueryIntAttribute()

int tinyxml2::XMLElement::QueryIntAttribute	(	const char *	name,
		int *	_value
	)		const `[inline]`

Given an attribute name, QueryIntAttribute() returns XML_NO_ERROR, 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

virtual XMLNode* tinyxml2::XMLElement::ShallowClone ( XMLDocument * document ) const [virtual]

Make a copy of this node, but not its children. You may pass in a Document pointer that will be the owner of the new Node. If the 'document' is null, then the node returned will be allocated from the current Document. (this->GetDocument())

Note: if called on a XMLDocument, this will return null.

Implements tinyxml2::XMLNode.

virtual bool tinyxml2::XMLElement::ShallowEqual ( const XMLNode * compare ) const [virtual]

Test if 2 nodes are the same, but don't test children. The 2 nodes do not need to be in the same Document.

Note: if called on a XMLDocument, this will return false.

Implements tinyxml2::XMLNode.

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

tinyxml2.h

Public Member Functions

Detailed Description

Member Function Documentation