TiXmlElement Class Reference

The element is a container class. More...

#include <tinyxml.h>

Inheritance diagram for TiXmlElement:

List of all members.

Public Types

enum NodeType {
DOCUMENT, ELEMENT, COMMENT, UNKNOWN,
TEXT, DECLARATION, TYPECOUNT
}

The types of XML nodes supported by TinyXml. More...

Public Member Functions

TiXmlElement (const char *in_value)

Construct an element.

TiXmlElement (const TiXmlElement &)

void operator= (const TiXmlElement &base)

virtual ~TiXmlElement ()

const char * Attribute (const char *name) const

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.

const char * Attribute (const char *name, int *i) const

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.

const char * Attribute (const char *name, double *d) const

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.

int QueryIntAttribute (const char *name, int *_value) const

QueryIntAttribute examines the attribute - it is an alternative to the Attribute() method with richer error checking.

int QueryDoubleAttribute (const char *name, double *_value) const

QueryDoubleAttribute examines the attribute - see QueryIntAttribute().

int QueryFloatAttribute (const char *name, float *_value) const

QueryFloatAttribute examines the attribute - see QueryIntAttribute().

void SetAttribute (const char *name, const char *_value)

Sets an attribute of name to a given value.

void SetAttribute (const char *name, int value)

Sets an attribute of name to a given value.

void SetDoubleAttribute (const char *name, double value)

Sets an attribute of name to a given value.

void RemoveAttribute (const char *name)

Deletes an attribute with the given name.

const TiXmlAttribute * FirstAttribute () const

Access the first attribute in this element.

TiXmlAttribute * FirstAttribute ()

const TiXmlAttribute * LastAttribute () const

Access the last attribute in this element.

TiXmlAttribute * LastAttribute ()

const char * GetText () const

Convenience function for easy access to the text inside an element.

virtual TiXmlNode * Clone () const

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

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

All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.

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

virtual const TiXmlElement * ToElement () const

Cast to a more defined type. Will return null not of the requested type.

virtual TiXmlElement * ToElement ()

Cast to a more defined type. Will return null not of the requested type.

virtual bool Accept (TiXmlVisitor *visitor) const

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

const char * Value () const

The meaning of 'value' changes for the specific type of TiXmlNode.

const TIXML_STRING & ValueTStr () const

void SetValue (const char *_value)

Changes the value of the node.

void Clear ()

Delete all the children of this node. Does not affect 'this'.

TiXmlNode * Parent ()

One step up the DOM.

const TiXmlNode * Parent () const

const TiXmlNode * FirstChild () const

The first child of this node. Will be null if there are no children.

TiXmlNode * FirstChild ()

const TiXmlNode * FirstChild (const char *value) const

The first child of this node with the matching 'value'. Will be null if none found. The first child of this node with the matching 'value'. Will be null if none found.

TiXmlNode * FirstChild (const char *_value)

const TiXmlNode * LastChild () const

TiXmlNode * LastChild ()

The last child of this node. Will be null if there are no children.

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.

const TiXmlNode * IterateChildren (const TiXmlNode *previous) const

An alternate way to walk the children of a node.

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

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

TiXmlNode * InsertEndChild (const TiXmlNode &addThis)

Add a new node related to this.

TiXmlNode * LinkEndChild (TiXmlNode *addThis)

Add a new node related to this.

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

Add a new node related to this.

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

Add a new node related to this.

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

Replace a child of this node.

bool RemoveChild (TiXmlNode *removeThis)

Delete a child of this node.

const TiXmlNode * PreviousSibling () const

Navigate to a sibling node.

TiXmlNode * PreviousSibling ()

const TiXmlNode * PreviousSibling (const char *) const

Navigate to a sibling node.

TiXmlNode * PreviousSibling (const char *_prev)

const TiXmlNode * NextSibling () const

Navigate to a sibling node.

TiXmlNode * NextSibling ()

const TiXmlNode * NextSibling (const char *) const

Navigate to a sibling node with the given 'value'.

TiXmlNode * NextSibling (const char *_next)

const TiXmlElement * NextSiblingElement () const

Convenience function to get through elements.

TiXmlElement * NextSiblingElement ()

const TiXmlElement * NextSiblingElement (const char *) const

