#include <tinyxml2.h>

Inheritance diagram for tinyxml2::XMLElement:

Collaboration diagram for tinyxml2::XMLElement:

Public Types
enum	ElementClosingType { OPEN , CLOSED , CLOSING }

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

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

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

virtual const XMLElement *	ToElement () const

virtual bool	Accept (XMLVisitor *visitor) const

const char *	Attribute (const char name, const char value=0) const

int	IntAttribute (const char *name, int defaultValue=0) const

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

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

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

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

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

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

XMLError	QueryIntAttribute (const char name, int value) const

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

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

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

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

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

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

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

XMLError	QueryAttribute (const char name, int value) const

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	QueryAttribute (const char name, const char *value) const

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	DeleteAttribute (const char *name)

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

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

const char *	GetText () const

void	SetText (const char *inText)

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

XMLError	QueryIntText (int *ival) const

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

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

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

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

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

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

int	IntText (int defaultValue=0) const

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

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

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

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

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

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

XMLElement *	InsertNewChildElement (const char *name)

XMLComment *	InsertNewComment (const char *comment)
	See InsertNewChildElement() More...

XMLText *	InsertNewText (const char *text)
	See InsertNewChildElement() More...

XMLDeclaration *	InsertNewDeclaration (const char *text)
	See InsertNewChildElement() More...

XMLUnknown *	InsertNewUnknown (const char *text)
	See InsertNewChildElement() More...

ElementClosingType	ClosingType () const

virtual XMLNode *	ShallowClone (XMLDocument *document) const

virtual bool	ShallowEqual (const XMLNode *compare) const

Public Member Functions inherited from tinyxml2::XMLNode
const XMLDocument *	GetDocument () const
	Get the XMLDocument that owns this XMLNode. More...

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

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

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

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

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

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

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

virtual const XMLElement *	ToElement () const

virtual const XMLText *	ToText () const

virtual const XMLComment *	ToComment () const

virtual const XMLDocument *	ToDocument () const

virtual const XMLDeclaration *	ToDeclaration () const

virtual const XMLUnknown *	ToUnknown () const

const char *	Value () const

void	SetValue (const char *val, bool staticMem=false)

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

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

XMLNode *	Parent ()

bool	NoChildren () const
	Returns true if this node has no children. 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

XMLElement *	FirstChildElement (const char *name=0)

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

XMLElement *	LastChildElement (const char *name=0)

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)

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)

XMLNode *	InsertEndChild (XMLNode *addThis)

XMLNode *	LinkEndChild (XMLNode *addThis)

XMLNode *	InsertFirstChild (XMLNode *addThis)

XMLNode *	InsertAfterChild (XMLNode afterThis, XMLNode addThis)

void	DeleteChildren ()

void	DeleteChild (XMLNode *node)

virtual XMLNode *	ShallowClone (XMLDocument *document) const =0

XMLNode *	DeepClone (XMLDocument *target) const

virtual bool	ShallowEqual (const XMLNode *compare) const =0

virtual bool	Accept (XMLVisitor *visitor) const =0

void	SetUserData (void *userData)

void *	GetUserData () const

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

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

virtual	~XMLNode ()

virtual char *	ParseDeep (char p, StrPair parentEndTag, int *curLineNumPtr)

Private Types
enum	{ BUF_SIZE = 200 }

Private Member Functions
	XMLElement (XMLDocument *doc)

virtual	~XMLElement ()

	XMLElement (const XMLElement &)

void	operator= (const XMLElement &)

XMLAttribute *	FindOrCreateAttribute (const char *name)

char *	ParseAttributes (char p, int curLineNumPtr)

XMLAttribute *	CreateAttribute ()

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

StrPair	_value

int	_parseLineNum

XMLNode *	_firstChild

XMLNode *	_lastChild

XMLNode *	_prev

XMLNode *	_next

void *	_userData

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.

◆ ElementClosingType

enum tinyxml2::XMLElement::ElementClosingType

Enumerator
OPEN
CLOSED
CLOSING

Definition at line 1671 of file tinyxml2.h.

Constructor & Destructor Documentation

◆ XMLElement() [1/2]

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

private

Definition at line 1567 of file tinyxml2.cpp.

◆ ~XMLElement()

tinyxml2::XMLElement::~XMLElement ( )

privatevirtual

