The element is a container class. More...

#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLElement:

Public Types
enum	ElementClosingType { OPEN, CLOSED, CLOSING }

Public Member Functions
virtual bool	Accept (XMLVisitor *visitor) const
	Accept a hierarchical visit of the nodes in the TinyXML-2 DOM. More...

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

bool	BoolAttribute (const char *name, bool defaultValue=false) const
	See IntAttribute() More...

bool	BoolText (bool defaultValue=false) const
	See QueryIntText() More...

ElementClosingType	ClosingType () const

void	DeleteAttribute (const char *name)
	Delete an attribute. More...

double	DoubleAttribute (const char *name, double defaultValue=0) const
	See IntAttribute() More...

double	DoubleText (double defaultValue=0) const
	See QueryIntText() More...

const XMLAttribute *	FindAttribute (const char *name) const
	Query a specific attribute in the list. More...

const XMLAttribute *	FirstAttribute () const
	Return the first attribute in the list. More...

float	FloatAttribute (const char *name, float defaultValue=0) const
	See IntAttribute() More...

float	FloatText (float defaultValue=0) const
	See QueryIntText() More...

const char *	GetText () const
	Convenience function for easy access to the text inside an element. More...

int64_t	Int64Attribute (const char *name, int64_t defaultValue=0) const
	See IntAttribute() More...

int64_t	Int64Text (int64_t defaultValue=0) const
	See QueryIntText() More...

int	IntAttribute (const char *name, int defaultValue=0) const
	Given an attribute name, IntAttribute() returns the value of the attribute interpreted as an integer. More...

int	IntText (int defaultValue=0) const

const char *	Name () const
	Get the name of an element (which is the Value() of the node.) More...

XMLError	QueryAttribute (const char name, int value) const
	Given an attribute name, QueryAttribute() returns XML_SUCCESS, XML_WRONG_ATTRIBUTE_TYPE if the conversion can't be performed, or XML_NO_ATTRIBUTE if the attribute doesn't exist. More...

XMLError	QueryAttribute (const char name, unsigned int value) const

XMLError	QueryAttribute (const char name, int64_t value) const

XMLError	QueryAttribute (const char name, uint64_t value) const

XMLError	QueryAttribute (const char name, bool value) const

XMLError	QueryAttribute (const char name, double value) const

XMLError	QueryAttribute (const char name, float value) const

XMLError	QueryBoolAttribute (const char name, bool value) const
	See QueryIntAttribute() More...

XMLError	QueryBoolText (bool *bval) const
	See QueryIntText() More...

XMLError	QueryDoubleAttribute (const char name, double value) const
	See QueryIntAttribute() More...

XMLError	QueryDoubleText (double *dval) const
	See QueryIntText() More...

XMLError	QueryFloatAttribute (const char name, float value) const
	See QueryIntAttribute() More...

XMLError	QueryFloatText (float *fval) const
	See QueryIntText() More...

XMLError	QueryInt64Attribute (const char name, int64_t value) const
	See QueryIntAttribute() More...

XMLError	QueryInt64Text (int64_t *uval) const
	See QueryIntText() More...

XMLError	QueryIntAttribute (const char name, int value) const
	Given an attribute name, QueryIntAttribute() returns XML_SUCCESS, XML_WRONG_ATTRIBUTE_TYPE if the conversion can't be performed, or XML_NO_ATTRIBUTE if the attribute doesn't exist. More...

XMLError	QueryIntText (int *ival) const
	Convenience method to query the value of a child text node. More...

XMLError	QueryStringAttribute (const char name, const char *value) const
	See QueryIntAttribute() More...

XMLError	QueryUnsigned64Attribute (const char name, uint64_t value) const
	See QueryIntAttribute() More...

XMLError	QueryUnsigned64Text (uint64_t *uval) const
	See QueryIntText() More...

XMLError	QueryUnsignedAttribute (const char name, unsigned int value) const
	See QueryIntAttribute() More...

XMLError	QueryUnsignedText (unsigned *uval) const
	See QueryIntText() More...

void	SetAttribute (const char name, const char value)
	Sets the named attribute to value. More...