Convenience function to get through elements.

TiXmlElement * NextSiblingElement (const char *_next)

const TiXmlElement * FirstChildElement () const

Convenience function to get through elements.

TiXmlElement * FirstChildElement ()

const TiXmlElement * FirstChildElement (const char *_value) const

Convenience function to get through elements.

TiXmlElement * FirstChildElement (const char *_value)

int Type () const

Query the type (as an enumerated value, above) of this node.

const TiXmlDocument * GetDocument () const

Return a pointer to the Document this node lives in.

TiXmlDocument * GetDocument ()

bool NoChildren () const

Returns true if this node has no children.

virtual const TiXmlDocument * ToDocument () const

Cast to a more defined type. Will return null if not of the requested type.

virtual TiXmlDocument * ToDocument ()

Cast to a more defined type. Will return null if not of the requested type.

virtual const TiXmlComment * ToComment () const

Cast to a more defined type. Will return null if not of the requested type.

virtual TiXmlComment * ToComment ()

Cast to a more defined type. Will return null if not of the requested type.

virtual const TiXmlUnknown * ToUnknown () const

Cast to a more defined type. Will return null if not of the requested type.

virtual TiXmlUnknown * ToUnknown ()

Cast to a more defined type. Will return null if not of the requested type.

virtual const TiXmlText * ToText () const

Cast to a more defined type. Will return null if not of the requested type.

virtual TiXmlText * ToText ()

Cast to a more defined type. Will return null if not of the requested type.

virtual const TiXmlDeclaration * ToDeclaration () const

Cast to a more defined type. Will return null if not of the requested type.

virtual TiXmlDeclaration * ToDeclaration ()

Cast to a more defined type. Will return null if not of the requested type.

int Row () const

Return the position, in the original source file, of this node or attribute.

int Column () const

See Row().

void SetUserData (void *user)

Set a pointer to arbitrary user data.

void * GetUserData ()

Get a pointer to arbitrary user data.

const void * GetUserData () const

Get a pointer to arbitrary user data.

Static Public Member Functions

static void SetCondenseWhiteSpace (bool condense)

The world does not agree on whether white space should be kept or not.

static bool IsWhiteSpaceCondensed ()

Return the current white space setting.

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

Expands entities in a string.

Static Public Attributes

static const int utf8ByteTable [256]

Protected Member Functions

void CopyTo (TiXmlElement *target) const

void ClearThis ()

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

void CopyTo (TiXmlNode *target) const

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

Static Protected Member Functions

static const char * SkipWhiteSpace (const char *, TiXmlEncoding encoding)

static bool IsWhiteSpace (char c)

static bool IsWhiteSpace (int c)

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

TiXmlNode * parent

NodeType type

TiXmlNode * firstChild

TiXmlNode * lastChild

TIXML_STRING value

TiXmlNode * prev

TiXmlNode * next

TiXmlCursor location

void * userData

Field containing a generic user pointer.

Static Protected Attributes

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.

Member Enumeration Documentation

anonymous enum [inherited]

Enumerator:

TIXML_NO_ERROR
TIXML_ERROR
TIXML_ERROR_OPENING_FILE
TIXML_ERROR_OUT_OF_MEMORY
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

enum TiXmlNode::NodeType [inherited]

The types of XML nodes supported by TinyXml.

(All the unsupported types are picked up by UNKNOWN.)

Enumerator:

DOCUMENT
ELEMENT
COMMENT
UNKNOWN
TEXT
DECLARATION
TYPECOUNT

Constructor & Destructor Documentation

TiXmlElement::TiXmlElement ( const char * in_value )

Construct an element.

TiXmlElement::TiXmlElement ( const TiXmlElement & )

virtual TiXmlElement::~TiXmlElement ( ) [virtual]

Member Function Documentation

virtual bool TiXmlElement::Accept ( TiXmlVisitor * visitor ) const [virtual]

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

Implements TiXmlNode.

const char* TiXmlElement::Attribute	(	const char *	name,
		double *	d
	)			const

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.

If the attribute exists and can be converted to an double, the double value will be put in the return 'd', if 'd' is non-null.

const char* TiXmlElement::Attribute	(	const char *	name,
		int *	i
	)			const

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.

