tinyxml2::XMLElement Class Reference

#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLElement:

Public Types
enum	ElementClosingType {   OPEN , CLOSED , CLOSING , OPEN ,   CLOSED , CLOSING }
enum	ElementClosingType {   OPEN , CLOSED , CLOSING , OPEN ,   CLOSED , CLOSING }

Public Member Functions
virtual bool	Accept (XMLVisitor *visitor) const
virtual bool	Accept (XMLVisitor *visitor) const
const char *	Attribute (const char *name, const char *value=0) const
const char *	Attribute (const char *name, const char *value=0) const
bool	BoolAttribute (const char *name, bool defaultValue=false) const
	See IntAttribute()
bool	BoolAttribute (const char *name, bool defaultValue=false) const
	See IntAttribute()
bool	BoolText (bool defaultValue=false) const
	See QueryIntText()
bool	BoolText (bool defaultValue=false) const
	See QueryIntText()
ElementClosingType	ClosingType () const
ElementClosingType	ClosingType () const
void	DeleteAttribute (const char *name)
void	DeleteAttribute (const char *name)
double	DoubleAttribute (const char *name, double defaultValue=0) const
	See IntAttribute()
double	DoubleAttribute (const char *name, double defaultValue=0) const
	See IntAttribute()
double	DoubleText (double defaultValue=0) const
	See QueryIntText()
double	DoubleText (double defaultValue=0) const
	See QueryIntText()
const XMLAttribute *	FindAttribute (const char *name) const
	Query a specific attribute in the list.
const XMLAttribute *	FindAttribute (const char *name) const
	Query a specific attribute in the list.
const XMLAttribute *	FirstAttribute () const
	Return the first attribute in the list.
const XMLAttribute *	FirstAttribute () const
	Return the first attribute in the list.
float	FloatAttribute (const char *name, float defaultValue=0) const
	See IntAttribute()
float	FloatAttribute (const char *name, float defaultValue=0) const
	See IntAttribute()
float	FloatText (float defaultValue=0) const
	See QueryIntText()
float	FloatText (float defaultValue=0) const
	See QueryIntText()
const char *	GetText () const
const char *	GetText () const
XMLElement *	InsertNewChildElement (const char *name)
XMLElement *	InsertNewChildElement (const char *name)
XMLComment *	InsertNewComment (const char *comment)
	See InsertNewChildElement()
XMLComment *	InsertNewComment (const char *comment)
	See InsertNewChildElement()
XMLDeclaration *	InsertNewDeclaration (const char *text)
	See InsertNewChildElement()
XMLDeclaration *	InsertNewDeclaration (const char *text)
	See InsertNewChildElement()
XMLText *	InsertNewText (const char *text)
	See InsertNewChildElement()
XMLText *	InsertNewText (const char *text)
	See InsertNewChildElement()
XMLUnknown *	InsertNewUnknown (const char *text)
	See InsertNewChildElement()
XMLUnknown *	InsertNewUnknown (const char *text)
	See InsertNewChildElement()
int64_t	Int64Attribute (const char *name, int64_t defaultValue=0) const
	See IntAttribute()
int64_t	Int64Attribute (const char *name, int64_t defaultValue=0) const
	See IntAttribute()
int64_t	Int64Text (int64_t defaultValue=0) const
	See QueryIntText()
int64_t	Int64Text (int64_t defaultValue=0) const
	See QueryIntText()
int	IntAttribute (const char *name, int defaultValue=0) const
int	IntAttribute (const char *name, int defaultValue=0) const
int	IntText (int defaultValue=0) const
int	IntText (int defaultValue=0) const
const char *	Name () const
	Get the name of an element (which is the Value() of the node.)
const char *	Name () const
	Get the name of an element (which is the Value() of the node.)
XMLError	QueryAttribute (const char *name, bool *value) const
XMLError	QueryAttribute (const char *name, bool *value) const
XMLError	QueryAttribute (const char *name, const char **value) const
XMLError	QueryAttribute (const char *name, const char **value) const
XMLError	QueryAttribute (const char *name, double *value) const
XMLError	QueryAttribute (const char *name, double *value) const
XMLError	QueryAttribute (const char *name, float *value) const
XMLError	QueryAttribute (const char *name, float *value) const
XMLError	QueryAttribute (const char *name, int *value) const
XMLError	QueryAttribute (const char *name, int *value) const
XMLError	QueryAttribute (const char *name, int64_t *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, uint64_t *value) const
XMLError	QueryAttribute (const char *name, unsigned int *value) const
XMLError	QueryAttribute (const char *name, unsigned int *value) const
XMLError	QueryBoolAttribute (const char *name, bool *value) const
	See QueryIntAttribute()
XMLError	QueryBoolAttribute (const char *name, bool *value) const
	See QueryIntAttribute()
XMLError	QueryBoolText (bool *bval) const
	See QueryIntText()
XMLError	QueryBoolText (bool *bval) const
	See QueryIntText()
XMLError	QueryDoubleAttribute (const char *name, double *value) const
	See QueryIntAttribute()
XMLError	QueryDoubleAttribute (const char *name, double *value) const
	See QueryIntAttribute()
XMLError	QueryDoubleText (double *dval) const
	See QueryIntText()
XMLError	QueryDoubleText (double *dval) const
	See QueryIntText()