void	SetAttribute (const char *name, int value)
	Sets the named attribute to value. More...

void	SetAttribute (const char *name, unsigned value)
	Sets the named attribute to value. More...

void	SetAttribute (const char *name, int64_t value)
	Sets the named attribute to value. More...

void	SetAttribute (const char *name, uint64_t value)
	Sets the named attribute to value. More...

void	SetAttribute (const char *name, bool value)
	Sets the named attribute to value. More...

void	SetAttribute (const char *name, double value)
	Sets the named attribute to value. More...

void	SetAttribute (const char *name, float value)
	Sets the named attribute to value. More...

void	SetName (const char *str, bool staticMem=false)
	Set the name of the element. More...

void	SetText (const char *inText)
	Convenience function for easy access to the text inside an element. More...

void	SetText (int value)
	Convenience method for setting text inside an element. See SetText() for important limitations. More...

void	SetText (unsigned value)
	Convenience method for setting text inside an element. See SetText() for important limitations. More...

void	SetText (int64_t value)
	Convenience method for setting text inside an element. See SetText() for important limitations. More...

void	SetText (uint64_t value)
	Convenience method for setting text inside an element. See SetText() for important limitations. More...

void	SetText (bool value)
	Convenience method for setting text inside an element. See SetText() for important limitations. More...

void	SetText (double value)
	Convenience method for setting text inside an element. See SetText() for important limitations. More...

void	SetText (float value)
	Convenience method for setting text inside an element. See SetText() for important limitations. More...

virtual XMLNode *	ShallowClone (XMLDocument *document) const
	Make a copy of this node, but not its children. More...

virtual bool	ShallowEqual (const XMLNode *compare) const
	Test if 2 nodes are the same, but don't test children. More...

virtual XMLElement *	ToElement ()
	Safely cast to an Element, or null. More...

virtual const XMLElement *	ToElement () const

uint64_t	Unsigned64Attribute (const char *name, uint64_t defaultValue=0) const
	See IntAttribute() More...

uint64_t	Unsigned64Text (uint64_t defaultValue=0) const
	See QueryIntText() More...

unsigned	UnsignedAttribute (const char *name, unsigned defaultValue=0) const
	See IntAttribute() More...

unsigned	UnsignedText (unsigned defaultValue=0) const
	See QueryIntText() More...

Public Member Functions inherited from tinyxml2::XMLNode
XMLNode *	DeepClone (XMLDocument *target) const
	Make a copy of this node and all its children. More...

void	DeleteChild (XMLNode *node)
	Delete a child of this node. More...

void	DeleteChildren ()
	Delete all the children of this node. More...

const XMLNode *	FirstChild () const
	Get the first child node, or null if none exists. More...

XMLNode *	FirstChild ()

const XMLElement *	FirstChildElement (const char *name=0) const
	Get the first child element, or optionally the first child element with the specified name. More...

XMLElement *	FirstChildElement (const char *name=0)

const XMLDocument *	GetDocument () const
	Get the XMLDocument that owns this XMLNode. More...

XMLDocument *	GetDocument ()
	Get the XMLDocument that owns this XMLNode. More...

int	GetLineNum () const
	Gets the line number the node is in, if the document was parsed from a file. More...

void *	GetUserData () const
	Get user data set into the XMLNode. More...

XMLNode *	InsertAfterChild (XMLNode afterThis, XMLNode addThis)
	Add a node after the specified child node. More...

XMLNode *	InsertEndChild (XMLNode *addThis)
	Add a child node as the last (right) child. More...

XMLNode *	InsertFirstChild (XMLNode *addThis)
	Add a child node as the first (left) child. More...

const XMLNode *	LastChild () const
	Get the last child node, or null if none exists. More...

XMLNode *	LastChild ()

const XMLElement *	LastChildElement (const char *name=0) const
	Get the last child element or optionally the last child element with the specified name. More...

XMLElement *	LastChildElement (const char *name=0)

XMLNode *	LinkEndChild (XMLNode *addThis)

const XMLNode *	NextSibling () const
	Get the next (right) sibling node of this node. More...