If the attribute exists and can be converted to an integer, the integer value will be put in the return 'i', if 'i' is non-null.

const char* TiXmlElement::Attribute ( const char * name ) const

Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.

void TiXmlNode::Clear ( ) [inherited]

Delete all the children of this node. Does not affect 'this'.

void TiXmlElement::ClearThis ( ) [protected]

virtual TiXmlNode* TiXmlElement::Clone ( ) const [virtual]

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

Implements TiXmlNode.

int TiXmlBase::Column ( ) const [inline, inherited]

See Row().

static void TiXmlBase::ConvertUTF32ToUTF8	(	unsigned long	input,
		char *	output,
		int *	length
	)			`[static, protected, inherited]`

void TiXmlNode::CopyTo ( TiXmlNode * target ) const [protected, inherited]

void TiXmlElement::CopyTo ( TiXmlElement * target ) const [protected]

static void TiXmlBase::EncodeString	(	const TIXML_STRING &	str,
		TIXML_STRING *	out
	)			`[static, inherited]`

Expands entities in a string.

Note this should not contian the tag's '<', '>', etc, or they will be transformed into entities!

TiXmlAttribute* TiXmlElement::FirstAttribute ( ) [inline]

const TiXmlAttribute* TiXmlElement::FirstAttribute ( ) const [inline]

Access the first attribute in this element.

TiXmlNode* TiXmlNode::FirstChild ( const char * _value ) [inline, inherited]

const TiXmlNode* TiXmlNode::FirstChild ( const char * value ) const [inherited]

The first child of this node with the matching 'value'. Will be null if none found. The first child of this node with the matching 'value'. Will be null if none found.

TiXmlNode* TiXmlNode::FirstChild ( ) [inline, inherited]

const TiXmlNode* TiXmlNode::FirstChild ( ) const [inline, inherited]

The first child of this node. Will be null if there are no children.

TiXmlElement* TiXmlNode::FirstChildElement ( const char * _value ) [inline, inherited]

const TiXmlElement* TiXmlNode::FirstChildElement ( const char * _value ) const [inherited]

Convenience function to get through elements.

TiXmlElement* TiXmlNode::FirstChildElement ( ) [inline, inherited]

const TiXmlElement* TiXmlNode::FirstChildElement ( ) const [inherited]

Convenience function to get through elements.

Referenced by TiXmlDocument::RootElement().

static const char* TiXmlBase::GetChar	(	const char *	p,
		char *	_value,
		int *	length,
		TiXmlEncoding	encoding
	)			`[inline, static, protected, inherited]`

TiXmlDocument* TiXmlNode::GetDocument ( ) [inline, inherited]

const TiXmlDocument* TiXmlNode::GetDocument ( ) const [inherited]

Return a pointer to the Document this node lives in.

Returns null if not in a document.

static const char* TiXmlBase::GetEntity	(	const char *	in,
		char *	value,
		int *	length,
		TiXmlEncoding	encoding
	)			`[static, protected, inherited]`

Referenced by TiXmlBase::GetChar().

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.

const void* TiXmlBase::GetUserData ( ) const [inline, inherited]

Get a pointer to arbitrary user data.

void* TiXmlBase::GetUserData ( ) [inline, inherited]

Get a pointer to arbitrary user data.

TiXmlNode* TiXmlNode::Identify	(	const char *	start,
		TiXmlEncoding	encoding
	)			`[protected, inherited]`

TiXmlNode* TiXmlNode::InsertAfterChild	(	TiXmlNode *	afterThis,
		const TiXmlNode &	addThis
	)			`[inherited]`

Add a new node related to this.

Adds a child after the specified child. Returns a pointer to the new object or NULL if an error occured.

TiXmlNode* TiXmlNode::InsertBeforeChild	(	TiXmlNode *	beforeThis,
		const TiXmlNode &	addThis
	)			`[inherited]`

Add a new node related to this.

Adds a child before the specified child. Returns a pointer to the new object or NULL if an error occured.

TiXmlNode* TiXmlNode::InsertEndChild ( const TiXmlNode & addThis ) [inherited]

Add a new node related to this.

Adds a child past the LastChild. Returns a pointer to the new object or NULL if an error occured.

