CzXomlProperty Struct Reference

A basic XOML property. More...

#include <CzXoml.h>

List of all members.

Public Member Functions
	CzXomlProperty ()
	CzXomlProperty (const char *data)
	CzXomlProperty (float data)
	CzXomlProperty (bool data)
	CzXomlProperty (int data)
	CzXomlProperty (const CzVec2 &data)
	CzXomlProperty (const CzIVec2 &data)
	CzXomlProperty (const CzVec3 &data)
	CzXomlProperty (const CzVec4 &data)
	CzXomlProperty (const CzColour &data)
	CzXomlProperty (const CzRect &data)
	CzXomlProperty (const CzIRect &data)
	CzXomlProperty (IzXomlResource *data)
	CzXomlProperty (CzXomlVariable *data)
	CzXomlProperty (void *data)
	~CzXomlProperty ()
bool	setValue (const CzString &data, bool delta)
	Sets the value of the property from a string.
bool	setValue (const CzXomlProperty &prop, bool delta)
	Sets the value of the property from a property.
void	setToVariable (CzXomlVariable &var)
	Sets the property to a variable.
void	toString (CzString &string) const
Static Public Member Functions
static CzXomlProperty *	createOfType (eCzXomlPropertyType type)
	Creates a property of the specified type.
static CzXomlProperty *	createOfType (const char *type_name)
	Creates a property of the specified named type.
Public Attributes
eCzXomlPropertyType	Type
	Type of property.
bool	OwnData
union {
void *   p_data
	Value of property as string or object.
bool   p_bool
	Value of property as a bool.
float   p_float
	Value of property as a float.
int   p_int
	Value of property as an integer.
float   p_vec [4]
	Value of property as a vector.
};
	<If true then the property owns p_data

---

Detailed Description

A basic XOML property.

---

Constructor & Destructor Documentation

CzXomlProperty::CzXomlProperty

(

)

[inline]

CzXomlProperty::CzXomlProperty

(

const char *

data

)

[inline]

CzXomlProperty::CzXomlProperty

(

float

data

)

[inline]

CzXomlProperty::CzXomlProperty

(

bool

data

)

[inline]

CzXomlProperty::CzXomlProperty

(

int

data

)

[inline]

CzXomlProperty::CzXomlProperty

(

const CzVec2 &

data

)

[inline]

CzXomlProperty::CzXomlProperty

(

const CzIVec2 &

data

)

[inline]

CzXomlProperty::CzXomlProperty

(

const CzVec3 &

data

)

[inline]

CzXomlProperty::CzXomlProperty

(

const CzVec4 &

data

)

[inline]

CzXomlProperty::CzXomlProperty

(

const CzColour &

data

)

[inline]

CzXomlProperty::CzXomlProperty

(

const CzRect &

data

)

[inline]

CzXomlProperty::CzXomlProperty

(

const CzIRect &

data

)

[inline]

CzXomlProperty::CzXomlProperty

(

IzXomlResource *

data

)

[inline]

CzXomlProperty::CzXomlProperty

(

CzXomlVariable *

data

)

[inline]

CzXomlProperty::CzXomlProperty

(

void *

data

)

[inline]

CzXomlProperty::~CzXomlProperty

(

)

[inline]

---

Member Function Documentation

CzXomlProperty * CzXomlProperty::createOfType

(

eCzXomlPropertyType

type

)

[static]

Creates a property of the specified type.

Parameters:

type	The property type.

Returns:

The new property.

CzXomlProperty * CzXomlProperty::createOfType

(

const char *

type_name

)

[static]

Creates a property of the specified named type.

Parameters:

type	The property type.

Returns:

The new property.

void CzXomlProperty::setToVariable

(

CzXomlVariable &

var

)

Sets the property to a variable.

Parameters:

[out]

var

The target variable.

bool CzXomlProperty::setValue	(	const CzString &	data,
		bool	delta
	)

Sets the value of the property from a string.

Parameters:

data	The data.
delta	true to add to the property.

Returns:

true if it succeeds, false if it fails.

bool CzXomlProperty::setValue	(	const CzXomlProperty &	data,
		bool	delta
	)

Sets the value of the property from a property.

Parameters:

data	The data.
delta	true to add to the property.

Returns:

true if it succeeds, false if it fails.

void CzXomlProperty::toString

(

CzString &

string

)

const

---

Member Data Documentation

union { ... }

<If true then the property owns p_data

bool CzXomlProperty::OwnData

bool CzXomlProperty::p_bool

Value of property as a bool.

void* CzXomlProperty::p_data

Value of property as string or object.

float CzXomlProperty::p_float

Value of property as a float.

int CzXomlProperty::p_int

Value of property as an integer.

float CzXomlProperty::p_vec[4]

Value of property as a vector.

eCzXomlPropertyType CzXomlProperty::Type

Type of property.

---

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

• CzXoml.h
• CzXoml.cpp