XMLNode *	NextSibling ()

const XMLElement *	NextSiblingElement (const char *name=0) const
	Get the next (right) sibling element of this node, with an optionally supplied name. More...

XMLElement *	NextSiblingElement (const char *name=0)

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

const XMLNode *	Parent () const
	Get the parent of this node on the DOM. More...

XMLNode *	Parent ()

const XMLNode *	PreviousSibling () const
	Get the previous (left) sibling node of this node. More...

XMLNode *	PreviousSibling ()

const XMLElement *	PreviousSiblingElement (const char *name=0) const
	Get the previous (left) sibling element of this node, with an optionally supplied name. More...

XMLElement *	PreviousSiblingElement (const char *name=0)

void	SetUserData (void *userData)
	Set user data into the XMLNode. More...

void	SetValue (const char *val, bool staticMem=false)
	Set the Value of an XML node. More...

virtual XMLComment *	ToComment ()
	Safely cast to a Comment, or null. More...

virtual const XMLComment *	ToComment () const

virtual XMLDeclaration *	ToDeclaration ()
	Safely cast to a Declaration, or null. More...

virtual const XMLDeclaration *	ToDeclaration () const

virtual XMLDocument *	ToDocument ()
	Safely cast to a Document, or null. More...

virtual const XMLDocument *	ToDocument () const

virtual XMLText *	ToText ()
	Safely cast to Text, or null. More...

virtual const XMLText *	ToText () const

virtual XMLUnknown *	ToUnknown ()
	Safely cast to an Unknown, or null. More...

virtual const XMLUnknown *	ToUnknown () const

const char *	Value () const
	The meaning of 'value' changes for the specific type. More...

Protected Member Functions
char *	ParseDeep (char p, StrPair parentEndTag, int *curLineNumPtr)

Protected Member Functions inherited from tinyxml2::XMLNode
	XMLNode (XMLDocument *)

virtual	~XMLNode ()

Private Types
enum	{ BUF_SIZE = 200 }

Private Member Functions
	XMLElement (XMLDocument *doc)

	XMLElement (const XMLElement &)

virtual	~XMLElement ()

XMLAttribute *	CreateAttribute ()

XMLAttribute *	FindOrCreateAttribute (const char *name)

void	operator= (const XMLElement &)

char *	ParseAttributes (char p, int curLineNumPtr)

Static Private Member Functions
static void	DeleteAttribute (XMLAttribute *attribute)

Private Attributes
ElementClosingType	_closingType

XMLAttribute *	_rootAttribute

Friends
class	XMLDocument

Additional Inherited Members
Protected Attributes inherited from tinyxml2::XMLNode
XMLDocument *	_document

XMLNode *	_firstChild

XMLNode *	_lastChild

XMLNode *	_next

XMLNode *	_parent

int	_parseLineNum

XMLNode *	_prev

void *	_userData

StrPair	_value

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

◆ anonymous enum

anonymous enum

private

Enumerator
BUF_SIZE

◆ ElementClosingType

enum tinyxml2::XMLElement::ElementClosingType

Enumerator
OPEN
CLOSED
CLOSING

Constructor & Destructor Documentation

◆ XMLElement() [1/2]

tinyxml2::XMLElement::XMLElement ( XMLDocument * doc )

private

◆ ~XMLElement()

virtual tinyxml2::XMLElement::~XMLElement ( )

privatevirtual

◆ XMLElement() [2/2]

tinyxml2::XMLElement::XMLElement ( const XMLElement & )

private

Member Function Documentation

◆ Accept()

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

virtual

Accept a hierarchical visit of the nodes in the TinyXML-2 DOM.

Every node in the XML tree will be conditionally visited and the host will be called back via the XMLVisitor interface.

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

The interface has been based on ideas from:

Which are both good references for "visiting".

An example of using Accept():

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

Implements tinyxml2::XMLNode.

◆ Attribute()

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

◆ BoolAttribute()

bool tinyxml2::XMLElement::BoolAttribute	(	const char *	name,
		bool	defaultValue = `false`
	)		const

See IntAttribute()

◆ BoolText()