XMLError	QueryFloatAttribute (const char *name, float *value) const
	See QueryIntAttribute()
XMLError	QueryFloatAttribute (const char *name, float *value) const
	See QueryIntAttribute()
XMLError	QueryFloatText (float *fval) const
	See QueryIntText()
XMLError	QueryFloatText (float *fval) const
	See QueryIntText()
XMLError	QueryInt64Attribute (const char *name, int64_t *value) const
	See QueryIntAttribute()
XMLError	QueryInt64Attribute (const char *name, int64_t *value) const
	See QueryIntAttribute()
XMLError	QueryInt64Text (int64_t *uval) const
	See QueryIntText()
XMLError	QueryInt64Text (int64_t *uval) const
	See QueryIntText()
XMLError	QueryIntAttribute (const char *name, int *value) const
XMLError	QueryIntAttribute (const char *name, int *value) const
XMLError	QueryIntText (int *ival) const
XMLError	QueryIntText (int *ival) const
XMLError	QueryStringAttribute (const char *name, const char **value) const
	See QueryIntAttribute()
XMLError	QueryStringAttribute (const char *name, const char **value) const
	See QueryIntAttribute()
XMLError	QueryUnsigned64Attribute (const char *name, uint64_t *value) const
	See QueryIntAttribute()
XMLError	QueryUnsigned64Attribute (const char *name, uint64_t *value) const
	See QueryIntAttribute()
XMLError	QueryUnsigned64Text (uint64_t *uval) const
	See QueryIntText()
XMLError	QueryUnsigned64Text (uint64_t *uval) const
	See QueryIntText()
XMLError	QueryUnsignedAttribute (const char *name, unsigned int *value) const
	See QueryIntAttribute()
XMLError	QueryUnsignedAttribute (const char *name, unsigned int *value) const
	See QueryIntAttribute()
XMLError	QueryUnsignedText (unsigned *uval) const
	See QueryIntText()
XMLError	QueryUnsignedText (unsigned *uval) const
	See QueryIntText()
void	SetAttribute (const char *name, bool 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, const char *value)
	Sets the named attribute to value.
void	SetAttribute (const char *name, const char *value)
	Sets the named attribute to value.
void	SetAttribute (const char *name, double value)
	Sets the named attribute to value.
void	SetAttribute (const char *name, double value)
	Sets the named attribute to value.
void	SetAttribute (const char *name, float value)
	Sets the named attribute to value.
void	SetAttribute (const char *name, float 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, int value)
	Sets the named attribute to value.
void	SetAttribute (const char *name, int64_t value)
	Sets the named attribute to value.
void	SetAttribute (const char *name, int64_t value)
	Sets the named attribute to value.
void	SetAttribute (const char *name, uint64_t value)
	Sets the named attribute to value.
void	SetAttribute (const char *name, uint64_t 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, unsigned value)
	Sets the named attribute to value.
void	SetName (const char *str, bool staticMem=false)
	Set the name of the element.
void	SetName (const char *str, bool staticMem=false)
	Set the name of the element.
void	SetText (bool value)
	Convenience method for setting text inside an element. See SetText() for important limitations.
void	SetText (bool value)
	Convenience method for setting text inside an element. See SetText() for important limitations.
void	SetText (const char *inText)
void	SetText (const char *inText)
void	SetText (double value)
	Convenience method for setting text inside an element. See SetText() for important limitations.
void	SetText (double value)
	Convenience method for setting text inside an element. See SetText() for important limitations.
void	SetText (float value)
	Convenience method for setting text inside an element. See SetText() for important limitations.
void	SetText (float value)
	Convenience method for setting text inside an element. See SetText() for important limitations.
void	SetText (int value)
	Convenience method for setting text inside an element. See SetText() for important limitations.
void	SetText (int value)
	Convenience method for setting text inside an element. See SetText() for important limitations.
void	SetText (int64_t value)
	Convenience method for setting text inside an element. See SetText() for important limitations.
void	SetText (int64_t value)
	Convenience method for setting text inside an element. See SetText() for important limitations.
void	SetText (uint64_t value)
	Convenience method for setting text inside an element. See SetText() for important limitations.
void	SetText (uint64_t value)
	Convenience method for setting text inside an element. See SetText() for important limitations.
void	SetText (unsigned value)
	Convenience method for setting text inside an element. See SetText() for important limitations.
void	SetText (unsigned value)
	Convenience method for setting text inside an element. See SetText() for important limitations.
virtual XMLNode *	ShallowClone (XMLDocument *document) const
virtual XMLNode *	ShallowClone (XMLDocument *document) const
virtual bool	ShallowEqual (const XMLNode *compare) const
virtual bool	ShallowEqual (const XMLNode *compare) const
virtual XMLElement *	ToElement ()
	Safely cast to an Element, or null.
virtual XMLElement *	ToElement ()
	Safely cast to an Element, or null.
virtual const XMLElement *	ToElement () const
virtual const XMLElement *	ToElement () const
uint64_t	Unsigned64Attribute (const char *name, uint64_t defaultValue=0) const
	See IntAttribute()
uint64_t	Unsigned64Attribute (const char *name, uint64_t defaultValue=0) const
	See IntAttribute()
