#include <tinyxml.h>

Inheritance diagram for TiXmlElement:

Collaboration diagram for TiXmlElement:

[legend]

Public Member Functions
	TiXmlElement (const std::string &_value)

	TiXmlElement (const TiXmlElement &)

TiXmlElement &	operator= (const TiXmlElement &base)

virtual	~TiXmlElement ()

template<typename T = std::string>
T	readType (const std::string &str) const

template<typename T >
int	QueryValueAttribute (const std::string &name, T *outValue) const

int	QueryValueAttribute (const std::string &name, std::string *outValue) const

std::string	Attribute (const std::string &name) const

std::string	Attribute (const std::string &name, int *i) const

std::string	Attribute (const std::string &name, double *d) const

void	SetAttribute (const std::string &name, const std::string &_value)

void	SetAttribute (const std::string &name, int _value)

void	RemoveAttribute (const std::string &name)

TiXmlAttribute *	FirstAttribute ()

TiXmlAttribute *	LastAttribute ()

const char *	GetText () const

virtual TiXmlNode *	Clone () const
	Creates a new Element and returns it - the returned element is a copy. More...

virtual void	Print (FILE *cfile, int depth) const

virtual const char *	Parse (const char p, TiXmlParsingData data, TiXmlEncoding encoding)

virtual bool	Accept (TiXmlVisitor *visitor) const

Public Member Functions inherited from TiXmlNode
	TiXmlNode (const TiXmlNode &)=delete

void	operator= (const TiXmlNode &base)=delete

virtual	~TiXmlNode ()

const char *	Value () const

const std::string &	ValueStr () const

const TIXML_STRING &	ValueTStr () const

void	SetValue (const char *_value)

void	SetValue (const std::string &_value)
	STL std::string form. More...

void	Clear ()
	Delete all the children of this node. Does not affect 'this'. More...

TiXmlNode *	Parent ()
	One step up the DOM. More...

const TiXmlNode *	Parent () const

TiXmlNode *	FirstChild ()

const TiXmlNode *	FirstChild (const char *value) const

TiXmlNode *	FirstChild (const char *_value)
	The first child of this node with the matching 'value'. Will be null if none found. More...

const TiXmlNode *	LastChild () const

TiXmlNode *	LastChild ()
	The last child of this node. Will be null if there are no children. More...

const TiXmlNode *	LastChild (const char *value) const

TiXmlNode *	LastChild (const char *_value)
	The last child of this node matching 'value'. Will be null if there are no children. More...

const TiXmlNode *	IterateChildren (const TiXmlNode *previous) const

TiXmlNode *	IterateChildren (const TiXmlNode *previous)

const TiXmlNode *	IterateChildren (const char value, const TiXmlNode previous) const
	This flavor of IterateChildren searches for children with a particular 'value'. More...

TiXmlNode *	IterateChildren (const char _value, const TiXmlNode previous)

TiXmlNode *	InsertEndChild (const TiXmlNode &addThis)

TiXmlNode *	LinkEndChild (TiXmlNode *addThis)

TiXmlNode *	InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)

TiXmlNode *	InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)

TiXmlNode *	ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)

bool	RemoveChild (TiXmlNode *removeThis)
	Delete a child of this node. More...

const TiXmlNode *	PreviousSibling () const
	Navigate to a sibling node. More...

TiXmlNode *	PreviousSibling ()

const TiXmlNode *	PreviousSibling (const char *) const
	Navigate to a sibling node. More...

TiXmlNode *	PreviousSibling (const char *_prev)

const TiXmlNode *	NextSibling () const
	Navigate to a sibling node. More...

TiXmlNode *	NextSibling ()

const TiXmlNode *	NextSibling (const char *) const
	Navigate to a sibling node with the given 'value'. More...

TiXmlNode *	NextSibling (const char *_next)

const TiXmlElement *	NextSiblingElement () const

TiXmlElement *	NextSiblingElement ()

const TiXmlElement *	NextSiblingElement (const char *) const

TiXmlElement *	NextSiblingElement (const char *_next)

const TiXmlElement *	FirstChildElement () const
	Convenience function to get through elements. More...

TiXmlElement *	FirstChildElement ()

const TiXmlElement *	FirstChildElement (const char *_value) const
	Convenience function to get through elements. More...

TiXmlElement *	FirstChildElement (const char *_value)

int	Type () const

const TiXmlDocument *	GetDocument () const

TiXmlDocument *	GetDocument ()

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

Public Member Functions inherited from TiXmlBase
	TiXmlBase (const TiXmlBase &)=delete

void	operator= (const TiXmlBase &base)=delete

	TiXmlBase ()

virtual	~TiXmlBase ()

int	Row () const

Protected Member Functions
void	CopyTo (TiXmlElement *target) const

void	ClearThis ()

virtual void	StreamIn (std::istream in, TIXML_STRING tag)

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

Protected Member Functions inherited from TiXmlNode
	TiXmlNode (NodeType _type)

void	CopyTo (TiXmlNode *target) const