Definition at line 1574 of file tinyxml2.cpp.

References tinyxml2::XMLAttribute::_next, _rootAttribute, and DeleteAttribute().

Here is the call graph for this function:

◆ XMLElement() [2/2]

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

private

Member Function Documentation

◆ Accept()

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.

Definition at line 2111 of file tinyxml2.cpp.

References _rootAttribute, tinyxml2::XMLNode::FirstChild(), tinyxml2::XMLNode::NextSibling(), TIXMLASSERT, tinyxml2::XMLVisitor::VisitEnter(), and tinyxml2::XMLVisitor::VisitExit().

Here is the call graph for this function:

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

Definition at line 1595 of file tinyxml2.cpp.

References FindAttribute(), name, tinyxml2::XMLUtil::StringEqual(), and tinyxml2::XMLAttribute::Value().

Referenced by CustomWindow::layout(), CustomWindow::layoutChild(), CustomWindow::layoutMenu(), PackageDialog::loadProjectFile(), ParseAttributes(), parseHeader(), and NumeRe::XLSXSpreadSheet::readFile().

Here is the call graph for this function:

◆ BoolAttribute()

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

See IntAttribute()

Definition at line 1635 of file tinyxml2.cpp.

References name, and QueryBoolAttribute().

Referenced by PackageDialog::loadProjectFile().

Here is the call graph for this function:

◆ BoolText()

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

See QueryIntText()

Definition at line 1858 of file tinyxml2.cpp.

References QueryBoolText().

Here is the call graph for this function:

◆ ClosingType()

ElementClosingType tinyxml2::XMLElement::ClosingType ( ) const

inline

Definition at line 1676 of file tinyxml2.h.

Referenced by tinyxml2::XMLNode::ParseDeep().

◆ CreateAttribute()

XMLAttribute * tinyxml2::XMLElement::CreateAttribute ( )

private

Definition at line 1996 of file tinyxml2.cpp.

References tinyxml2::XMLDocument::_attributePool, tinyxml2::XMLNode::_document, tinyxml2::XMLAttribute::_memPool, tinyxml2::MemPool::SetTracked(), and TIXMLASSERT.

Referenced by FindOrCreateAttribute(), and ParseAttributes().

Here is the call graph for this function:

◆ DeleteAttribute() [1/2]

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

Delete an attribute.

Definition at line 1908 of file tinyxml2.cpp.

References tinyxml2::XMLAttribute::_next, _rootAttribute, DeleteAttribute(), name, and tinyxml2::XMLUtil::StringEqual().

Referenced by DeleteAttribute(), ParseAttributes(), and ~XMLElement().

Here is the call graph for this function:

◆ DeleteAttribute() [2/2]

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

staticprivate

Definition at line 1986 of file tinyxml2.cpp.

References tinyxml2::XMLAttribute::_memPool, tinyxml2::MemPool::Free(), and tinyxml2::XMLAttribute::~XMLAttribute().

Here is the call graph for this function:

◆ DoubleAttribute()

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

See IntAttribute()

Definition at line 1642 of file tinyxml2.cpp.

References name, and QueryDoubleAttribute().

Referenced by CustomWindow::layoutChild(), and CustomWindow::layoutMenu().

Here is the call graph for this function:

◆ DoubleText()

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

See QueryIntText()

Definition at line 1865 of file tinyxml2.cpp.

References QueryDoubleText().

Here is the call graph for this function:

◆ FindAttribute()

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

Query a specific attribute in the list.

Definition at line 1584 of file tinyxml2.cpp.

References tinyxml2::XMLAttribute::_next, _rootAttribute, name, and tinyxml2::XMLUtil::StringEqual().

Referenced by Attribute().

Here is the call graph for this function:

◆ FindOrCreateAttribute()

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

private

Definition at line 1880 of file tinyxml2.cpp.

References tinyxml2::XMLAttribute::_next, _rootAttribute, CreateAttribute(), tinyxml2::XMLAttribute::Name(), name, tinyxml2::XMLAttribute::SetName(), tinyxml2::XMLUtil::StringEqual(), and TIXMLASSERT.

Here is the call graph for this function:

◆ FirstAttribute()

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

inline

Return the first attribute in the list.

Definition at line 1514 of file tinyxml2.h.

Referenced by ShallowClone(), and ShallowEqual().

◆ FloatAttribute()

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