uint64_t	Unsigned64Text (uint64_t defaultValue=0) const
	See QueryIntText()
uint64_t	Unsigned64Text (uint64_t defaultValue=0) const
	See QueryIntText()
unsigned	UnsignedAttribute (const char *name, unsigned defaultValue=0) const
	See IntAttribute()
unsigned	UnsignedAttribute (const char *name, unsigned defaultValue=0) const
	See IntAttribute()
unsigned	UnsignedText (unsigned defaultValue=0) const
	See QueryIntText()
unsigned	UnsignedText (unsigned defaultValue=0) const
	See QueryIntText()
Public Member Functions inherited from tinyxml2::XMLNode
XMLNode *	DeepClone (XMLDocument *target) const
XMLNode *	DeepClone (XMLDocument *target) const
void	DeleteChild (XMLNode *node)
void	DeleteChild (XMLNode *node)
void	DeleteChildren ()
void	DeleteChildren ()
XMLNode *	FirstChild ()
XMLNode *	FirstChild ()
const XMLNode *	FirstChild () const
	Get the first child node, or null if none exists.
const XMLNode *	FirstChild () const
	Get the first child node, or null if none exists.
XMLElement *	FirstChildElement (const char *name=0)
XMLElement *	FirstChildElement (const char *name=0)
const XMLElement *	FirstChildElement (const char *name=0) const
const XMLElement *	FirstChildElement (const char *name=0) const
XMLDocument *	GetDocument ()
	Get the XMLDocument that owns this XMLNode.
XMLDocument *	GetDocument ()
	Get the XMLDocument that owns this XMLNode.
const XMLDocument *	GetDocument () const
	Get the XMLDocument that owns this XMLNode.
const XMLDocument *	GetDocument () const
	Get the XMLDocument that owns this XMLNode.
int	GetLineNum () const
	Gets the line number the node is in, if the document was parsed from a file.
int	GetLineNum () const
	Gets the line number the node is in, if the document was parsed from a file.
void *	GetUserData () const
void *	GetUserData () const
XMLNode *	InsertAfterChild (XMLNode *afterThis, XMLNode *addThis)
XMLNode *	InsertAfterChild (XMLNode *afterThis, XMLNode *addThis)
XMLNode *	InsertEndChild (XMLNode *addThis)
XMLNode *	InsertEndChild (XMLNode *addThis)
XMLNode *	InsertFirstChild (XMLNode *addThis)
XMLNode *	InsertFirstChild (XMLNode *addThis)
XMLNode *	LastChild ()
XMLNode *	LastChild ()
const XMLNode *	LastChild () const
	Get the last child node, or null if none exists.
const XMLNode *	LastChild () const
	Get the last child node, or null if none exists.
XMLElement *	LastChildElement (const char *name=0)
XMLElement *	LastChildElement (const char *name=0)
const XMLElement *	LastChildElement (const char *name=0) const
const XMLElement *	LastChildElement (const char *name=0) const
XMLNode *	LinkEndChild (XMLNode *addThis)
XMLNode *	LinkEndChild (XMLNode *addThis)
XMLNode *	NextSibling ()
XMLNode *	NextSibling ()
const XMLNode *	NextSibling () const
	Get the next (right) sibling node of this node.
const XMLNode *	NextSibling () const
	Get the next (right) sibling node of this node.
XMLElement *	NextSiblingElement (const char *name=0)
XMLElement *	NextSiblingElement (const char *name=0)
const XMLElement *	NextSiblingElement (const char *name=0) const
	Get the next (right) sibling element of this node, with an optionally supplied name.
const XMLElement *	NextSiblingElement (const char *name=0) const
	Get the next (right) sibling element of this node, with an optionally supplied name.
bool	NoChildren () const
	Returns true if this node has no children.
bool	NoChildren () const
	Returns true if this node has no children.
XMLNode *	Parent ()
XMLNode *	Parent ()
const XMLNode *	Parent () const
	Get the parent of this node on the DOM.
const XMLNode *	Parent () const
	Get the parent of this node on the DOM.
XMLNode *	PreviousSibling ()
XMLNode *	PreviousSibling ()
const XMLNode *	PreviousSibling () const
	Get the previous (left) sibling node of this node.
const XMLNode *	PreviousSibling () const
	Get the previous (left) sibling node of this node.
XMLElement *	PreviousSiblingElement (const char *name=0)
XMLElement *	PreviousSiblingElement (const char *name=0)
const XMLElement *	PreviousSiblingElement (const char *name=0) const
	Get the previous (left) sibling element of this node, with an optionally supplied name.
const XMLElement *	PreviousSiblingElement (const char *name=0) const
	Get the previous (left) sibling element of this node, with an optionally supplied name.
void	SetUserData (void *userData)
void	SetUserData (void *userData)
void	SetValue (const char *val, bool staticMem=false)
void	SetValue (const char *val, bool staticMem=false)
virtual XMLComment *	ToComment ()
	Safely cast to a Comment, or null.
virtual XMLComment *	ToComment ()
	Safely cast to a Comment, or null.
virtual const XMLComment *	ToComment () const
virtual const XMLComment *	ToComment () const
virtual XMLDeclaration *	ToDeclaration ()
	Safely cast to a Declaration, or null.
