Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

CEGUI::ScriptModule Class Reference

Abstract interface required for all scripting support modules to be used with the CEGUI system. More...

#include <CEGUIScriptModule.h>

List of all members.

Public Member Functions

 ScriptModule (void)
 Constructor for ScriptModule base class.
virtual ~ScriptModule (void)
 Destructor for ScriptModule base class.
virtual void executeScriptFile (const String &filename)=0
 Execute a script file.
virtual int executeScriptGloabl (const String &function_name)=0
 Execute a scripted global function. The function should not take any parameters and should return an integer.
virtual bool executeScriptedEventHandler (const String &handler_name, const EventArgs &e)=0
 Execute a scripted global 'event handler' function. The function should take some kind of EventArgs like parameter that the concrete implementation of this function can create from the passed EventArgs based object. The function should not return anything.


Detailed Description

Abstract interface required for all scripting support modules to be used with the CEGUI system.

Definition at line 42 of file CEGUIScriptModule.h.


Constructor & Destructor Documentation

CEGUI::ScriptModule::ScriptModule void   )  [inline]
 

Constructor for ScriptModule base class.

Definition at line 52 of file CEGUIScriptModule.h.

virtual CEGUI::ScriptModule::~ScriptModule void   )  [inline, virtual]
 

Destructor for ScriptModule base class.

Definition at line 59 of file CEGUIScriptModule.h.


Member Function Documentation

virtual bool CEGUI::ScriptModule::executeScriptedEventHandler const String handler_name,
const EventArgs e
[pure virtual]
 

Execute a scripted global 'event handler' function. The function should take some kind of EventArgs like parameter that the concrete implementation of this function can create from the passed EventArgs based object. The function should not return anything.

Parameters:
handler_name String object holding the name of the scripted handler function.
e EventArgs based object that should be passed, by any appropriate means, to the scripted function.
Returns:
  • true if the event was handled.
  • false if the event was not handled.

Referenced by CEGUI::ScriptFunctor::operator()().

virtual void CEGUI::ScriptModule::executeScriptFile const String filename  )  [pure virtual]
 

Execute a script file.

Parameters:
filename String object holding the filename of the script file that is to be executed

Referenced by CEGUI::System::executeScriptFile().

virtual int CEGUI::ScriptModule::executeScriptGloabl const String function_name  )  [pure virtual]
 

Execute a scripted global function. The function should not take any parameters and should return an integer.

Parameters:
function_name String object holding the name of the function, in the global script environment, that is to be executed.
Returns:
The integer value returned from the script function.

Referenced by CEGUI::System::executeScriptGloabl().


The documentation for this class was generated from the following file:
Generated on Wed Feb 16 12:41:11 2005 for Crazy Eddies GUI System by  doxygen 1.3.9.1