See IntAttribute()

Definition at line 1649 of file tinyxml2.cpp.

References name, and QueryFloatAttribute().

Here is the call graph for this function:

◆ FloatText()

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

See QueryIntText()

Definition at line 1872 of file tinyxml2.cpp.

References QueryFloatText().

Here is the call graph for this function:

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

Definition at line 1656 of file tinyxml2.cpp.

References tinyxml2::XMLNode::FirstChild(), tinyxml2::XMLNode::NextSibling(), tinyxml2::XMLNode::ToComment(), tinyxml2::XMLNode::ToText(), and tinyxml2::XMLNode::Value().

Referenced by CustomWindow::layoutChild(), CustomWindow::layoutMenu(), PackageDialog::loadProjectFile(), parseHeader(), and NumeRe::XLSXSpreadSheet::readFile().

Here is the call graph for this function:

◆ InsertNewChildElement()

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.

Definition at line 2007 of file tinyxml2.cpp.

References tinyxml2::XMLNode::_document, tinyxml2::XMLNode::InsertEndChild(), name, and tinyxml2::XMLDocument::NewElement().

Here is the call graph for this function:

◆ InsertNewComment()

XMLComment * tinyxml2::XMLElement::InsertNewComment ( const char * comment )

See InsertNewChildElement()

Definition at line 2013 of file tinyxml2.cpp.

References tinyxml2::XMLNode::_document, tinyxml2::XMLNode::InsertEndChild(), and tinyxml2::XMLDocument::NewComment().

Here is the call graph for this function:

◆ InsertNewDeclaration()

XMLDeclaration * tinyxml2::XMLElement::InsertNewDeclaration ( const char * text )

See InsertNewChildElement()

Definition at line 2025 of file tinyxml2.cpp.

References tinyxml2::XMLNode::_document, tinyxml2::XMLNode::InsertEndChild(), and tinyxml2::XMLDocument::NewDeclaration().

Here is the call graph for this function:

◆ InsertNewText()

XMLText * tinyxml2::XMLElement::InsertNewText ( const char * text )

See InsertNewChildElement()

Definition at line 2019 of file tinyxml2.cpp.

References tinyxml2::XMLNode::_document, tinyxml2::XMLNode::InsertEndChild(), and tinyxml2::XMLDocument::NewText().

Here is the call graph for this function:

◆ InsertNewUnknown()

XMLUnknown * tinyxml2::XMLElement::InsertNewUnknown ( const char * text )

See InsertNewChildElement()

Definition at line 2031 of file tinyxml2.cpp.

References tinyxml2::XMLNode::_document, tinyxml2::XMLNode::InsertEndChild(), and tinyxml2::XMLDocument::NewUnknown().

Here is the call graph for this function:

◆ Int64Attribute()

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

See IntAttribute()

Definition at line 1621 of file tinyxml2.cpp.

References name, and QueryInt64Attribute().

Here is the call graph for this function:

◆ Int64Text()

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

See QueryIntText()

Definition at line 1844 of file tinyxml2.cpp.

References QueryInt64Text().

Here is the call graph for this function:

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

Definition at line 1607 of file tinyxml2.cpp.

References name, and QueryIntAttribute().

Referenced by CustomWindow::layoutChild().

Here is the call graph for this function:

◆ IntText()

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

Definition at line 1830 of file tinyxml2.cpp.

References QueryIntText().

Here is the call graph for this function:

◆ Name()

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.

Referenced by ParseAttributes(), tinyxml2::XMLNode::ParseDeep(), ShallowEqual(), tinyxml2::XMLNode::ToElementWithName(), and tinyxml2::XMLPrinter::VisitEnter().

◆ operator=()

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

private

◆ ParseAttributes()

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

private

Definition at line 1927 of file tinyxml2.cpp.

References _closingType, tinyxml2::XMLNode::_document, tinyxml2::XMLAttribute::_next, tinyxml2::XMLDocument::_parseCurLineNum, tinyxml2::XMLNode::_parseLineNum, tinyxml2::XMLAttribute::_parseLineNum, _rootAttribute, Attribute(), CLOSED, CreateAttribute(), DeleteAttribute(), tinyxml2::XMLUtil::IsNameStartChar(), tinyxml2::XMLAttribute::Name(), Name(), tinyxml2::XMLAttribute::ParseDeep(), tinyxml2::XMLDocument::ProcessEntities(), tinyxml2::XMLDocument::SetError(), tinyxml2::XMLUtil::SkipWhiteSpace(), TIXMLASSERT, tinyxml2::XML_ERROR_PARSING_ATTRIBUTE, and tinyxml2::XML_ERROR_PARSING_ELEMENT.