virtual XMLDeclaration *	ToDeclaration ()
	Safely cast to a Declaration, or null.
virtual const XMLDeclaration *	ToDeclaration () const
virtual const XMLDeclaration *	ToDeclaration () const
virtual XMLDocument *	ToDocument ()
	Safely cast to a Document, or null.
virtual XMLDocument *	ToDocument ()
	Safely cast to a Document, or null.
virtual const XMLDocument *	ToDocument () const
virtual const XMLDocument *	ToDocument () const
virtual XMLText *	ToText ()
	Safely cast to Text, or null.
virtual XMLText *	ToText ()
	Safely cast to Text, or null.
virtual const XMLText *	ToText () const
virtual const XMLText *	ToText () const
virtual XMLUnknown *	ToUnknown ()
	Safely cast to an Unknown, or null.
virtual XMLUnknown *	ToUnknown ()
	Safely cast to an Unknown, or null.
virtual const XMLUnknown *	ToUnknown () const
virtual const XMLUnknown *	ToUnknown () const
const char *	Value () const
const char *	Value () const

Protected Member Functions
char *	ParseDeep (char *p, StrPair *parentEndTag, int *curLineNumPtr)
char *	ParseDeep (char *p, StrPair *parentEndTag, int *curLineNumPtr)
Protected Member Functions inherited from tinyxml2::XMLNode
	XMLNode (XMLDocument *)
	XMLNode (XMLDocument *)
virtual	~XMLNode ()
virtual	~XMLNode ()

Private Types
enum	{ BUF_SIZE = 200 }
enum	{ BUF_SIZE = 200 }

Private Member Functions
XMLAttribute *	CreateAttribute ()
XMLAttribute *	CreateAttribute ()
XMLAttribute *	FindOrCreateAttribute (const char *name)
XMLAttribute *	FindOrCreateAttribute (const char *name)
void	operator= (const XMLElement &)
void	operator= (const XMLElement &)
char *	ParseAttributes (char *p, int *curLineNumPtr)
char *	ParseAttributes (char *p, int *curLineNumPtr)
	XMLElement (const XMLElement &)
	XMLElement (const XMLElement &)
	XMLElement (XMLDocument *doc)
	XMLElement (XMLDocument *doc)
virtual	~XMLElement ()
virtual	~XMLElement ()

Static Private Member Functions
static void	DeleteAttribute (XMLAttribute *attribute)
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.

Definition at line 1264 of file tinyxml2.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Enumerator
BUF_SIZE

Definition at line 1696 of file tinyxml2.h.

anonymous enum

anonymous enum

private

Enumerator
BUF_SIZE

Definition at line 1696 of file tinyxml2.h.

ElementClosingType [1/2]

enum tinyxml2::XMLElement::ElementClosingType

Enumerator
OPEN
CLOSED
CLOSING
OPEN
CLOSED
CLOSING

Definition at line 1671 of file tinyxml2.h.

ElementClosingType [2/2]

enum tinyxml2::XMLElement::ElementClosingType

Enumerator
OPEN
CLOSED
CLOSING
OPEN
CLOSED
CLOSING

Definition at line 1671 of file tinyxml2.h.

Constructor & Destructor Documentation

XMLElement() [1/4]

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

private

~XMLElement() [1/2]

virtual tinyxml2::XMLElement::~XMLElement ( )

privatevirtual

XMLElement() [2/4]

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

private

XMLElement() [3/4]

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

private

~XMLElement() [2/2]

virtual tinyxml2::XMLElement::~XMLElement ( )

privatevirtual

XMLElement() [4/4]

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

private

Member Function Documentation

Accept() [1/2]

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:

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

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.

Accept() [2/2]

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:

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

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() [1/2]

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

Attribute() [2/2]

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() [1/2]

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

See IntAttribute()

BoolAttribute() [2/2]

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

See IntAttribute()

BoolText() [1/2]

bool tinyxml2::XMLElement::BoolText

(

bool

defaultValue = false

)

const

See QueryIntText()

BoolText() [2/2]

bool tinyxml2::XMLElement::BoolText

(

bool

defaultValue = false

)

const

See QueryIntText()

ClosingType() [1/2]

ElementClosingType tinyxml2::XMLElement::ClosingType ( ) const

inline

Definition at line 1676 of file tinyxml2.h.

ClosingType() [2/2]

ElementClosingType tinyxml2::XMLElement::ClosingType ( ) const

inline

Definition at line 1676 of file tinyxml2.h.

CreateAttribute() [1/2]

XMLAttribute * tinyxml2::XMLElement::CreateAttribute ( )

private

CreateAttribute() [2/2]

XMLAttribute * tinyxml2::XMLElement::CreateAttribute ( )

private

DeleteAttribute() [1/4]

void tinyxml2::XMLElement::DeleteAttribute

(

const char *

name

)

Delete an attribute.

DeleteAttribute() [2/4]

void tinyxml2::XMLElement::DeleteAttribute

(

const char *

name

)

Delete an attribute.

DeleteAttribute() [3/4]

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

staticprivate

DeleteAttribute() [4/4]

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

staticprivate

DoubleAttribute() [1/2]

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

See IntAttribute()

DoubleAttribute() [2/2]

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

See IntAttribute()

DoubleText() [1/2]

double tinyxml2::XMLElement::DoubleText