static int TiXmlBase::IsAlpha	(	unsigned char	anyByte,
		TiXmlEncoding	encoding
	)			`[static, protected, inherited]`

static int TiXmlBase::IsAlphaNum	(	unsigned char	anyByte,
		TiXmlEncoding	encoding
	)			`[static, protected, inherited]`

static bool TiXmlBase::IsWhiteSpace ( int c ) [inline, static, protected, inherited]

static bool TiXmlBase::IsWhiteSpace ( char c ) [inline, static, protected, inherited]

Referenced by TiXmlBase::IsWhiteSpace().

static bool TiXmlBase::IsWhiteSpaceCondensed ( ) [inline, static, inherited]

Return the current white space setting.

TiXmlNode* TiXmlNode::IterateChildren	(	const char *	_value,
		const TiXmlNode *	previous
	)			`[inline, inherited]`

const TiXmlNode* TiXmlNode::IterateChildren	(	const char *	value,
		const TiXmlNode *	previous
	)			const `[inherited]`

This flavor of IterateChildren searches for children with a particular 'value'.

TiXmlNode* TiXmlNode::IterateChildren ( const TiXmlNode * previous ) [inline, inherited]

const TiXmlNode* TiXmlNode::IterateChildren ( const TiXmlNode * previous ) const [inherited]

An alternate way to walk the children of a node.

One way to iterate over nodes is:

			for( child = parent->FirstChild(); child; child = child->NextSibling() )

IterateChildren does the same thing with the syntax:

			child = 0;
			while( child = parent->IterateChildren( child ) )

IterateChildren takes the previous child as input and finds the next one. If the previous child is null, it returns the first. IterateChildren will return null when done.

TiXmlAttribute* TiXmlElement::LastAttribute ( ) [inline]

const TiXmlAttribute* TiXmlElement::LastAttribute ( ) const [inline]

Access the last attribute in this element.

TiXmlNode* TiXmlNode::LastChild ( const char * _value ) [inline, inherited]

The last child of this node matching 'value'. Will be null if there are no children.

const TiXmlNode* TiXmlNode::LastChild ( const char * value ) const [inherited]

TiXmlNode* TiXmlNode::LastChild ( ) [inline, inherited]

The last child of this node. Will be null if there are no children.

const TiXmlNode* TiXmlNode::LastChild ( ) const [inline, inherited]

TiXmlNode* TiXmlNode::LinkEndChild ( TiXmlNode * addThis ) [inherited]

Add a new node related to this.

Adds a child past the LastChild.

NOTE: the node to be added is passed by pointer, and will be henceforth owned (and deleted) by tinyXml. This method is efficient and avoids an extra copy, but should be used with care as it uses a different memory model than the other insert functions.

See also:: InsertEndChild

TiXmlNode* TiXmlNode::NextSibling ( const char * _next ) [inline, inherited]

const TiXmlNode* TiXmlNode::NextSibling ( const char * ) const [inherited]

Navigate to a sibling node with the given 'value'.

TiXmlNode* TiXmlNode::NextSibling ( ) [inline, inherited]

const TiXmlNode* TiXmlNode::NextSibling ( ) const [inline, inherited]

Navigate to a sibling node.

TiXmlElement* TiXmlNode::NextSiblingElement ( const char * _next ) [inline, inherited]

const TiXmlElement* TiXmlNode::NextSiblingElement ( const char * ) const [inherited]

Convenience function to get through elements.

Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.

TiXmlElement* TiXmlNode::NextSiblingElement ( ) [inline, inherited]

const TiXmlElement* TiXmlNode::NextSiblingElement ( ) const [inherited]

Convenience function to get through elements.

Calls NextSibling and ToElement. Will skip all non-Element nodes. Returns 0 if there is not another element.

bool TiXmlNode::NoChildren ( ) const [inline, inherited]

Returns true if this node has no children.

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

const TiXmlNode* TiXmlNode::Parent ( ) const [inline, inherited]

TiXmlNode* TiXmlNode::Parent ( ) [inline, inherited]

One step up the DOM.

virtual const char* TiXmlElement::Parse	(	const char *	p,
		TiXmlParsingData *	data,
		TiXmlEncoding	encoding
	)			`[virtual]`