bool tinyxml2::XMLElement::BoolText ( bool defaultValue = false ) const

See QueryIntText()

◆ ClosingType()

ElementClosingType tinyxml2::XMLElement::ClosingType ( ) const

inline

◆ CreateAttribute()

XMLAttribute* tinyxml2::XMLElement::CreateAttribute ( )

private

◆ DeleteAttribute() [1/2]

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

Delete an attribute.

◆ DeleteAttribute() [2/2]

static void tinyxml2::XMLElement::DeleteAttribute ( XMLAttribute * attribute )

staticprivate

◆ DoubleAttribute()

double tinyxml2::XMLElement::DoubleAttribute	(	const char *	name,
		double	defaultValue = `0`
	)		const

See IntAttribute()

◆ DoubleText()

double tinyxml2::XMLElement::DoubleText ( double defaultValue = 0 ) const

See QueryIntText()

◆ FindAttribute()

const XMLAttribute* tinyxml2::XMLElement::FindAttribute ( const char * name ) const

Query a specific attribute in the list.

◆ FindOrCreateAttribute()

XMLAttribute* tinyxml2::XMLElement::FindOrCreateAttribute ( const char * name )

private

◆ FirstAttribute()

const XMLAttribute* tinyxml2::XMLElement::FirstAttribute ( ) const

inline

Return the first attribute in the list.

◆ FloatAttribute()

float tinyxml2::XMLElement::FloatAttribute	(	const char *	name,
		float	defaultValue = `0`
	)		const

See IntAttribute()

◆ FloatText()

float tinyxml2::XMLElement::FloatText ( float defaultValue = 0 ) const

See QueryIntText()

◆ GetText()

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 XMLText child and accessing it directly.

If the first child of 'this' is a XMLText, 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 ".

◆ Int64Attribute()

int64_t tinyxml2::XMLElement::Int64Attribute	(	const char *	name,
		int64_t	defaultValue = `0`
	)		const

See IntAttribute()

◆ Int64Text()

int64_t tinyxml2::XMLElement::Int64Text ( int64_t defaultValue = 0 ) const

See QueryIntText()

◆ IntAttribute()

int tinyxml2::XMLElement::IntAttribute	(	const char *	name,
		int	defaultValue = `0`
	)		const

Given an attribute name, IntAttribute() returns the value of the attribute interpreted as an integer.

The default value will be returned if the attribute isn't present, or if there is an error. (For a method with error checking, see QueryIntAttribute()).

◆ IntText()

int tinyxml2::XMLElement::IntText ( int defaultValue = 0 ) const

◆ Name()

const char* tinyxml2::XMLElement::Name ( ) const

inline

Get the name of an element (which is the Value() of the node.)

◆ operator=()

void tinyxml2::XMLElement::operator= ( const XMLElement & )

private

◆ ParseAttributes()

char* tinyxml2::XMLElement::ParseAttributes	(	char *	p,
		int *	curLineNumPtr
	)

private

◆ ParseDeep()

char* tinyxml2::XMLElement::ParseDeep	(	char *	p,
		StrPair *	parentEndTag,
		int *	curLineNumPtr
	)

protectedvirtual

Reimplemented from tinyxml2::XMLNode.

◆ QueryAttribute() [1/7]

XMLError tinyxml2::XMLElement::QueryAttribute	(	const char *	name,
		int *	value
	)		const

inline

Given an attribute name, QueryAttribute() returns XML_SUCCESS, XML_WRONG_ATTRIBUTE_TYPE if the conversion can't be performed, or XML_NO_ATTRIBUTE if the attribute doesn't exist.

It is overloaded for the primitive types, and is a generally more convenient replacement of QueryIntAttribute() and related functions.

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;
  QueryAttribute( "foo", &value );    // if "foo" isn't found, value will still be 10

◆ QueryAttribute() [2/7]

XMLError tinyxml2::XMLElement::QueryAttribute	(	const char *	name,
		unsigned int *	value
	)		const

inline

◆ QueryAttribute() [3/7]

XMLError tinyxml2::XMLElement::QueryAttribute	(	const char *	name,
		int64_t *	value
	)		const

