#include <tinyxml.h>

Inheritance diagram for TiXmlAttribute:

Public Types
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 }

Public Member Functions
	TiXmlAttribute ()
	Construct an empty attribute. More...

	TiXmlAttribute (const std::string &_name, const std::string &_value)
	std::string constructor. More...

	TiXmlAttribute (const char _name, const char _value)
	Construct an attribute with a name and value. More...

const char *	Name () const
	Return the name of this attribute. More...

const char *	Value () const
	Return the value of this attribute. More...

const std::string &	ValueStr () const
	Return the value of this attribute. More...

int	IntValue () const
	Return the value of this attribute, converted to an integer. More...

double	DoubleValue () const
	Return the value of this attribute, converted to a double. More...

const TIXML_STRING &	NameTStr () const

int	QueryIntValue (int *_value) const

int	QueryDoubleValue (double *_value) const
	QueryDoubleValue examines the value string. See QueryIntValue(). More...

void	SetName (const char *_name)
	Set the name of this attribute. More...

void	SetValue (const char *_value)
	Set the value. More...

void	SetIntValue (int _value)
	Set the value from an integer. More...

void	SetDoubleValue (double _value)
	Set the value from a double. More...

void	SetName (const std::string &_name)
	STL std::string form. More...

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

const TiXmlAttribute *	Next () const
	Get the next sibling attribute in the DOM. Returns null at end. More...

TiXmlAttribute *	Next ()

const TiXmlAttribute *	Previous () const
	Get the previous sibling attribute in the DOM. Returns null at beginning. More...

TiXmlAttribute *	Previous ()

bool	operator== (const TiXmlAttribute &rhs) const

bool	operator< (const TiXmlAttribute &rhs) const

bool	operator> (const TiXmlAttribute &rhs) const

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

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

void	Print (FILE cfile, int depth, TIXML_STRING str) const

void	SetDocument (TiXmlDocument *doc)

int	Row () const

int	Column () const
	See Row() More...

void	SetUserData (void *user)
	Set a pointer to arbitrary user data. More...

void *	GetUserData ()
	Get a pointer to arbitrary user data. More...

const void *	GetUserData () const
	Get a pointer to arbitrary user data. More...

Static Public Member Functions
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
static const int	utf8ByteTable [256]

Static Protected Member Functions
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
TiXmlCursor	location

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

Static Protected Attributes
static const char *	errorString [TIXML_ERROR_STRING_COUNT]

Friends
class	TiXmlAttributeSet

Detailed Description

An attribute is a name-value pair. Elements have an arbitrary number of attributes, each with a unique name.

Note: The attributes are not TiXmlNodes, since they are not part of the tinyXML document object model. There are other suggested ways to look at this problem.

Member Enumeration Documentation

anonymous enum

inherited

Enumerator
TIXML_NO_ERROR
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

Constructor & Destructor Documentation

TiXmlAttribute::TiXmlAttribute ( )

inline

Construct an empty attribute.

TiXmlAttribute::TiXmlAttribute	(	const std::string &	_name,
		const std::string &	_value
	)

inline

std::string constructor.

TiXmlAttribute::TiXmlAttribute	(	const char *	_name,
		const char *	_value
	)

inline

Construct an attribute with a name and value.

Member Function Documentation

int TiXmlBase::Column ( ) const

inlineinherited

See Row()

References TiXmlCursor::col, and TiXmlBase::location.

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

staticprotectedinherited

double TiXmlAttribute::DoubleValue ( ) const

Return the value of this attribute, converted to a double.

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

staticinherited

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

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

inlinestaticprotectedinherited

References TiXmlBase::GetEntity(), and TIXML_ENCODING_UTF8.

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

staticprotectedinherited

Referenced by TiXmlBase::GetChar().

void* TiXmlBase::GetUserData ( )

inlineinherited

Get a pointer to arbitrary user data.

References TiXmlBase::userData.

const void* TiXmlBase::GetUserData ( ) const

inlineinherited

Get a pointer to arbitrary user data.

References TiXmlBase::userData.

int TiXmlAttribute::IntValue ( ) const

Return the value of this attribute, converted to an integer.

static int TiXmlBase::IsAlpha	(	unsigned char	anyByte,
		TiXmlEncoding	encoding
	)