Implements TiXmlBase.

TiXmlNode* TiXmlNode::PreviousSibling ( const char * _prev ) [inline, inherited]

const TiXmlNode* TiXmlNode::PreviousSibling ( const char * ) const [inherited]

Navigate to a sibling node.

TiXmlNode* TiXmlNode::PreviousSibling ( ) [inline, inherited]

const TiXmlNode* TiXmlNode::PreviousSibling ( ) const [inline, inherited]

Navigate to a sibling node.

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

int TiXmlElement::QueryDoubleAttribute	(	const char *	name,
		double *	_value
	)			const

QueryDoubleAttribute examines the attribute - see QueryIntAttribute().

Referenced by QueryFloatAttribute().

int TiXmlElement::QueryFloatAttribute	(	const char *	name,
		float *	_value
	)			const `[inline]`

QueryFloatAttribute examines the attribute - see QueryIntAttribute().

int TiXmlElement::QueryIntAttribute	(	const char *	name,
		int *	_value
	)			const

QueryIntAttribute examines the attribute - it is an alternative to the Attribute() method with richer error checking.

If the attribute is an integer, it is stored in 'value' and the call returns TIXML_SUCCESS. If it is not an integer, it returns TIXML_WRONG_TYPE. If the attribute does not exist, then TIXML_NO_ATTRIBUTE is returned.

static const char* TiXmlBase::ReadName	(	const char *	p,
		TIXML_STRING *	name,
		TiXmlEncoding	encoding
	)			`[static, protected, inherited]`

static const char* TiXmlBase::ReadText	(	const char *	in,
		TIXML_STRING *	text,
		bool	ignoreWhiteSpace,
		const char *	endTag,
		bool	ignoreCase,
		TiXmlEncoding	encoding
	)			`[static, protected, inherited]`

const char* TiXmlElement::ReadValue	(	const char *	in,
		TiXmlParsingData *	prevData,
		TiXmlEncoding	encoding
	)			`[protected]`

void TiXmlElement::RemoveAttribute ( const char * name )

Deletes an attribute with the given name.

bool TiXmlNode::RemoveChild ( TiXmlNode * removeThis ) [inherited]

Delete a child of this node.

TiXmlNode* TiXmlNode::ReplaceChild	(	TiXmlNode *	replaceThis,
		const TiXmlNode &	withThis
	)			`[inherited]`

Replace a child of this node.

Returns a pointer to the new object or NULL if an error occured.

int TiXmlBase::Row ( ) const [inline, inherited]

Return the position, in the original source file, of this node or attribute.

The row and column are 1-based. (That is the first row and first column is 1,1). If the returns values are 0 or less, then the parser does not have a row and column value.

Generally, the row and column value will be set when the TiXmlDocument::Load(), TiXmlDocument::LoadFile(), or any TiXmlNode::Parse() is called. It will NOT be set when the DOM was created from operator>>.

The values reflect the initial load. Once the DOM is modified programmatically (by adding or changing nodes and attributes) the new values will NOT update to reflect changes in the document.

There is a minor performance cost to computing the row and column. Computation can be disabled if TiXmlDocument::SetTabSize() is called with 0 as the value.

See also:: TiXmlDocument::SetTabSize()

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

Sets an attribute of name to a given value.

The attribute will be created if it does not exist, or changed if it does.

void TiXmlElement::SetAttribute	(	const char *	name,
		const char *	_value
	)

Sets an attribute of name to a given value.

The attribute will be created if it does not exist, or changed if it does.

static void TiXmlBase::SetCondenseWhiteSpace ( bool condense ) [inline, static, inherited]

The world does not agree on whether white space should be kept or not.

In order to make everyone happy, these global, static functions are provided to set whether or not TinyXml will condense all white space into a single space or not. The default is to condense. Note changing this value is not thread safe.

void TiXmlElement::SetDoubleAttribute	(	const char *	name,
		double	value
	)

Sets an attribute of name to a given value.

The attribute will be created if it does not exist, or changed if it does.

void TiXmlBase::SetUserData ( void * user ) [inline, inherited]

Set a pointer to arbitrary user data.

void TiXmlNode::SetValue ( const char * _value ) [inline, inherited]

