Crazy Eddie's GUI System  ${CEGUI_VERSION}
ScriptModule_wrapper Struct Reference
+ Inheritance diagram for ScriptModule_wrapper:
+ Collaboration diagram for ScriptModule_wrapper:

Public Member Functions

virtual void createBindings ()
 Method called during system initialisation, prior to running any scripts via the ScriptModule, to enable the ScriptModule to perform any operations required to complete initialisation or binding of the script language to the gui system objects. More...
 
void default_createBindings ()
 
virtual void destroyBindings ()
 Method called during system destruction, after all scripts have been run via the ScriptModule, to enable the ScriptModule to perform any operations required to cleanup bindings of the script language to the gui system objects, as set-up in the earlier createBindings call. More...
 
void default_destroyBindings ()
 
virtual void executeScriptFile (::CEGUI::String const &filename, ::CEGUI::String const &resourceGroup="")
 
virtual int executeScriptGlobal (::CEGUI::String const &function_name)
 
virtual bool executeScriptedEventHandler (::CEGUI::String const &handler_name, ::CEGUI::EventArgs const &e)
 
virtual void executeString (::CEGUI::String const &str)
 
virtual ::CEGUI::RefCounted< CEGUI::BoundSlotsubscribeEvent (::CEGUI::EventSet *target, ::CEGUI::String const &name, ::CEGUI::String const &subscriber_name)
 
virtual ::CEGUI::RefCounted< CEGUI::BoundSlotsubscribeEvent (::CEGUI::EventSet *target, ::CEGUI::String const &name, unsigned int group, ::CEGUI::String const &subscriber_name)
 
- Public Member Functions inherited from CEGUI::ScriptModule
 ScriptModule (void)
 Constructor for ScriptModule base class.
 
virtual ~ScriptModule (void)
 Destructor for ScriptModule base class.
 
virtual void executeScriptFile (const String &filename, const String &resourceGroup="")=0
 Execute a script file. More...
 
virtual int executeScriptGlobal (const String &function_name)=0
 Execute a scripted global function. The function should not take any parameters and should return an integer. More...
 
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. More...
 
virtual void executeString (const String &str)=0
 Execute script code contained in the given CEGUI::String object. More...
 
const StringgetIdentifierString () const
 Return identification string for the ScriptModule. If the internal id string has not been set by the ScriptModule creator, a generic string of "Unknown scripting module" will be returned. More...
 
virtual Event::Connection subscribeEvent (EventSet *target, const String &name, const String &subscriber_name)=0
 Subscribes the named Event to a scripted funtion. More...
 
virtual Event::Connection subscribeEvent (EventSet *target, const String &name, Event::Group group, const String &subscriber_name)=0
 Subscribes the specified group of the named Event to a scripted funtion. More...
 
 ScriptModule (void)
 Constructor for ScriptModule base class.
 
virtual ~ScriptModule (void)
 Destructor for ScriptModule base class.
 
virtual void executeScriptFile (const String &filename, const String &resourceGroup="")=0
 Execute a script file. More...
 
virtual int executeScriptGlobal (const String &function_name)=0
 Execute a scripted global function. The function should not take any parameters and should return an integer. More...
 
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. More...
 
virtual void executeString (const String &str)=0
 Execute script code contained in the given CEGUI::String object. More...
 
const StringgetIdentifierString () const
 Return identification string for the ScriptModule. If the internal id string has not been set by the ScriptModule creator, a generic string of "Unknown scripting module" will be returned. More...
 
virtual Event::Connection subscribeEvent (EventSet *target, const String &name, const String &subscriber_name)=0
 Subscribes the named Event to a scripted funtion. More...
 
virtual Event::Connection subscribeEvent (EventSet *target, const String &name, Event::Group group, const String &subscriber_name)=0
 Subscribes the specified group of the named Event to a scripted funtion. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from CEGUI::ScriptModule
static void setDefaultResourceGroup (const String &resourceGroup)
 Sets the default resource group to be used when loading script files. More...
 
static const StringgetDefaultResourceGroup ()
 Returns the default resource group used when loading script files. More...
 
static void setDefaultResourceGroup (const String &resourceGroup)
 Sets the default resource group to be used when loading script files. More...
 
static const StringgetDefaultResourceGroup ()
 Returns the default resource group used when loading script files. More...
 
- Protected Attributes inherited from CEGUI::ScriptModule
String d_identifierString
 String that holds some id information about the module.
 
- Static Protected Attributes inherited from CEGUI::ScriptModule
static String d_defaultResourceGroup
 holds the default resource group ID for loading script files.
 

Member Function Documentation

§ createBindings()

virtual void ScriptModule_wrapper::createBindings ( void  )
inlinevirtual

Method called during system initialisation, prior to running any scripts via the ScriptModule, to enable the ScriptModule to perform any operations required to complete initialisation or binding of the script language to the gui system objects.

Returns
Nothing.

Reimplemented from CEGUI::ScriptModule.

References CEGUI::ScriptModule::createBindings().

§ destroyBindings()

virtual void ScriptModule_wrapper::destroyBindings ( void  )
inlinevirtual

Method called during system destruction, after all scripts have been run via the ScriptModule, to enable the ScriptModule to perform any operations required to cleanup bindings of the script language to the gui system objects, as set-up in the earlier createBindings call.

Returns
Nothing.

Reimplemented from CEGUI::ScriptModule.

References CEGUI::ScriptModule::createBindings(), CEGUI::ScriptModule::destroyBindings(), CEGUI::ScriptModule::executeScriptedEventHandler(), CEGUI::ScriptModule::executeScriptFile(), CEGUI::ScriptModule::executeScriptGlobal(), CEGUI::ScriptModule::executeString(), CEGUI::ScriptModule::getDefaultResourceGroup(), CEGUI::ScriptModule::getIdentifierString(), CEGUI::ScriptModule::setDefaultResourceGroup(), and CEGUI::ScriptModule::subscribeEvent().