Referenced by ParseDeep().

Here is the call graph for this function:

◆ ParseDeep()

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

protectedvirtual

Reimplemented from tinyxml2::XMLNode.

Definition at line 2043 of file tinyxml2.cpp.

References _closingType, tinyxml2::XMLNode::_value, CLOSING, tinyxml2::StrPair::Empty(), OPEN, ParseAttributes(), tinyxml2::XMLNode::ParseDeep(), tinyxml2::StrPair::ParseName(), and tinyxml2::XMLUtil::SkipWhiteSpace().

Here is the call graph for this function:

◆ QueryAttribute() [1/8]

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

inline

Definition at line 1448 of file tinyxml2.h.

References name.

◆ QueryAttribute() [2/8]

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

inline

Definition at line 1460 of file tinyxml2.h.

References name.

◆ QueryAttribute() [3/8]

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

inline

Definition at line 1452 of file tinyxml2.h.

References name.

◆ QueryAttribute() [4/8]

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

inline

Definition at line 1456 of file tinyxml2.h.

References name.

◆ QueryAttribute() [5/8]

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.

References name.

◆ QueryAttribute() [6/8]

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

inline

Definition at line 1440 of file tinyxml2.h.

References name.

◆ QueryAttribute() [7/8]

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

inline

Definition at line 1444 of file tinyxml2.h.

References name.

◆ QueryAttribute() [8/8]

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

inline

Definition at line 1436 of file tinyxml2.h.

References name.

◆ QueryBoolAttribute()

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

inline

See QueryIntAttribute()

Definition at line 1379 of file tinyxml2.h.

References name, tinyxml2::XMLAttribute::QueryBoolValue(), and tinyxml2::XML_NO_ATTRIBUTE.

Referenced by BoolAttribute().

Here is the call graph for this function:

◆ QueryBoolText()

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

See QueryIntText()

Definition at line 1792 of file tinyxml2.cpp.

References tinyxml2::XMLNode::FirstChild(), tinyxml2::XMLUtil::ToBool(), tinyxml2::XMLNode::ToText(), tinyxml2::XMLNode::Value(), tinyxml2::XML_CAN_NOT_CONVERT_TEXT, tinyxml2::XML_NO_TEXT_NODE, and tinyxml2::XML_SUCCESS.

Referenced by BoolText().

Here is the call graph for this function:

◆ QueryDoubleAttribute()

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

inline

See QueryIntAttribute()

Definition at line 1387 of file tinyxml2.h.

References name, tinyxml2::XMLAttribute::QueryDoubleValue(), and tinyxml2::XML_NO_ATTRIBUTE.

Referenced by DoubleAttribute().

Here is the call graph for this function:

◆ QueryDoubleText()

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

See QueryIntText()

Definition at line 1805 of file tinyxml2.cpp.

References tinyxml2::XMLNode::FirstChild(), tinyxml2::XMLUtil::ToDouble(), tinyxml2::XMLNode::ToText(), tinyxml2::XMLNode::Value(), tinyxml2::XML_CAN_NOT_CONVERT_TEXT, tinyxml2::XML_NO_TEXT_NODE, and tinyxml2::XML_SUCCESS.

Referenced by DoubleText().

Here is the call graph for this function:

◆ QueryFloatAttribute()

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

inline

See QueryIntAttribute()

Definition at line 1395 of file tinyxml2.h.

References name, tinyxml2::XMLAttribute::QueryFloatValue(), and tinyxml2::XML_NO_ATTRIBUTE.

Referenced by FloatAttribute().

Here is the call graph for this function:

◆ QueryFloatText()

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

See QueryIntText()

Definition at line 1818 of file tinyxml2.cpp.

References tinyxml2::XMLNode::FirstChild(), tinyxml2::XMLUtil::ToFloat(), tinyxml2::XMLNode::ToText(), tinyxml2::XMLNode::Value(), tinyxml2::XML_CAN_NOT_CONVERT_TEXT, tinyxml2::XML_NO_TEXT_NODE, and tinyxml2::XML_SUCCESS.