Changes the value of the node.

Defined as:

		Document:	filename of the xml file
		Element:	name of the element
		Comment:	the comment text
		Unknown:	the tag contents
		Text:		the text string

Referenced by TiXmlComment::TiXmlComment(), and TiXmlText::TiXmlText().

static const char* TiXmlBase::SkipWhiteSpace	(	const char *	,
		TiXmlEncoding	encoding
	)			`[static, protected, inherited]`

static bool TiXmlBase::StringEqual	(	const char *	p,
		const char *	endTag,
		bool	ignoreCase,
		TiXmlEncoding	encoding
	)			`[static, protected, inherited]`

virtual TiXmlComment* TiXmlNode::ToComment ( ) [inline, virtual, inherited]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlComment.

virtual const TiXmlComment* TiXmlNode::ToComment ( ) const [inline, virtual, inherited]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlComment.

virtual TiXmlDeclaration* TiXmlNode::ToDeclaration ( ) [inline, virtual, inherited]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlDeclaration.

virtual const TiXmlDeclaration* TiXmlNode::ToDeclaration ( ) const [inline, virtual, inherited]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlDeclaration.

virtual TiXmlDocument* TiXmlNode::ToDocument ( ) [inline, virtual, inherited]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlDocument.

virtual const TiXmlDocument* TiXmlNode::ToDocument ( ) const [inline, virtual, inherited]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlDocument.

virtual TiXmlElement* TiXmlElement::ToElement ( ) [inline, virtual]

Cast to a more defined type. Will return null not of the requested type.

Reimplemented from TiXmlNode.

virtual const TiXmlElement* TiXmlElement::ToElement ( ) const [inline, virtual]

Cast to a more defined type. Will return null not of the requested type.

Reimplemented from TiXmlNode.

static int TiXmlBase::ToLower	(	int	v,
		TiXmlEncoding	encoding
	)			`[inline, static, protected, inherited]`

virtual TiXmlText* TiXmlNode::ToText ( ) [inline, virtual, inherited]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlText.

virtual const TiXmlText* TiXmlNode::ToText ( ) const [inline, virtual, inherited]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlText.

virtual TiXmlUnknown* TiXmlNode::ToUnknown ( ) [inline, virtual, inherited]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlUnknown.

virtual const TiXmlUnknown* TiXmlNode::ToUnknown ( ) const [inline, virtual, inherited]

Cast to a more defined type. Will return null if not of the requested type.

Reimplemented in TiXmlUnknown.

int TiXmlNode::Type ( ) const [inline, inherited]

Query the type (as an enumerated value, above) of this node.

The possible types are: DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, and DECLARATION.

const char* TiXmlNode::Value ( ) const [inline, inherited]

The meaning of 'value' changes for the specific type of TiXmlNode.

		Document:	filename of the xml file
		Element:	name of the element
		Comment:	the comment text
		Unknown:	the tag contents
		Text:		the text string

The subclasses will wrap this function.

const TIXML_STRING& TiXmlNode::ValueTStr ( ) const [inline, inherited]

Member Data Documentation

const char* TiXmlBase::errorString[TIXML_ERROR_STRING_COUNT] [static, protected, inherited]

TiXmlNode* TiXmlNode::firstChild [protected, inherited]

Referenced by TiXmlNode::FirstChild(), and TiXmlNode::NoChildren().

TiXmlNode* TiXmlNode::lastChild [protected, inherited]

Referenced by TiXmlNode::LastChild().

TiXmlCursor TiXmlBase::location [protected, inherited]

Referenced by TiXmlBase::Column(), and TiXmlBase::Row().

TiXmlNode* TiXmlNode::next [protected, inherited]

Referenced by TiXmlNode::NextSibling().

TiXmlNode* TiXmlNode::parent [protected, inherited]

Referenced by TiXmlNode::Parent().

TiXmlNode* TiXmlNode::prev [protected, inherited]

Referenced by TiXmlNode::PreviousSibling().

NodeType TiXmlNode::type [protected, inherited]

Referenced by TiXmlNode::Type().

void* TiXmlBase::userData [protected, inherited]

Field containing a generic user pointer.

Referenced by TiXmlBase::GetUserData(), and TiXmlBase::SetUserData().