staticprotectedinherited

static int TiXmlBase::IsAlphaNum	(	unsigned char	anyByte,
		TiXmlEncoding	encoding
	)

staticprotectedinherited

static bool TiXmlBase::IsWhiteSpace ( char c )

inlinestaticprotectedinherited

Referenced by TiXmlBase::IsWhiteSpace().

static bool TiXmlBase::IsWhiteSpace ( int c )

inlinestaticprotectedinherited

References TiXmlBase::IsWhiteSpace().

static bool TiXmlBase::IsWhiteSpaceCondensed ( )

inlinestaticinherited

Return the current white space setting.

const char* TiXmlAttribute::Name ( ) const

inline

Return the name of this attribute.

const TIXML_STRING& TiXmlAttribute::NameTStr ( ) const

inline

const TiXmlAttribute* TiXmlAttribute::Next ( ) const

Get the next sibling attribute in the DOM. Returns null at end.

TiXmlAttribute* TiXmlAttribute::Next ( )

inline

bool TiXmlAttribute::operator< ( const TiXmlAttribute & rhs ) const

inline

bool TiXmlAttribute::operator== ( const TiXmlAttribute & rhs ) const

inline

bool TiXmlAttribute::operator> ( const TiXmlAttribute & rhs ) const

inline

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

virtual

Implements TiXmlBase.

const TiXmlAttribute* TiXmlAttribute::Previous ( ) const

Get the previous sibling attribute in the DOM. Returns null at beginning.

TiXmlAttribute* TiXmlAttribute::Previous ( )

inline

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

inlinevirtual

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.

void TiXmlAttribute::Print	(	FILE *	cfile,
		int	depth,
		TIXML_STRING *	str
	)		const

int TiXmlAttribute::QueryDoubleValue ( double * _value ) const

QueryDoubleValue examines the value string. See QueryIntValue().

int TiXmlAttribute::QueryIntValue ( int * _value ) const

QueryIntValue examines the value string. It is an alternative to the IntValue() method with richer error checking. If the value 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.

A specialized but useful call. Note that for success it returns 0, which is the opposite of almost all other TinyXml calls.

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

staticprotectedinherited

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

staticprotectedinherited

int TiXmlBase::Row ( ) const

inlineinherited

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

References TiXmlBase::location, and TiXmlCursor::row.

static void TiXmlBase::SetCondenseWhiteSpace ( bool condense )

inlinestaticinherited

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 TiXmlAttribute::SetDocument ( TiXmlDocument * doc )

inline

void TiXmlAttribute::SetDoubleValue ( double _value )

Set the value from a double.

void TiXmlAttribute::SetIntValue ( int _value )

Set the value from an integer.

void TiXmlAttribute::SetName ( const char * _name )

inline

Set the name of this attribute.

void TiXmlAttribute::SetName ( const std::string & _name )

inline

STL std::string form.

void TiXmlBase::SetUserData ( void * user )

inlineinherited

Set a pointer to arbitrary user data.

References TiXmlBase::userData.

void TiXmlAttribute::SetValue ( const char * _value )

inline

Set the value.

void TiXmlAttribute::SetValue ( const std::string & _value )

inline

STL std::string form.

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

staticprotectedinherited

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

staticprotectedinherited

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

staticprotectedinherited

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

staticprotectedinherited

static int TiXmlBase::ToLower	(	int	v,
		TiXmlEncoding	encoding
	)

inlinestaticprotectedinherited

References TIXML_ENCODING_UTF8.

const char* TiXmlAttribute::Value ( ) const

inline

Return the value of this attribute.

const std::string& TiXmlAttribute::ValueStr ( ) const

inline

Return the value of this attribute.

Referenced by TiXmlElement::QueryValueAttribute().

Friends And Related Function Documentation

friend class TiXmlAttributeSet

friend

Member Data Documentation

const char* TiXmlBase::errorString[TIXML_ERROR_STRING_COUNT]

staticprotectedinherited

TiXmlCursor TiXmlBase::location

protectedinherited

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

void* TiXmlBase::userData

protectedinherited

Field containing a generic user pointer.

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

const int TiXmlBase::utf8ByteTable[256]

staticinherited

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

tinyxml.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation