dtGUI::BaseScriptModule Class Reference

An abstract interface for classes used by CEUIDrawable. More...

#include <basescriptmodule.h>

Inheritance diagram for dtGUI::BaseScriptModule:

List of all members.

Public Member Functions
	BaseScriptModule ()
virtual	~BaseScriptModule ()
virtual void	executeScriptFile (const CEGUI::String &filename, const CEGUI::String &resourceGroup="")=0
virtual int	executeScriptGlobal (const CEGUI::String &function_name)=0
virtual void	executeString (const CEGUI::String &str)=0
virtual bool	executeScriptedEventHandler (const CEGUI::String &handlerName, const CEGUI::EventArgs &ea)=0
	Overload this function to handle Events triggered from a CEGUI::Window.

---

Detailed Description

An abstract interface for classes used by CEUIDrawable.

BaseScriptModule is mean to be implemented to provide support for Events triggered by the CEGUI Windows in a GUI scene.

See also:

dtGUI::ScriptModule.

---

Constructor & Destructor Documentation

dtGUI::BaseScriptModule::BaseScriptModule

(

)

[inline]

virtual dtGUI::BaseScriptModule::~BaseScriptModule

(

)

[inline, virtual]

---

Member Function Documentation

virtual void dtGUI::BaseScriptModule::executeScriptFile	(	const CEGUI::String &	filename,
		const CEGUI::String &	resourceGroup = ""
	)			[pure virtual]

Implemented in dtGUI::ScriptModule.

virtual int dtGUI::BaseScriptModule::executeScriptGlobal

(

const CEGUI::String &

function_name

)

[pure virtual]

Implemented in dtGUI::ScriptModule.

virtual void dtGUI::BaseScriptModule::executeString

(

const CEGUI::String &

str

)

[pure virtual]

Implemented in dtGUI::ScriptModule.

virtual bool dtGUI::BaseScriptModule::executeScriptedEventHandler	(	const CEGUI::String &	handlerName,
		const CEGUI::EventArgs &	ea
	)			[pure virtual]

Overload this function to handle Events triggered from a CEGUI::Window.

Parameters:

	handlerName	the name of something to handle this event, typically a function name.
	ea	the CEGUI::EventArgs that can contain useful information about the CEGUI::Event that occurred.

Implemented in dtGUI::ScriptModule.

---