Referenced by FloatText().

Here is the call graph for this function:

◆ QueryInt64Attribute()

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

inline

See QueryIntAttribute()

Definition at line 1361 of file tinyxml2.h.

References name, tinyxml2::XMLAttribute::QueryInt64Value(), and tinyxml2::XML_NO_ATTRIBUTE.

Referenced by Int64Attribute().

Here is the call graph for this function:

◆ QueryInt64Text()

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

See QueryIntText()

Definition at line 1766 of file tinyxml2.cpp.

References tinyxml2::XMLNode::FirstChild(), tinyxml2::XMLUtil::ToInt64(), tinyxml2::XMLNode::ToText(), tinyxml2::XMLNode::Value(), tinyxml2::XML_CAN_NOT_CONVERT_TEXT, tinyxml2::XML_NO_TEXT_NODE, and tinyxml2::XML_SUCCESS.

Referenced by Int64Text().

Here is the call graph for this function:

◆ 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

Definition at line 1343 of file tinyxml2.h.

References name, tinyxml2::XMLAttribute::QueryIntValue(), and tinyxml2::XML_NO_ATTRIBUTE.

Referenced by IntAttribute().

Here is the call graph for this function:

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

Definition at line 1740 of file tinyxml2.cpp.

References tinyxml2::XMLNode::FirstChild(), tinyxml2::XMLUtil::ToInt(), tinyxml2::XMLNode::ToText(), tinyxml2::XMLNode::Value(), tinyxml2::XML_CAN_NOT_CONVERT_TEXT, tinyxml2::XML_NO_TEXT_NODE, and tinyxml2::XML_SUCCESS.

Referenced by IntText(), and NumeRe::XLSXSpreadSheet::readFile().

Here is the call graph for this function:

◆ QueryStringAttribute()

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

inline

See QueryIntAttribute()

Definition at line 1404 of file tinyxml2.h.

References name, tinyxml2::XMLAttribute::Value(), tinyxml2::XML_NO_ATTRIBUTE, and tinyxml2::XML_SUCCESS.

Here is the call graph for this function:

◆ QueryUnsigned64Attribute()

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

inline

See QueryIntAttribute()

Definition at line 1370 of file tinyxml2.h.

References name, tinyxml2::XMLAttribute::QueryUnsigned64Value(), and tinyxml2::XML_NO_ATTRIBUTE.

Referenced by Unsigned64Attribute().

Here is the call graph for this function:

◆ QueryUnsigned64Text()

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

See QueryIntText()

Definition at line 1779 of file tinyxml2.cpp.

References tinyxml2::XMLNode::FirstChild(), tinyxml2::XMLNode::ToText(), tinyxml2::XMLUtil::ToUnsigned64(), tinyxml2::XMLNode::Value(), tinyxml2::XML_CAN_NOT_CONVERT_TEXT, tinyxml2::XML_NO_TEXT_NODE, and tinyxml2::XML_SUCCESS.

Referenced by Unsigned64Text().

Here is the call graph for this function:

◆ QueryUnsignedAttribute()

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

inline

See QueryIntAttribute()

Definition at line 1352 of file tinyxml2.h.

References name, tinyxml2::XMLAttribute::QueryUnsignedValue(), and tinyxml2::XML_NO_ATTRIBUTE.

Referenced by UnsignedAttribute().

Here is the call graph for this function:

◆ QueryUnsignedText()

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

See QueryIntText()

Definition at line 1753 of file tinyxml2.cpp.

References tinyxml2::XMLNode::FirstChild(), tinyxml2::XMLNode::ToText(), tinyxml2::XMLUtil::ToUnsigned(), tinyxml2::XMLNode::Value(), tinyxml2::XML_CAN_NOT_CONVERT_TEXT, tinyxml2::XML_NO_TEXT_NODE, and tinyxml2::XML_SUCCESS.

Referenced by UnsignedText().

Here is the call graph for this function:

◆ SetAttribute() [1/8]

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

inline

Sets the named attribute to value.

Definition at line 1493 of file tinyxml2.h.

References name, and tinyxml2::XMLAttribute::SetAttribute().

Here is the call graph for this function:

◆ SetAttribute() [2/8]

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.

References name, and tinyxml2::XMLAttribute::SetAttribute().