(

double

defaultValue = 0

)

const

See QueryIntText()

DoubleText() [2/2]

double tinyxml2::XMLElement::DoubleText

(

double

defaultValue = 0

)

const

See QueryIntText()

FindAttribute() [1/2]

const XMLAttribute * tinyxml2::XMLElement::FindAttribute

(

const char *

name

)

const

Query a specific attribute in the list.

FindAttribute() [2/2]

const XMLAttribute * tinyxml2::XMLElement::FindAttribute

(

const char *

name

)

const

Query a specific attribute in the list.

FindOrCreateAttribute() [1/2]

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

private

FindOrCreateAttribute() [2/2]

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

private

FirstAttribute() [1/2]

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

inline

Return the first attribute in the list.

Definition at line 1514 of file tinyxml2.h.

FirstAttribute() [2/2]

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

inline

Return the first attribute in the list.

Definition at line 1514 of file tinyxml2.h.

FloatAttribute() [1/2]

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

See IntAttribute()

FloatAttribute() [2/2]

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

See IntAttribute()

FloatText() [1/2]

float tinyxml2::XMLElement::FloatText

(

float

defaultValue = 0

)

const

See QueryIntText()

FloatText() [2/2]

float tinyxml2::XMLElement::FloatText

(

float

defaultValue = 0

)

const

See QueryIntText()

GetText() [1/2]

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

GetText() [2/2]

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

InsertNewChildElement() [1/2]

XMLElement * tinyxml2::XMLElement::InsertNewChildElement

(

const char *

name

)

Convenience method to create a new XMLElement and add it as last (right) child of this node. Returns the created and inserted element.

InsertNewChildElement() [2/2]

XMLElement * tinyxml2::XMLElement::InsertNewChildElement

(

const char *

name

)

Convenience method to create a new XMLElement and add it as last (right) child of this node. Returns the created and inserted element.

InsertNewComment() [1/2]

XMLComment * tinyxml2::XMLElement::InsertNewComment

(

const char *

comment

)

See InsertNewChildElement()

InsertNewComment() [2/2]

XMLComment * tinyxml2::XMLElement::InsertNewComment

(

const char *

comment

)

See InsertNewChildElement()

InsertNewDeclaration() [1/2]

XMLDeclaration * tinyxml2::XMLElement::InsertNewDeclaration

(

const char *

text

)

See InsertNewChildElement()

InsertNewDeclaration() [2/2]

XMLDeclaration * tinyxml2::XMLElement::InsertNewDeclaration

(

const char *

text

)

See InsertNewChildElement()

InsertNewText() [1/2]

XMLText * tinyxml2::XMLElement::InsertNewText

(

const char *

text

)

See InsertNewChildElement()

InsertNewText() [2/2]

XMLText * tinyxml2::XMLElement::InsertNewText

(

const char *

text

)

See InsertNewChildElement()

InsertNewUnknown() [1/2]

XMLUnknown * tinyxml2::XMLElement::InsertNewUnknown

(

const char *

text

)

See InsertNewChildElement()

InsertNewUnknown() [2/2]

XMLUnknown * tinyxml2::XMLElement::InsertNewUnknown

(

const char *

text

)

See InsertNewChildElement()

Int64Attribute() [1/2]

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

See IntAttribute()

Int64Attribute() [2/2]

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

See IntAttribute()

Int64Text() [1/2]

int64_t tinyxml2::XMLElement::Int64Text

(

int64_t

defaultValue = 0

)

const

See QueryIntText()

Int64Text() [2/2]

int64_t tinyxml2::XMLElement::Int64Text

(

int64_t

defaultValue = 0

)

const

See QueryIntText()

IntAttribute() [1/2]

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()).

IntAttribute() [2/2]

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() [1/2]

int tinyxml2::XMLElement::IntText

(

int

defaultValue = 0

)

const

IntText() [2/2]

int tinyxml2::XMLElement::IntText

(

int

defaultValue = 0

)

const

Name() [1/2]

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

inline

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

Definition at line 1269 of file tinyxml2.h.

Name() [2/2]

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

inline

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

Definition at line 1269 of file tinyxml2.h.

operator=() [1/2]

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

private

operator=() [2/2]

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

private

ParseAttributes() [1/2]

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

private

ParseAttributes() [2/2]

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

private

ParseDeep() [1/2]

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

protectedvirtual

Reimplemented from tinyxml2::XMLNode.

ParseDeep() [2/2]

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

protectedvirtual

Reimplemented from tinyxml2::XMLNode.

QueryAttribute() [1/16]

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

inline

Definition at line 1448 of file tinyxml2.h.

QueryAttribute() [2/16]

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

inline

Definition at line 1448 of file tinyxml2.h.

QueryAttribute() [3/16]

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

inline

Definition at line 1460 of file tinyxml2.h.

QueryAttribute() [4/16]

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

inline

Definition at line 1460 of file tinyxml2.h.

QueryAttribute() [5/16]

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

inline

Definition at line 1452 of file tinyxml2.h.

QueryAttribute() [6/16]

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

inline

Definition at line 1452 of file tinyxml2.h.

QueryAttribute() [7/16]

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

inline

Definition at line 1456 of file tinyxml2.h.

QueryAttribute() [8/16]

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

inline