inline

◆ QueryAttribute() [4/7]

XMLError tinyxml2::XMLElement::QueryAttribute	(	const char *	name,
		uint64_t *	value
	)		const

inline

◆ QueryAttribute() [5/7]

XMLError tinyxml2::XMLElement::QueryAttribute	(	const char *	name,
		bool *	value
	)		const

inline

◆ QueryAttribute() [6/7]

XMLError tinyxml2::XMLElement::QueryAttribute	(	const char *	name,
		double *	value
	)		const

inline

◆ QueryAttribute() [7/7]

XMLError tinyxml2::XMLElement::QueryAttribute	(	const char *	name,
		float *	value
	)		const

inline

◆ QueryBoolAttribute()

XMLError tinyxml2::XMLElement::QueryBoolAttribute	(	const char *	name,
		bool *	value
	)		const

inline

See QueryIntAttribute()

◆ QueryBoolText()

XMLError tinyxml2::XMLElement::QueryBoolText ( bool * bval ) const

See QueryIntText()

◆ QueryDoubleAttribute()

XMLError tinyxml2::XMLElement::QueryDoubleAttribute	(	const char *	name,
		double *	value
	)		const

inline

See QueryIntAttribute()

◆ QueryDoubleText()

XMLError tinyxml2::XMLElement::QueryDoubleText ( double * dval ) const

See QueryIntText()

◆ QueryFloatAttribute()

XMLError tinyxml2::XMLElement::QueryFloatAttribute	(	const char *	name,
		float *	value
	)		const

inline

See QueryIntAttribute()

◆ QueryFloatText()

XMLError tinyxml2::XMLElement::QueryFloatText ( float * fval ) const

See QueryIntText()

◆ QueryInt64Attribute()

XMLError tinyxml2::XMLElement::QueryInt64Attribute	(	const char *	name,
		int64_t *	value
	)		const

inline

See QueryIntAttribute()

◆ QueryInt64Text()

XMLError tinyxml2::XMLElement::QueryInt64Text ( int64_t * uval ) const

See QueryIntText()

◆ QueryIntAttribute()

XMLError tinyxml2::XMLElement::QueryIntAttribute	(	const char *	name,
		int *	value
	)		const

inline

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

◆ QueryIntText()

XMLError tinyxml2::XMLElement::QueryIntText ( int * ival ) const

Convenience method to query the value of a child text node.

This is probably best shown by example. Given you have a document is this form:

  <point>
    <x>1</x>
    <y>1.4</y>
  </point>

The QueryIntText() and similar functions provide a safe and easier way to get to the "value" of x and y.

  int x = 0;
  float y = 0;  // types of x and y are contrived for example
  const XMLElement* xElement = pointElement->FirstChildElement( "x" );
  const XMLElement* yElement = pointElement->FirstChildElement( "y" );
  xElement->QueryIntText( &x );
  yElement->QueryFloatText( &y );

Returns: XML_SUCCESS (0) on success, XML_CAN_NOT_CONVERT_TEXT if the text cannot be converted to the requested type, and XML_NO_TEXT_NODE if there is no child text to query.

◆ QueryStringAttribute()

XMLError tinyxml2::XMLElement::QueryStringAttribute	(	const char *	name,
		const char **	value
	)		const

inline

See QueryIntAttribute()

◆ QueryUnsigned64Attribute()

XMLError tinyxml2::XMLElement::QueryUnsigned64Attribute	(	const char *	name,
		uint64_t *	value
	)		const

inline

See QueryIntAttribute()

◆ QueryUnsigned64Text()

XMLError tinyxml2::XMLElement::QueryUnsigned64Text ( uint64_t * uval ) const

See QueryIntText()

◆ QueryUnsignedAttribute()

XMLError tinyxml2::XMLElement::QueryUnsignedAttribute	(	const char *	name,
		unsigned int *	value
	)		const

inline

See QueryIntAttribute()

◆ QueryUnsignedText()

XMLError tinyxml2::XMLElement::QueryUnsignedText ( unsigned * uval ) const

See QueryIntText()