#include <tinyxml.h>

Inheritance diagram for TiXmlAttribute:

Collaboration diagram for TiXmlAttribute:

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)

Public Member Functions inherited from TiXmlBase
	TiXmlBase ()

virtual	~TiXmlBase ()

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

Friends
class	TiXmlAttributeSet

Additional Inherited Members
Public Types inherited from TiXmlBase
enum	{ TIXML_NO_ERROR = 0, 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 }

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

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.

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

double TiXmlAttribute::DoubleValue ( ) const

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

int TiXmlAttribute::IntValue ( ) const

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

const char* TiXmlAttribute::Name ( ) const

inline

Return the name of this attribute.

Referenced by TiXmlAttributeSet::Add(), TiXmlElement::CopyTo(), and TiXmlElement::Parse().

const TIXML_STRING& TiXmlAttribute::NameTStr ( ) const

inline

Referenced by TiXmlElement::Parse().

const TiXmlAttribute * TiXmlAttribute::Next ( ) const

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

Referenced by TiXmlElement::CopyTo(), TiXmlElement::Print(), and TiXmlPrinter::VisitEnter().

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

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

virtual

Implements TiXmlBase.

References TiXmlBase::IsWhiteSpace(), TiXmlBase::location, TiXmlBase::ReadName(), TiXmlBase::ReadText(), TiXmlDocument::SetError(), TiXmlBase::SkipWhiteSpace(), TiXmlBase::TIXML_ERROR_READING_ATTRIBUTES, and TiXmlNode::value.

Referenced by TiXmlElement::Parse(), and TiXmlDeclaration::Parse().

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

References TiXmlBase::EncodeString(), and TIXML_STRING.

int TiXmlAttribute::QueryDoubleValue ( double * _value ) const

QueryDoubleValue examines the value string. See QueryIntValue().

References TIXML_SSCANF, TIXML_SUCCESS, and TIXML_WRONG_TYPE.

Referenced by TiXmlElement::QueryDoubleAttribute().

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.

References TIXML_SSCANF, TIXML_SUCCESS, and TIXML_WRONG_TYPE.

Referenced by TiXmlElement::QueryIntAttribute().

void TiXmlAttribute::SetDocument ( TiXmlDocument * doc )

inline

Referenced by TiXmlElement::Parse().

void TiXmlAttribute::SetDoubleValue ( double _value )

Set the value from a double.

References SetValue().

void TiXmlAttribute::SetIntValue ( int _value )

Set the value from an integer.

References SetValue().