Classes
struct	CzAction
	An action is a command that can be executed from XOML. More...
class	CzActions
	A collection of actions (called an actions list in XOML). More...
class	CzActionsCreator
	CzActionsreator - Creates an instance of an actions object. More...
class	CzActionsManager
	Manages a collection of actions lists. More...
class	CzXomlTimer
	Polled timer. More...
class	CzXomlTimerCreator
	Creates an instance of a Timer object. More...
class	CzTimersManager
	Manager a collection of XOML timers. More...
class	CzUserPropertyList
	A user property list. More...
class	CzUserPropertyListCreator
	Creates an instance of a user properties class. More...
struct	CzXomlProperty
	A basic XOML property. More...
struct	CzXomlNamedProperty
	A basic XOML property that has a name. More...
class	CzXomlClassProperty
	Used by classes definitions to list available properties. More...
class	CzXomlClassDef
	Used by classes to define accessible properties and methods. More...
class	IzXomlClassCreator
	Base class that is used by classes that create an instance of a XOML resource type. More...
class	CzXoml
	The main controller responsible for instantiating objects from XOML based files. More...
class	IzXomlAction
	Base class that is used by classes that create actions that can be executed in XOML. More...
class	IzXomlResource
	Base class that is used by all classes that can be instantiated from XOML markup. More...
class	CzXomlResourceManager
	CzResourceManager manages a collection of resource groups. More...
Defines
#define	CZ_NEW_SINGLE_ACTION(actions, action, name, method)
	A macro that creates an actions list containing a single action with no parameters.
#define	CZ_NEW_SINGLE_ACTION_P1(actions, action, name, method, p1)
	A macro that creates an actions list containing a single action with one parameter.
#define	CZ_NEW_SINGLE_ACTION_P2(actions, action, name, method, p1, p2)
	A macro that creates an actions list containing a single action with two parameters.
#define	CZ_NEW_SINGLE_ACTION_P3(actions, action, name, method, p1, p2, p3)
	A macro that creates an actions list containing a single action with three parameters.
#define	CZ_NEW_SINGLE_ACTION_P4(actions, action, name, method, p1, p2, p3, p4)
	A macro that creates an actions list containing a single action with four parameters.
#define	CZ_NEW_SINGLE_ACTION_P5(actions, action, name, method, p1, p2, p3, p4, p5)
	A macro that creates an actions list containing a single action with five parameters.
#define	CZ_XOML CzXoml::getInstance()
	A short cut macro that calls the global XOML singleton.
Typedefs
typedef bool(*	CzXomPropertySetter )(IzXomlResource *target, const CzXomlProperty &prop, bool add)
	Defines an alias for a XOML class property setter.
typedef CzXomlProperty(*	CzXomPropertyGetter )(IzXomlResource *target)
	Defines an alias for a XOML class property getter.
Enumerations
enum	eCzXomlPropertyType { PT_Invalid, PT_String, PT_Bool, PT_Float, PT_Int, PT_Vec2, PT_Vec3, PT_Vec4, PT_Resource, PT_Var }
	The different types of XOML properties. More...

Define Documentation

#define CZ_NEW_SINGLE_ACTION	(	actions,
		action,
		name,
		method
	)

Value:

CzActions* actions = new CzActions();                       \
    actions->setName(name);                                     \
	CzAction* action = new CzAction();                         \
    action->setMethodName(method);                              \
    actions->addAction(action);

A macro that creates an actions list containing a single action with no parameters.

Parameters:

actions	The actions list variable.
action	The action variable.
name	The actions list name.
method	The method name.

#define CZ_NEW_SINGLE_ACTION_P1	(	actions,
		action,
		name,
		method,
		p1
	)

Value:

CZ_NEW_SINGLE_ACTION(actions, action, name, method)             \
    action->setParameter1(p1);

A macro that creates an actions list containing a single action with one parameter.

Parameters:

actions	The actions list variable.
action	The action variable.
name	The actions list name.
method	The method name.
p1	The first parameter.

#define CZ_NEW_SINGLE_ACTION_P2	(	actions,
		action,
		name,
		method,
		p1,
		p2
	)

Value:

CZ_NEW_SINGLE_ACTION(actions, action, name, method)                 \
    action->setParameter1(p1);                                          \
    action->setParameter2(p2);

A macro that creates an actions list containing a single action with two parameters.

Parameters:

actions	The actions list variable.
action	The action variable.
name	The actions list name.
method	The method name.
p1	The first parameter.
p2	The second parameter.

#define CZ_NEW_SINGLE_ACTION_P3	(	actions,
		action,
		name,
		method,
		p1,
		p2,
		p3
	)

Value:

CZ_NEW_SINGLE_ACTION(actions, action, name, method)                     \
    action->setParameter1(p1);                                              \
    action->setParameter2(p2);                                              \
    action->setParameter3(p3);

A macro that creates an actions list containing a single action with three parameters.

Parameters:

actions	The actions list variable.
action	The action variable.
name	The actions list name.
method	The method name.
p1	The first parameter.
p2	The second parameter.
p3	The third parameter.

#define CZ_NEW_SINGLE_ACTION_P4	(	actions,
		action,
		name,
		method,
		p1,
		p2,
		p3,
		p4
	)

Value:

CZ_NEW_SINGLE_ACTION(actions, action, name, method)                         \
    action->setParameter1(p1);                                                  \
    action->setParameter2(p2);                                                  \
    action->setParameter3(p3);                                                  \
    action->setParameter4(p4);

A macro that creates an actions list containing a single action with four parameters.

Parameters:

actions	The actions list variable.
action	The action variable.
name	The actions list name.
method	The method name.
p1	The first parameter.
p2	The second parameter.
p3	The third parameter.
p4	The fourth parameter.

#define CZ_NEW_SINGLE_ACTION_P5	(	actions,
		action,
		name,
		method,
		p1,
		p2,
		p3,
		p4,
		p5
	)

Value:

CZ_NEW_SINGLE_ACTION(actions, action, name, method)                             \
    action->setParameter1(p1);                                                      \
    action->setParameter2(p2);                                                      \
    action->setParameter3(p3);                                                      \
    action->setParameter4(p4);                                                      \
    action->setParameter5(p5);

A macro that creates an actions list containing a single action with five parameters.

Parameters:

actions	The actions list variable.
action	The action variable.
name	The actions list name.
method	The method name.
p1	The first parameter.
p2	The second parameter.
p3	The third parameter.
p4	The fourth parameter.
p5	The fifth parameter.

#define CZ_XOML CzXoml::getInstance()

A short cut macro that calls the global XOML singleton.

Typedef Documentation

CzXomlProperty(* CzXomPropertyGetter)(IzXomlResource *target, const CzXomlProperty &prop)

Defines an alias for a XOML class property getter.

bool(* CzXomPropertySetter)(IzXomlResource *target, const CzXomlProperty &prop, bool add)

Defines an alias for a XOML class property setter.

Enumeration Type Documentation

enum eCzXomlPropertyType

The different types of XOML properties.

Enumerator:

PT_Invalid
PT_String
PT_Bool
PT_Float
PT_Int
PT_Vec2
PT_Vec3
PT_Vec4
PT_Resource
PT_Var

Classes

Defines

Typedefs

Enumerations

Define Documentation

Typedef Documentation

Enumeration Type Documentation