CzXmlAttribute Struct Reference

An Xml attribute, e.g. <Something attribute="some value"> More...

#include <CzXml.h>

List of all members.

Public Member Functions
	CzXmlAttribute ()
virtual	~CzXmlAttribute ()
void	Clear ()
void	setName (const char *pName)
void	setName (char *pName, int len)
CzString &	getName ()
	Gets the name of the attribute.
void	setValue (const char *pValue)
void	setValue (char *pValue, int len)
CzString &	getValue ()
	Gets the value of the attribute.
int	getValueAsInt () const
	Gets the value of the attribute as an integer.
float	getValueAsFloat () const
	Gets the value of the attribute as a floating point number.
bool	getValueAsBool () const
	Gets the value of the attribute as a boolean.
bool	getValueAsPoint (CzVec2 &point)
	Gets the value of the attribute as a vec2.
bool	getValueAsPoint3 (CzVec3 &point, float default_y=0, float default_z=0)
	Gets the value of the attribute as a vec3 (if less than 3 values are found then rest will be assigned 0)
bool	getValueAsPoint3Copy (CzVec3 &point)
	Gets the value of the attribute as a vec3 (if less than 3 values are found then rest will be assigned the first value)
bool	getValueAsPoint4 (CzVec4 &point)
	Gets the value of the attribute as a vec4.
bool	getValueAsColour (CzColour &colour)
	Gets the value of the attribute as a colour.
bool	getValueAsRect (CzIRect &rect)
	Gets the value of the attribute as a rect.
CzStringList *	getValueAsList ()
	Gets the value of the attribute as a list of strings.
Public Attributes
bool	Managed
	Managec attributes are managed by the pools system and should not be deleted.
CzString	Name
	Attributes name.
CzString	Value
	Attributes value.

---

Detailed Description

An Xml attribute, e.g. <Something attribute="some value">

---

Constructor & Destructor Documentation

CzXmlAttribute::CzXmlAttribute

(

)

[inline]

virtual CzXmlAttribute::~CzXmlAttribute

(

)

[inline, virtual]

---

Member Function Documentation

void CzXmlAttribute::Clear

(

)

[inline]

CzString& CzXmlAttribute::getName

(

)

[inline]

Gets the name of the attribute.

CzString& CzXmlAttribute::getValue

(

)

[inline]

Gets the value of the attribute.

bool CzXmlAttribute::getValueAsBool

(

)

const

Gets the value of the attribute as a boolean.

bool CzXmlAttribute::getValueAsColour

(

CzColour &

colour

)

Gets the value of the attribute as a colour.

float CzXmlAttribute::getValueAsFloat

(

)

const

Gets the value of the attribute as a floating point number.

int CzXmlAttribute::getValueAsInt

(

)

const

Gets the value of the attribute as an integer.

CzStringList * CzXmlAttribute::getValueAsList

(

)

Gets the value of the attribute as a list of strings.

bool CzXmlAttribute::getValueAsPoint

(

CzVec2 &

point

)

Gets the value of the attribute as a vec2.

bool CzXmlAttribute::getValueAsPoint3	(	CzVec3 &	point,
		float	default_y = 0,
		float	default_z = 0
	)

Gets the value of the attribute as a vec3 (if less than 3 values are found then rest will be assigned 0)

bool CzXmlAttribute::getValueAsPoint3Copy

(

CzVec3 &

point

)

Gets the value of the attribute as a vec3 (if less than 3 values are found then rest will be assigned the first value)

bool CzXmlAttribute::getValueAsPoint4

(

CzVec4 &

point

)

Gets the value of the attribute as a vec4.

bool CzXmlAttribute::getValueAsRect

(

CzIRect &

rect

)

Gets the value of the attribute as a rect.

void CzXmlAttribute::setName

(

const char *

pName

)

[inline]

Parameters:

pName

Sets the name of the attribute

void CzXmlAttribute::setName	(	char *	pName,
		int	len
	)		[inline]

Parameters:

len	Sets the name of the attribute

void CzXmlAttribute::setValue

(

const char *

pValue

)

[inline]

Parameters:

pValue

Sets the value of the attribute

void CzXmlAttribute::setValue	(	char *	pValue,
		int	len
	)		[inline]

Parameters:

len	Sets the value of the attribute

---

Member Data Documentation

bool CzXmlAttribute::Managed

Managec attributes are managed by the pools system and should not be deleted.

CzString CzXmlAttribute::Name

Attributes name.

CzString CzXmlAttribute::Value

Attributes value.

---

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

• CzXml.h
• CzXml.cpp