const int TiXmlBase::utf8ByteTable[256] [static, inherited]

Referenced by TiXmlBase::GetChar().

TIXML_STRING TiXmlNode::value [protected, inherited]

Referenced by TiXmlNode::SetValue(), TiXmlNode::Value(), and TiXmlNode::ValueTStr().

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

include/sk/other/tinyxml/tinyxml.h


Public Types
enum	NodeType { DOCUMENT, ELEMENT, COMMENT, UNKNOWN, TEXT, DECLARATION, TYPECOUNT }
	The types of XML nodes supported by TinyXml. More...
Public Member Functions
	TiXmlElement (const char *in_value)
	Construct an element.
	TiXmlElement (const TiXmlElement &)
void	operator= (const TiXmlElement &base)
virtual	~TiXmlElement ()
const char *	Attribute (const char *name) const
	Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.
const char *	Attribute (const char name, int i) const
	Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.
const char *	Attribute (const char name, double d) const
	Given an attribute name, Attribute() returns the value for the attribute of that name, or null if none exists.
int	QueryIntAttribute (const char name, int _value) const
	QueryIntAttribute examines the attribute - it is an alternative to the Attribute() method with richer error checking.
int	QueryDoubleAttribute (const char name, double _value) const
	QueryDoubleAttribute examines the attribute - see QueryIntAttribute().
int	QueryFloatAttribute (const char name, float _value) const
	QueryFloatAttribute examines the attribute - see QueryIntAttribute().
void	SetAttribute (const char name, const char _value)
	Sets an attribute of name to a given value.
void	SetAttribute (const char *name, int value)
	Sets an attribute of name to a given value.
void	SetDoubleAttribute (const char *name, double value)
	Sets an attribute of name to a given value.
void	RemoveAttribute (const char *name)
	Deletes an attribute with the given name.
const TiXmlAttribute *	FirstAttribute () const
	Access the first attribute in this element.
TiXmlAttribute *	FirstAttribute ()
const TiXmlAttribute *	LastAttribute () const
	Access the last attribute in this element.
TiXmlAttribute *	LastAttribute ()
const char *	GetText () const
	Convenience function for easy access to the text inside an element.
virtual TiXmlNode *	Clone () const
	Creates a new Element and returns it - the returned element is a copy.