Referenced by parseLayoutCommand(), parseLayoutScript(), PackageDialog::saveProjectFile(), and ShallowClone().

Here is the call graph for this function:

◆ SetAttribute() [3/8]

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

inline

Sets the named attribute to value.

Definition at line 1498 of file tinyxml2.h.

References name, and tinyxml2::XMLAttribute::SetAttribute().

Here is the call graph for this function:

◆ SetAttribute() [4/8]

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

inline

Sets the named attribute to value.

Definition at line 1503 of file tinyxml2.h.

References name, and tinyxml2::XMLAttribute::SetAttribute().

Here is the call graph for this function:

◆ SetAttribute() [5/8]

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

inline

Sets the named attribute to value.

Definition at line 1470 of file tinyxml2.h.

References name, and tinyxml2::XMLAttribute::SetAttribute().

Here is the call graph for this function:

◆ SetAttribute() [6/8]

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.

References name, and tinyxml2::XMLAttribute::SetAttribute().

Here is the call graph for this function:

◆ SetAttribute() [7/8]

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.

References name, and tinyxml2::XMLAttribute::SetAttribute().

Here is the call graph for this function:

◆ SetAttribute() [8/8]

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

inline

Sets the named attribute to value.

Definition at line 1475 of file tinyxml2.h.

References name, and tinyxml2::XMLAttribute::SetAttribute().

Here is the call graph for this function:

◆ SetName()

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.

Referenced by tinyxml2::XMLDocument::NewElement().

◆ SetText() [1/8]

void tinyxml2::XMLElement::SetText ( bool value )

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

Definition at line 1716 of file tinyxml2.cpp.

References BUF_SIZE, SetText(), and tinyxml2::XMLUtil::ToStr().

Here is the call graph for this function:

◆ SetText() [2/8]

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>

Definition at line 1675 of file tinyxml2.cpp.

References tinyxml2::XMLNode::FirstChild(), tinyxml2::XMLNode::GetDocument(), tinyxml2::XMLNode::InsertFirstChild(), tinyxml2::XMLDocument::NewText(), tinyxml2::XMLNode::SetValue(), and tinyxml2::XMLNode::ToText().

Referenced by parseLayoutCommand(), parseLayoutScript(), PackageDialog::saveProjectFile(), and SetText().

Here is the call graph for this function:

◆ SetText() [3/8]

void tinyxml2::XMLElement::SetText ( double value )

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

Definition at line 1732 of file tinyxml2.cpp.

References BUF_SIZE, SetText(), and tinyxml2::XMLUtil::ToStr().

Here is the call graph for this function:

◆ SetText() [4/8]

void tinyxml2::XMLElement::SetText ( float value )

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

Definition at line 1724 of file tinyxml2.cpp.

References BUF_SIZE, SetText(), and tinyxml2::XMLUtil::ToStr().

Here is the call graph for this function:

◆ SetText() [5/8]

void tinyxml2::XMLElement::SetText ( int value )

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

Definition at line 1686 of file tinyxml2.cpp.

References BUF_SIZE, SetText(), and tinyxml2::XMLUtil::ToStr().

Here is the call graph for this function:

◆ SetText() [6/8]

void tinyxml2::XMLElement::SetText ( int64_t value )

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

Definition at line 1702 of file tinyxml2.cpp.

References BUF_SIZE, SetText(), and tinyxml2::XMLUtil::ToStr().

Here is the call graph for this function:

◆ SetText() [7/8]

void tinyxml2::XMLElement::SetText ( uint64_t value )

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

Definition at line 1709 of file tinyxml2.cpp.

References BUF_SIZE, SetText(), and tinyxml2::XMLUtil::ToStr().

Here is the call graph for this function:

◆ SetText() [8/8]

void tinyxml2::XMLElement::SetText ( unsigned value )

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

Definition at line 1694 of file tinyxml2.cpp.

References BUF_SIZE, SetText(), and tinyxml2::XMLUtil::ToStr().

Here is the call graph for this function:

◆ ShallowClone()

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.

Definition at line 2072 of file tinyxml2.cpp.

References tinyxml2::XMLNode::_document, FirstAttribute(), tinyxml2::XMLDocument::NewElement(), tinyxml2::XMLAttribute::Next(), SetAttribute(), and tinyxml2::XMLNode::Value().

Here is the call graph for this function:

◆ ShallowEqual()

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.

Definition at line 2085 of file tinyxml2.cpp.

References compare(), FirstAttribute(), Name(), tinyxml2::XMLAttribute::Next(), tinyxml2::XMLUtil::StringEqual(), TIXMLASSERT, and tinyxml2::XMLAttribute::Value().

Here is the call graph for this function:

◆ ToElement() [1/2]

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/2]

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

inlinevirtual

Reimplemented from tinyxml2::XMLNode.

Definition at line 1280 of file tinyxml2.h.

◆ Unsigned64Attribute()

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

See IntAttribute()

Definition at line 1628 of file tinyxml2.cpp.

References name, and QueryUnsigned64Attribute().

Here is the call graph for this function:

◆ Unsigned64Text()

uint64_t tinyxml2::XMLElement::Unsigned64Text ( uint64_t defaultValue = 0 ) const

See QueryIntText()

Definition at line 1851 of file tinyxml2.cpp.

References QueryUnsigned64Text().

Here is the call graph for this function:

◆ UnsignedAttribute()

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

See IntAttribute()

Definition at line 1614 of file tinyxml2.cpp.

References name, and QueryUnsignedAttribute().

Here is the call graph for this function:

◆ UnsignedText()

unsigned tinyxml2::XMLElement::UnsignedText ( unsigned defaultValue = 0 ) const

See QueryIntText()

Definition at line 1837 of file tinyxml2.cpp.

References QueryUnsignedText().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ XMLDocument

friend class 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.

Referenced by ParseAttributes(), and ParseDeep().

◆ _rootAttribute

XMLAttribute* tinyxml2::XMLElement::_rootAttribute

private

Definition at line 1701 of file tinyxml2.h.

Referenced by Accept(), DeleteAttribute(), FindAttribute(), FindOrCreateAttribute(), ParseAttributes(), and ~XMLElement().

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

D:/CPP/numere-source/trunk/kernel/core/utils/tinyxml2.h
D:/CPP/numere-source/trunk/kernel/core/utils/tinyxml2.cpp

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ ElementClosingType

Constructor & Destructor Documentation

◆ XMLElement() [1/2]

◆ ~XMLElement()

◆ XMLElement() [2/2]

Member Function Documentation

◆ Accept()

◆ Attribute()

◆ BoolAttribute()

◆ BoolText()

◆ ClosingType()

◆ CreateAttribute()

◆ DeleteAttribute() [1/2]

◆ DeleteAttribute() [2/2]

◆ DoubleAttribute()

◆ DoubleText()

◆ FindAttribute()

◆ FindOrCreateAttribute()

◆ FirstAttribute()

◆ FloatAttribute()

◆ FloatText()

◆ GetText()

◆ InsertNewChildElement()

◆ InsertNewComment()

◆ InsertNewDeclaration()

◆ InsertNewText()

◆ InsertNewUnknown()

◆ Int64Attribute()

◆ Int64Text()

◆ IntAttribute()

◆ IntText()

◆ Name()

◆ operator=()

◆ ParseAttributes()

◆ ParseDeep()

◆ QueryAttribute() [1/8]

◆ QueryAttribute() [2/8]

◆ QueryAttribute() [3/8]

◆ QueryAttribute() [4/8]

◆ QueryAttribute() [5/8]

◆ QueryAttribute() [6/8]

◆ QueryAttribute() [7/8]

◆ QueryAttribute() [8/8]

◆ QueryBoolAttribute()

◆ QueryBoolText()

◆ QueryDoubleAttribute()

◆ QueryDoubleText()

◆ QueryFloatAttribute()

◆ QueryFloatText()

◆ QueryInt64Attribute()

◆ QueryInt64Text()

◆ QueryIntAttribute()

◆ QueryIntText()

◆ QueryStringAttribute()

◆ QueryUnsigned64Attribute()

◆ QueryUnsigned64Text()

◆ QueryUnsignedAttribute()

◆ QueryUnsignedText()

◆ SetAttribute() [1/8]

◆ SetAttribute() [2/8]

◆ SetAttribute() [3/8]

◆ SetAttribute() [4/8]

◆ SetAttribute() [5/8]

◆ SetAttribute() [6/8]

◆ SetAttribute() [7/8]

◆ SetAttribute() [8/8]

◆ SetName()

◆ SetText() [1/8]