TiXmlNode *	Identify (const char *start, TiXmlEncoding encoding)

Additional Inherited Members
Public Types inherited from TiXmlNode
enum	NodeType { TINYXML_DOCUMENT, TINYXML_ELEMENT, TINYXML_COMMENT, TINYXML_UNKNOWN, TINYXML_TEXT, TINYXML_DECLARATION, TINYXML_TYPECOUNT }

Public Types inherited from TiXmlBase
enum	{ TIXML_NO_ERROR = 0, TIXML_ERROR, TIXML_ERROR_OPENING_FILE, TIXML_ERROR_PARSING_ELEMENT, TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME, TIXML_ERROR_READING_ELEMENT_VALUE, TIXML_ERROR_READING_ATTRIBUTES, TIXML_ERROR_PARSING_EMPTY, TIXML_ERROR_READING_END_TAG, TIXML_ERROR_PARSING_UNKNOWN, TIXML_ERROR_PARSING_COMMENT, TIXML_ERROR_PARSING_DECLARATION, TIXML_ERROR_DOCUMENT_EMPTY, TIXML_ERROR_EMBEDDED_NULL, TIXML_ERROR_PARSING_CDATA, TIXML_ERROR_DOCUMENT_TOP_ONLY, TIXML_ERROR_STRING_COUNT }

Static Public Member Functions inherited from TiXmlBase
static void	SetCondenseWhiteSpace (bool condense)

static bool	IsWhiteSpaceCondensed ()
	Return the current white space setting. More...

static void	EncodeString (const TIXML_STRING &str, TIXML_STRING *out)

Static Public Attributes inherited from TiXmlBase
static const int	utf8ByteTable [256]

Static Protected Member Functions inherited from TiXmlBase
static const char *	SkipWhiteSpace (const char *, TiXmlEncoding encoding)

static bool	IsWhiteSpace (char c)

static bool	IsWhiteSpace (int c)

static bool	StreamWhiteSpace (std::istream in, TIXML_STRING tag)

static bool	StreamTo (std::istream in, int character, TIXML_STRING tag)

static const char *	ReadName (const char p, TIXML_STRING name, TiXmlEncoding encoding)

static const char *	ReadText (const char in, TIXML_STRING text, bool ignoreWhiteSpace, const char *endTag, bool ignoreCase, TiXmlEncoding encoding)

static const char *	GetEntity (const char in, char value, int *length, TiXmlEncoding encoding)

static const char *	GetChar (const char p, char _value, int *length, TiXmlEncoding encoding)

static bool	StringEqual (const char p, const char endTag, bool ignoreCase, TiXmlEncoding encoding)

static int	IsAlpha (unsigned char anyByte, TiXmlEncoding encoding)

static int	IsAlphaNum (unsigned char anyByte, TiXmlEncoding encoding)

static int	ToLower (int v, TiXmlEncoding encoding)

static void	ConvertUTF32ToUTF8 (unsigned long input, char output, int length)

Protected Attributes inherited from TiXmlNode
TiXmlNode *	parent

NodeType	type

TiXmlNode *	firstChild

TiXmlNode *	lastChild

TIXML_STRING	value

TiXmlNode *	prev

TiXmlNode *	next

Protected Attributes inherited from TiXmlBase
TiXmlCursor	location

void *	userData
	Field containing a generic user pointer. More...

Static Protected Attributes inherited from TiXmlBase
static const char *	errorString [TIXML_ERROR_STRING_COUNT]

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

Constructor & Destructor Documentation

◆ TiXmlElement() [1/2]

TiXmlElement::TiXmlElement ( const std::string & _value )

Definition at line 518 of file tinyxml.cpp.

◆ TiXmlElement() [2/2]

TiXmlElement::TiXmlElement ( const TiXmlElement & copy )

Definition at line 525 of file tinyxml.cpp.

Here is the call graph for this function:

◆ ~TiXmlElement()

TiXmlElement::~TiXmlElement ( )

virtual

Definition at line 541 of file tinyxml.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ Accept()

bool TiXmlElement::Accept ( TiXmlVisitor * visitor ) const

virtual

Walk the XML tree visiting this node and all of its children.

Implements TiXmlNode.

Definition at line 678 of file tinyxml.cpp.

Here is the call graph for this function:

◆ Attribute() [1/3]

std::string TiXmlElement::Attribute ( const std::string & name ) const

Definition at line 558 of file tinyxml.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Attribute() [2/3]

std::string TiXmlElement::Attribute	(	const std::string &	name,
		double *	d
	)		const

Definition at line 580 of file tinyxml.cpp.

Here is the call graph for this function:

◆ Attribute() [3/3]

std::string TiXmlElement::Attribute	(	const std::string &	name,
		int *	i
	)		const

Definition at line 566 of file tinyxml.cpp.

Here is the call graph for this function:

◆ ClearThis()

void TiXmlElement::ClearThis ( )

protected

Definition at line 547 of file tinyxml.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Clone()