Definition at line 1456 of file tinyxml2.h.

QueryAttribute() [9/16]

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

Definition at line 1432 of file tinyxml2.h.

QueryAttribute() [10/16]

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

Definition at line 1432 of file tinyxml2.h.

QueryAttribute() [11/16]

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

inline

Definition at line 1440 of file tinyxml2.h.

QueryAttribute() [12/16]

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

inline

Definition at line 1440 of file tinyxml2.h.

QueryAttribute() [13/16]

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

inline

Definition at line 1444 of file tinyxml2.h.

QueryAttribute() [14/16]

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

inline

Definition at line 1444 of file tinyxml2.h.

QueryAttribute() [15/16]

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

inline

Definition at line 1436 of file tinyxml2.h.

QueryAttribute() [16/16]

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

inline

Definition at line 1436 of file tinyxml2.h.

QueryBoolAttribute() [1/2]

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

inline

See QueryIntAttribute()

Definition at line 1379 of file tinyxml2.h.

QueryBoolAttribute() [2/2]

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

inline

See QueryIntAttribute()

Definition at line 1379 of file tinyxml2.h.

QueryBoolText() [1/2]

XMLError tinyxml2::XMLElement::QueryBoolText

(

bool *

bval

)

const

See QueryIntText()

QueryBoolText() [2/2]

XMLError tinyxml2::XMLElement::QueryBoolText

(

bool *

bval

)

const

See QueryIntText()

QueryDoubleAttribute() [1/2]

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

inline

See QueryIntAttribute()

Definition at line 1387 of file tinyxml2.h.

QueryDoubleAttribute() [2/2]

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

inline

See QueryIntAttribute()

Definition at line 1387 of file tinyxml2.h.

QueryDoubleText() [1/2]

XMLError tinyxml2::XMLElement::QueryDoubleText

(

double *

dval

)

const

See QueryIntText()

QueryDoubleText() [2/2]

XMLError tinyxml2::XMLElement::QueryDoubleText

(

double *

dval

)

const

See QueryIntText()

QueryFloatAttribute() [1/2]

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

inline

See QueryIntAttribute()

Definition at line 1395 of file tinyxml2.h.

QueryFloatAttribute() [2/2]

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

inline

See QueryIntAttribute()

Definition at line 1395 of file tinyxml2.h.

QueryFloatText() [1/2]

XMLError tinyxml2::XMLElement::QueryFloatText

(

float *

fval

)

const

See QueryIntText()

QueryFloatText() [2/2]

XMLError tinyxml2::XMLElement::QueryFloatText

(

float *

fval

)

const

See QueryIntText()

QueryInt64Attribute() [1/2]

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

inline

See QueryIntAttribute()

Definition at line 1361 of file tinyxml2.h.

QueryInt64Attribute() [2/2]

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

inline

See QueryIntAttribute()

Definition at line 1361 of file tinyxml2.h.

QueryInt64Text() [1/2]

XMLError tinyxml2::XMLElement::QueryInt64Text

(

int64_t *

uval

)

const

See QueryIntText()

QueryInt64Text() [2/2]

XMLError tinyxml2::XMLElement::QueryInt64Text

(

int64_t *

uval

)

const

See QueryIntText()

QueryIntAttribute() [1/2]

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

Definition at line 1343 of file tinyxml2.h.

QueryIntAttribute() [2/2]

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

Definition at line 1343 of file tinyxml2.h.

QueryIntText() [1/2]

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.

QueryIntText() [2/2]

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() [1/2]

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

inline

See QueryIntAttribute()

Definition at line 1404 of file tinyxml2.h.

QueryStringAttribute() [2/2]

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

inline

See QueryIntAttribute()

Definition at line 1404 of file tinyxml2.h.

QueryUnsigned64Attribute() [1/2]

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

inline

See QueryIntAttribute()

Definition at line 1370 of file tinyxml2.h.

QueryUnsigned64Attribute() [2/2]

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

inline

See QueryIntAttribute()

Definition at line 1370 of file tinyxml2.h.

QueryUnsigned64Text() [1/2]

XMLError tinyxml2::XMLElement::QueryUnsigned64Text

(

uint64_t *

uval

)

const

See QueryIntText()

QueryUnsigned64Text() [2/2]

XMLError tinyxml2::XMLElement::QueryUnsigned64Text

(

uint64_t *

uval

)

const

See QueryIntText()

QueryUnsignedAttribute() [1/2]

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

inline

See QueryIntAttribute()

Definition at line 1352 of file tinyxml2.h.

QueryUnsignedAttribute() [2/2]

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

inline

See QueryIntAttribute()

Definition at line 1352 of file tinyxml2.h.

QueryUnsignedText() [1/2]

XMLError tinyxml2::XMLElement::QueryUnsignedText

(

unsigned *

uval

)

const

See QueryIntText()

QueryUnsignedText() [2/2]

XMLError tinyxml2::XMLElement::QueryUnsignedText

(

unsigned *

uval

)

const

See QueryIntText()

SetAttribute() [1/16]

void tinyxml2::XMLElement::SetAttribute ( const char * name, bool value )

inline

Sets the named attribute to value.

Definition at line 1493 of file tinyxml2.h.

SetAttribute() [2/16]

void tinyxml2::XMLElement::SetAttribute ( const char * name, bool value )

