TiXmlAttribute Class Reference
[XML objects]

#include <TinyXML.h>

Inherits TiXmlBase.

---

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.

Public Member Functions
	TiXmlAttribute ()
	Construct an empty attribute.
	TiXmlAttribute (const char *_name, const char *_value)
	Construct an attribute with a name and value.
const char *	Name () const
	Return the name of this attribute.
const char *	Value () const
	Return the value of this attribute.
const int	IntValue () const
	Return the value of this attribute, converted to an integer.
const double	DoubleValue () const
	Return the value of this attribute, converted to a double.
int	QueryIntValue (int *value) const
	QueryIntValue examines the value string.
int	QueryDoubleValue (double *value) const
	QueryDoubleValue examines the value string. See QueryIntValue().
void	SetName (const char *_name)
	Set the name of this attribute.
void	SetValue (const char *_value)
	Set the value.
void	SetIntValue (int value)
	Set the value from an integer.
void	SetDoubleValue (double value)
	Set the value from a double.
TiXmlAttribute *	Next () const
	Get the next sibling attribute in the DOM. Returns null at end.
TiXmlAttribute *	Previous () const
	Get the previous sibling attribute in the DOM. Returns null at beginning.
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)
virtual void	Print (FILE *cfile, int depth) const
	All TinyXml classes can print themselves to a filestream.
virtual void	StreamOut (TiXmlOutStream *out) const
void	SetDocument (TiXmlDocument *doc)
Private Member Functions
	TiXmlAttribute (const TiXmlAttribute &)
void	operator= (const TiXmlAttribute &base)
Private Attributes
TiXmlDocument *	document
TiXmlString	name
TiXmlString	value
TiXmlAttribute *	prev
TiXmlAttribute *	next
Friends
class	TiXmlAttributeSet

---

Constructor & Destructor Documentation

TiXmlAttribute::TiXmlAttribute

(

)

[inline]

Construct an empty attribute.

TiXmlAttribute::TiXmlAttribute	(	const char *	_name,
		const char *	_value
	)			[inline]

Construct an attribute with a name and value.

TiXmlAttribute::TiXmlAttribute

(

const TiXmlAttribute &

)

[private]

---

Member Function Documentation

const char* TiXmlAttribute::Name

(

)

const [inline]

Return the name of this attribute.

const char* TiXmlAttribute::Value

(

)

const [inline]

Return the value of this attribute.

const int TiXmlAttribute::IntValue

(

)

const

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

const double TiXmlAttribute::DoubleValue

(

)

const

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

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.

int TiXmlAttribute::QueryDoubleValue

(

double *

value

)

const

QueryDoubleValue examines the value string. See QueryIntValue().

void TiXmlAttribute::SetName

(

const char *

_name

)

[inline]

Set the name of this attribute.

void TiXmlAttribute::SetValue

(

const char *

_value

)

[inline]

Set the value.

void TiXmlAttribute::SetIntValue

(

int

value

)

Set the value from an integer.

void TiXmlAttribute::SetDoubleValue

(

double

value

)

Set the value from a double.

TiXmlAttribute* TiXmlAttribute::Next

(

)

const

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

TiXmlAttribute* TiXmlAttribute::Previous

(

)

const

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

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
	)			[virtual]

Implements TiXmlBase.

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

All TinyXml classes can print themselves to a filestream.

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

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

Implements TiXmlBase.

virtual void TiXmlAttribute::StreamOut

(

TiXmlOutStream *

out

)

const [virtual]

Implements TiXmlBase.

void TiXmlAttribute::SetDocument

(

TiXmlDocument *

doc

)

[inline]

void TiXmlAttribute::operator=

(

const TiXmlAttribute &

base

)

[private]

---

Friends And Related Function Documentation

friend class TiXmlAttributeSet [friend]

---

Field Documentation

TiXmlDocument* TiXmlAttribute::document [private]

Referenced by SetDocument(), and TiXmlAttribute().

TiXmlString TiXmlAttribute::name [private]

Referenced by Name(), operator<(), operator==(), operator>(), SetName(), and TiXmlAttribute().

TiXmlString TiXmlAttribute::value [private]

Referenced by SetValue(), TiXmlAttribute(), and Value().

TiXmlAttribute* TiXmlAttribute::prev [private]

Referenced by TiXmlAttributeSet::Last(), and TiXmlAttribute().

TiXmlAttribute* TiXmlAttribute::next [private]

Referenced by TiXmlAttributeSet::First(), and TiXmlAttribute().

---

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

• Common/TinyXML/TinyXML.h