TiXmlNode * TiXmlElement::Clone ( ) const

virtual

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

Implements TiXmlNode.

Definition at line 692 of file tinyxml.cpp.

Here is the call graph for this function:

◆ CopyTo()

void TiXmlElement::CopyTo ( TiXmlElement * target ) const

protected

Definition at line 656 of file tinyxml.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FirstAttribute()

TiXmlAttribute* TiXmlElement::FirstAttribute ( )

inline

Definition at line 1002 of file tinyxml.h.

Here is the call graph for this function:

◆ GetText()

const char * TiXmlElement::GetText ( ) const

Convenience function for easy access to the text inside an element. Although easy and concise, GetText() is limited compared to getting the TiXmlText child and accessing it directly.

If the first child of 'this' is a TiXmlText, the GetText() returns the character string of the Text node, else null is returned.

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

<foo>This is text</foo>
const char* str = fooElement->GetText();

'str' will be a pointer to "This is text".

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

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

then the value of str would be null. The first child node isn't a text node, it is another element. From this XML:

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

GetText() will return "This is ".

WARNING: GetText() accesses a child node - don't become confused with the similarly named TiXmlHandle::Text() and TiXmlNode::ToText() which are safe type casts on the referenced node.

Definition at line 703 of file tinyxml.cpp.

Here is the call graph for this function:

◆ LastAttribute()

TiXmlAttribute* TiXmlElement::LastAttribute ( )

inline

Definition at line 1004 of file tinyxml.h.

Here is the call graph for this function:

◆ operator=()

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

Definition at line 533 of file tinyxml.cpp.

Here is the call graph for this function:

◆ Parse()

const char * TiXmlElement::Parse	(	const char *	p,
		TiXmlParsingData *	data,
		TiXmlEncoding	encoding
	)

virtual

Implements TiXmlBase.

Definition at line 1047 of file tinyxmlparser.cpp.

Here is the call graph for this function:

◆ Print()

void TiXmlElement::Print	(	FILE *	cfile,
		int	depth
	)		const

virtual

All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.) Either or both cfile and str can be null.

This is a formatted print, and will insert tabs and newlines.

(For an unformatted stream, use the << operator.)

Implements TiXmlBase.

Definition at line 603 of file tinyxml.cpp.

Here is the call graph for this function:

◆ QueryValueAttribute() [1/2]

int TiXmlElement::QueryValueAttribute	(	const std::string &	name,
		std::string *	outValue
	)		const

inline

Definition at line 983 of file tinyxml.h.

Here is the call graph for this function:

◆ QueryValueAttribute() [2/2]

template<typename T >

int TiXmlElement::QueryValueAttribute	(	const std::string &	name,
		T *	outValue
	)		const

inline

Template form of the attribute query which will try to read the attribute into the specified type. Very easy, very powerful, but be careful to make sure to call this with the correct type.

NOTE: This method doesn't work correctly for 'string' types that contain spaces.

Returns: TIXML_SUCCESS, TIXML_WRONG_TYPE, or TIXML_NO_ATTRIBUTE

Definition at line 970 of file tinyxml.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readType()

template<typename T = std::string>

T TiXmlElement::readType ( const std::string & str ) const

inline

Definition at line 953 of file tinyxml.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadValue()

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

protected

Definition at line 1183 of file tinyxmlparser.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RemoveAttribute()

void TiXmlElement::RemoveAttribute ( const std::string & name )

Definition at line 436 of file tinyxml.cpp.

Here is the call graph for this function:

◆ SetAttribute() [1/2]

void TiXmlElement::SetAttribute	(	const std::string &	name,
		const std::string &	_value
	)

Definition at line 594 of file tinyxml.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetAttribute() [2/2]

void TiXmlElement::SetAttribute	(	const std::string &	name,
		int	_value
	)

inline

Definition at line 997 of file tinyxml.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StreamIn()

void TiXmlElement::StreamIn	(	std::istream *	in,
		TIXML_STRING *	tag
	)

protectedvirtual

Implements TiXmlNode.

Definition at line 907 of file tinyxmlparser.cpp.

Here is the call graph for this function:

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

src/framework/xml/tinyxml.h
src/framework/xml/tinyxml.cpp
src/framework/xml/tinyxmlparser.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TiXmlElement() [1/2]

◆ TiXmlElement() [2/2]

◆ ~TiXmlElement()

Member Function Documentation

◆ Accept()

◆ Attribute() [1/3]

◆ Attribute() [2/3]

◆ Attribute() [3/3]

◆ ClearThis()

◆ Clone()

◆ CopyTo()

◆ FirstAttribute()

◆ GetText()

◆ LastAttribute()

◆ operator=()

◆ Parse()

◆ Print()

◆ QueryValueAttribute() [1/2]

◆ QueryValueAttribute() [2/2]

◆ readType()

◆ ReadValue()

◆ RemoveAttribute()

◆ SetAttribute() [1/2]

◆ SetAttribute() [2/2]

◆ StreamIn()