inline

Sets the named attribute to value.

Definition at line 1493 of file tinyxml2.h.

SetAttribute() [3/16]

void tinyxml2::XMLElement::SetAttribute ( const char * name, const char * value )

inline

Sets the named attribute to value.

Definition at line 1465 of file tinyxml2.h.

SetAttribute() [4/16]

void tinyxml2::XMLElement::SetAttribute ( const char * name, const char * value )

inline

Sets the named attribute to value.

Definition at line 1465 of file tinyxml2.h.

SetAttribute() [5/16]

void tinyxml2::XMLElement::SetAttribute ( const char * name, double value )

inline

Sets the named attribute to value.

Definition at line 1498 of file tinyxml2.h.

SetAttribute() [6/16]

void tinyxml2::XMLElement::SetAttribute ( const char * name, double value )

inline

Sets the named attribute to value.

Definition at line 1498 of file tinyxml2.h.

SetAttribute() [7/16]

void tinyxml2::XMLElement::SetAttribute ( const char * name, float value )

inline

Sets the named attribute to value.

Definition at line 1503 of file tinyxml2.h.

SetAttribute() [8/16]

void tinyxml2::XMLElement::SetAttribute ( const char * name, float value )

inline

Sets the named attribute to value.

Definition at line 1503 of file tinyxml2.h.

SetAttribute() [9/16]

void tinyxml2::XMLElement::SetAttribute ( const char * name, int value )

inline

Sets the named attribute to value.

Definition at line 1470 of file tinyxml2.h.

SetAttribute() [10/16]

void tinyxml2::XMLElement::SetAttribute ( const char * name, int value )

inline

Sets the named attribute to value.

Definition at line 1470 of file tinyxml2.h.

SetAttribute() [11/16]

void tinyxml2::XMLElement::SetAttribute ( const char * name, int64_t value )

inline

Sets the named attribute to value.

Definition at line 1481 of file tinyxml2.h.

SetAttribute() [12/16]

void tinyxml2::XMLElement::SetAttribute ( const char * name, int64_t value )

inline

Sets the named attribute to value.

Definition at line 1481 of file tinyxml2.h.

SetAttribute() [13/16]

void tinyxml2::XMLElement::SetAttribute ( const char * name, uint64_t value )

inline

Sets the named attribute to value.

Definition at line 1487 of file tinyxml2.h.

SetAttribute() [14/16]

void tinyxml2::XMLElement::SetAttribute ( const char * name, uint64_t value )

inline

Sets the named attribute to value.

Definition at line 1487 of file tinyxml2.h.

SetAttribute() [15/16]

void tinyxml2::XMLElement::SetAttribute ( const char * name, unsigned value )

inline

Sets the named attribute to value.

Definition at line 1475 of file tinyxml2.h.

SetAttribute() [16/16]

void tinyxml2::XMLElement::SetAttribute ( const char * name, unsigned value )

inline

Sets the named attribute to value.

Definition at line 1475 of file tinyxml2.h.

SetName() [1/2]

void tinyxml2::XMLElement::SetName ( const char * str, bool staticMem = false )

inline

Set the name of the element.

Definition at line 1273 of file tinyxml2.h.

SetName() [2/2]

void tinyxml2::XMLElement::SetName ( const char * str, bool staticMem = false )

inline

Set the name of the element.

Definition at line 1273 of file tinyxml2.h.

SetText() [1/16]

void tinyxml2::XMLElement::SetText

(

bool

value

)

Convenience method for setting text inside an element. See SetText() for important limitations.

SetText() [2/16]

void tinyxml2::XMLElement::SetText

(

bool

value

)

Convenience method for setting text inside an element. See SetText() for important limitations.

SetText() [3/16]

void tinyxml2::XMLElement::SetText

(

const char *

inText

)

Convenience function for easy access to the text inside an element. Although easy and concise, SetText() is limited compared to creating an XMLText child and mutating it directly.

If the first child of 'this' is a XMLText, SetText() sets its value to the given string, otherwise it will create a first child that is an XMLText.

This is a convenient method for setting the text of simple contained text:

<foo>This is text</foo>
    fooElement->SetText( "Hullaballoo!" );
<foo>Hullaballoo!</foo>

Note that this function can be misleading. If the element foo was created from this XML:

    <foo><b>This is text</b></foo>

then it will not change "This is text", but rather prefix it with a text element:

    <foo>Hullaballoo!<b>This is text</b></foo>

For this XML:

    <foo />

SetText() will generate

    <foo>Hullaballoo!</foo>

SetText() [4/16]

void tinyxml2::XMLElement::SetText

(

const char *

inText

)

Convenience function for easy access to the text inside an element. Although easy and concise, SetText() is limited compared to creating an XMLText child and mutating it directly.

If the first child of 'this' is a XMLText, SetText() sets its value to the given string, otherwise it will create a first child that is an XMLText.

This is a convenient method for setting the text of simple contained text:

<foo>This is text</foo>
    fooElement->SetText( "Hullaballoo!" );
<foo>Hullaballoo!</foo>

Note that this function can be misleading. If the element foo was created from this XML:

    <foo><b>This is text</b></foo>

then it will not change "This is text", but rather prefix it with a text element:

    <foo>Hullaballoo!<b>This is text</b></foo>