virtual void	Print (FILE *cfile, int depth) const
	All TinyXml classes can print themselves to a filestream or the string class (TiXmlString in non-STL mode, std::string in STL mode.
virtual const char *	Parse (const char p, TiXmlParsingData data, TiXmlEncoding encoding)
virtual const TiXmlElement *	ToElement () const
	Cast to a more defined type. Will return null not of the requested type.
virtual TiXmlElement *	ToElement ()
	Cast to a more defined type. Will return null not of the requested type.
virtual bool	Accept (TiXmlVisitor *visitor) const
	Walk the XML tree visiting this node and all of its children.
const char *	Value () const
	The meaning of 'value' changes for the specific type of TiXmlNode.
const TIXML_STRING &	ValueTStr () const
void	SetValue (const char *_value)
	Changes the value of the node.
void	Clear ()
	Delete all the children of this node. Does not affect 'this'.
TiXmlNode *	Parent ()
	One step up the DOM.
const TiXmlNode *	Parent () const
const TiXmlNode *	FirstChild () const
	The first child of this node. Will be null if there are no children.
TiXmlNode *	FirstChild ()
const TiXmlNode *	FirstChild (const char *value) const
	The first child of this node with the matching 'value'. Will be null if none found. The first child of this node with the matching 'value'. Will be null if none found.
TiXmlNode *	FirstChild (const char *_value)
const TiXmlNode *	LastChild () const
TiXmlNode *	LastChild ()
	The last child of this node. Will be null if there are no children.
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.
const TiXmlNode *	IterateChildren (const TiXmlNode *previous) const
	An alternate way to walk the children of a node.
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'.
TiXmlNode *	IterateChildren (const char _value, const TiXmlNode previous)
TiXmlNode *	InsertEndChild (const TiXmlNode &addThis)
	Add a new node related to this.
TiXmlNode *	LinkEndChild (TiXmlNode *addThis)
	Add a new node related to this.
TiXmlNode *	InsertBeforeChild (TiXmlNode *beforeThis, const TiXmlNode &addThis)
	Add a new node related to this.
TiXmlNode *	InsertAfterChild (TiXmlNode *afterThis, const TiXmlNode &addThis)
	Add a new node related to this.
TiXmlNode *	ReplaceChild (TiXmlNode *replaceThis, const TiXmlNode &withThis)
	Replace a child of this node.
bool	RemoveChild (TiXmlNode *removeThis)
	Delete a child of this node.
const TiXmlNode *	PreviousSibling () const
	Navigate to a sibling node.
TiXmlNode *	PreviousSibling ()
const TiXmlNode *	PreviousSibling (const char *) const
	Navigate to a sibling node.
TiXmlNode *	PreviousSibling (const char *_prev)
const TiXmlNode *	NextSibling () const
	Navigate to a sibling node.
TiXmlNode *	NextSibling ()
const TiXmlNode *	NextSibling (const char *) const
	Navigate to a sibling node with the given 'value'.
TiXmlNode *	NextSibling (const char *_next)
const TiXmlElement *	NextSiblingElement () const
	Convenience function to get through elements.
TiXmlElement *	NextSiblingElement ()
const TiXmlElement *	NextSiblingElement (const char *) const
	Convenience function to get through elements.
TiXmlElement *	NextSiblingElement (const char *_next)
const TiXmlElement *	FirstChildElement () const
	Convenience function to get through elements.
TiXmlElement *	FirstChildElement ()
const TiXmlElement *	FirstChildElement (const char *_value) const
	Convenience function to get through elements.
TiXmlElement *	FirstChildElement (const char *_value)
int	Type () const
	Query the type (as an enumerated value, above) of this node.
const TiXmlDocument *	GetDocument () const
	Return a pointer to the Document this node lives in.
TiXmlDocument *	GetDocument ()
bool	NoChildren () const
	Returns true if this node has no children.
virtual const TiXmlDocument *	ToDocument () const
	Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlDocument *	ToDocument ()
	Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlComment *	ToComment () const
	Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlComment *	ToComment ()
	Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlUnknown *	ToUnknown () const
	Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlUnknown *	ToUnknown ()
	Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlText *	ToText () const
	Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlText *	ToText ()
	Cast to a more defined type. Will return null if not of the requested type.
virtual const TiXmlDeclaration *	ToDeclaration () const
	Cast to a more defined type. Will return null if not of the requested type.
virtual TiXmlDeclaration *	ToDeclaration ()
	Cast to a more defined type. Will return null if not of the requested type.
int	Row () const
	Return the position, in the original source file, of this node or attribute.
int	Column () const
	See Row().
void	SetUserData (void *user)
	Set a pointer to arbitrary user data.
void *	GetUserData ()
	Get a pointer to arbitrary user data.
const void *	GetUserData () const
	Get a pointer to arbitrary user data.
Static Public Member Functions
static void	SetCondenseWhiteSpace (bool condense)
	The world does not agree on whether white space should be kept or not.
static bool	IsWhiteSpaceCondensed ()
	Return the current white space setting.
static void	EncodeString (const TIXML_STRING &str, TIXML_STRING *out)
	Expands entities in a string.
Static Public Attributes
static const int	utf8ByteTable [256]
Protected Member Functions
void	CopyTo (TiXmlElement *target) const
void	ClearThis ()
const char *	ReadValue (const char in, TiXmlParsingData prevData, TiXmlEncoding encoding)
void	CopyTo (TiXmlNode *target) const
TiXmlNode *	Identify (const char *start, TiXmlEncoding encoding)
Static Protected Member Functions
static const char *	SkipWhiteSpace (const char *, TiXmlEncoding encoding)
static bool	IsWhiteSpace (char c)
static bool	IsWhiteSpace (int c)
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
TiXmlNode *	parent
NodeType	type
TiXmlNode *	firstChild
TiXmlNode *	lastChild
TIXML_STRING	value
TiXmlNode *	prev
TiXmlNode *	next
TiXmlCursor	location
void *	userData
	Field containing a generic user pointer.
Static Protected Attributes
static const char *	errorString [TIXML_ERROR_STRING_COUNT]