CzXomlActions_Sys Class Reference

Implements actions that are system related. More...

#include <CzActionsSys.h>

Inheritance diagram for CzXomlActions_Sys:

List of all members.

Public Types
enum	eActionType {   Action_LoadXOML = 0, Action_FromTemplate = 1, Action_Launch = 2, Action_SetBGColour = 3,   Action_EnterValue = 4, Action_Exit = 5, Action_DebugText = 6, Action_LoadFile = 7,   Action_PauseTime = 8, Action_Max = 9 }
Public Member Functions
	CzXomlActions_Sys (eActionType type)
void	Execute (IzXomlResource *source, CzAction *action)
	The main actions executor for system related actions. All system specific actions such as LoadXOML are implemented by this method.
Protected Member Functions
	CzXomlActions_Sys ()
Protected Attributes
eActionType	Type

---

Detailed Description

Implements actions that are system related.

The CzXomlActions_Sys class holds Actions (IzXomlAction) that deal with system related functionality such as LoadXOML

The following actions are supported:

• LoadXOML
• FromTemplate
• Launch
• SetBGColour
• EnterValue
• Exit
• DebugText
• LoadFile
• PauseTime

The above actions have the following XOML prototypes:

• LoadXOML(file-name, scene-name)
  • file-name - Name of XOML file to load
  • scene-name - Name of scene to load XOML data into, if not supplied then XOML is loaded globally (default)
• FromTemplate(template-name, template-parameters, scene-name)
  • template-name - Name of template to instantiate
  • template-parameters - Parameters to pass to the template (p1=val1:p2=val2:p3=val3 etc)
  • scene-name - Scene where template should be instantiated (optional)
• Launch(url)
  • url - URL to launch. The system interprets what should be ran from the protocol name and file name extension. For example passing “mailto:” will send an email, whilst passing “http:” will launch a web page etc..
• SetBGColour(colour)
  • colour - Background colour in r, g, b, a format
• EnterValue(message, target-variable, default-text)
  • message - Message to show to the user
  • target-variable- Variable to place entered text into
  • default-text - Default text, if you want to replace the variables value as the default text that is shown to the user
• Exit()
• DebugText(text, variable-name)
  • text - Text to output
  • variable-name - Variable value to output
• LoadFile(file-resource-name, blocking, new-filename, scene-name)
  • file-resource-name - Name of file resource
  • blocking - If true then execution will pause until file is loaded
  • new-filename - New file name (optional). If new file name is supplied then the new file will be loaded into the file resource
  • scene-name - Scene in which file resource lives (optional)
• PauseTime(pause-state)
  • pause-state - Pause or un-pause apps time progression

---

Member Enumeration Documentation

enum CzXomlActions_Sys::eActionType

Enumerator:

Action_LoadXOML
Action_FromTemplate
Action_Launch
Action_SetBGColour
Action_EnterValue
Action_Exit
Action_DebugText
Action_LoadFile
Action_PauseTime
Action_Max

---

Constructor & Destructor Documentation

CzXomlActions_Sys::CzXomlActions_Sys

(

)

[inline, protected]

CzXomlActions_Sys::CzXomlActions_Sys

(

eActionType

type

)

[inline]

---

Member Function Documentation

void CzXomlActions_Sys::Execute	(	IzXomlResource *	source,
		CzAction *	action
	)		[virtual]

The main actions executor for system related actions. All system specific actions such as LoadXOML are implemented by this method.

Parameters:

[in]	source	- The source of the action
[in]	action	- The action to execute

Implements IzXomlAction.

---

Member Data Documentation

eActionType CzXomlActions_Sys::Type [protected]

---

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

• CzActionsSys.h
• CzActionsSys.cpp