For this XML:

    <foo />

SetText() will generate

    <foo>Hullaballoo!</foo>

SetText() [5/16]

void tinyxml2::XMLElement::SetText

(

double

value

)

Convenience method for setting text inside an element. See SetText() for important limitations.

SetText() [6/16]

void tinyxml2::XMLElement::SetText

(

double

value

)

Convenience method for setting text inside an element. See SetText() for important limitations.

SetText() [7/16]

void tinyxml2::XMLElement::SetText

(

float

value

)

Convenience method for setting text inside an element. See SetText() for important limitations.

SetText() [8/16]

void tinyxml2::XMLElement::SetText

(

float

value

)

Convenience method for setting text inside an element. See SetText() for important limitations.

SetText() [9/16]

void tinyxml2::XMLElement::SetText

(

int

value

)

Convenience method for setting text inside an element. See SetText() for important limitations.

SetText() [10/16]

void tinyxml2::XMLElement::SetText

(

int

value

)

Convenience method for setting text inside an element. See SetText() for important limitations.

SetText() [11/16]

void tinyxml2::XMLElement::SetText

(

int64_t

value

)

Convenience method for setting text inside an element. See SetText() for important limitations.

SetText() [12/16]

void tinyxml2::XMLElement::SetText

(

int64_t

value

)

Convenience method for setting text inside an element. See SetText() for important limitations.

SetText() [13/16]

void tinyxml2::XMLElement::SetText

(

uint64_t

value

)

Convenience method for setting text inside an element. See SetText() for important limitations.

SetText() [14/16]

void tinyxml2::XMLElement::SetText

(

uint64_t

value

)

Convenience method for setting text inside an element. See SetText() for important limitations.

SetText() [15/16]

void tinyxml2::XMLElement::SetText

(

unsigned

value

)

Convenience method for setting text inside an element. See SetText() for important limitations.

SetText() [16/16]

void tinyxml2::XMLElement::SetText

(

unsigned

value

)

Convenience method for setting text inside an element. See SetText() for important limitations.

ShallowClone() [1/2]

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.

ShallowClone() [2/2]

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.

ShallowEqual() [1/2]

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.

ShallowEqual() [2/2]

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.

ToElement() [1/4]

virtual XMLElement * tinyxml2::XMLElement::ToElement ( )

inlinevirtual

Safely cast to an Element, or null.

Reimplemented from tinyxml2::XMLNode.

Definition at line 1277 of file tinyxml2.h.

ToElement() [2/4]

virtual XMLElement * tinyxml2::XMLElement::ToElement ( )

inlinevirtual

Safely cast to an Element, or null.

Reimplemented from tinyxml2::XMLNode.

Definition at line 1277 of file tinyxml2.h.

ToElement() [3/4]

virtual const XMLElement * tinyxml2::XMLElement::ToElement ( ) const

inlinevirtual

Reimplemented from tinyxml2::XMLNode.

Definition at line 1280 of file tinyxml2.h.

ToElement() [4/4]

virtual const XMLElement * tinyxml2::XMLElement::ToElement ( ) const

inlinevirtual

Reimplemented from tinyxml2::XMLNode.

Definition at line 1280 of file tinyxml2.h.

Unsigned64Attribute() [1/2]

uint64_t tinyxml2::XMLElement::Unsigned64Attribute	(	const char *	name,
		uint64_t	defaultValue = 0 ) const

See IntAttribute()

Unsigned64Attribute() [2/2]

uint64_t tinyxml2::XMLElement::Unsigned64Attribute	(	const char *	name,
		uint64_t	defaultValue = 0 ) const

See IntAttribute()

Unsigned64Text() [1/2]

uint64_t tinyxml2::XMLElement::Unsigned64Text

(

uint64_t

defaultValue = 0

)

const

See QueryIntText()

Unsigned64Text() [2/2]

uint64_t tinyxml2::XMLElement::Unsigned64Text

(

uint64_t

defaultValue = 0

)

const

See QueryIntText()

UnsignedAttribute() [1/2]

unsigned tinyxml2::XMLElement::UnsignedAttribute	(	const char *	name,
		unsigned	defaultValue = 0 ) const

See IntAttribute()

UnsignedAttribute() [2/2]

unsigned tinyxml2::XMLElement::UnsignedAttribute	(	const char *	name,
		unsigned	defaultValue = 0 ) const

See IntAttribute()

UnsignedText() [1/2]

unsigned tinyxml2::XMLElement::UnsignedText

(

unsigned

defaultValue = 0

)

const

See QueryIntText()

UnsignedText() [2/2]

unsigned tinyxml2::XMLElement::UnsignedText

(

unsigned

defaultValue = 0

)

const

See QueryIntText()

Friends And Related Symbol Documentation

XMLDocument

XMLDocument

friend

Definition at line 1266 of file tinyxml2.h.

Member Data Documentation

_closingType

ElementClosingType tinyxml2::XMLElement::_closingType

private

Definition at line 1697 of file tinyxml2.h.

_rootAttribute

XMLAttribute * tinyxml2::XMLElement::_rootAttribute

private

Definition at line 1701 of file tinyxml2.h.

---

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

• tinyxml2/tinyxml2.h
• XML/tinyxml2.h