CEGUIScriptModule.h

00001 /************************************************************************
00002         filename:       CEGUIScriptModule.h
00003         created:        16/7/2004
00004         author:         Paul D Turner
00005 
00006         purpose:        Abstract class interface for scripting support
00007 *************************************************************************/
00008 /*************************************************************************
00009     Crazy Eddie's GUI System (http://www.cegui.org.uk)
00010     Copyright (C)2004 - 2005 Paul D Turner (paul@cegui.org.uk)
00011 
00012     This library is free software; you can redistribute it and/or
00013     modify it under the terms of the GNU Lesser General Public
00014     License as published by the Free Software Foundation; either
00015     version 2.1 of the License, or (at your option) any later version.
00016 
00017     This library is distributed in the hope that it will be useful,
00018     but WITHOUT ANY WARRANTY; without even the implied warranty of
00019     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00020     Lesser General Public License for more details.
00021 
00022     You should have received a copy of the GNU Lesser General Public
00023     License along with this library; if not, write to the Free Software
00024     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00025 *************************************************************************/
00026 #ifndef _CEGUIScriptModule_h_
00027 #define _CEGUIScriptModule_h_
00028 
00029 #include "CEGUIBase.h"
00030 #include "CEGUIString.h"
00031 #include "CEGUIEvent.h"
00032 
00033 
00034 // Start of CEGUI namespace section
00035 namespace CEGUI
00036 {
00042 class CEGUIEXPORT ScriptModule
00043 {
00044 public:
00045         /*************************************************************************
00046                 Construction and Destruction
00047         *************************************************************************/
00052         ScriptModule(void);
00053 
00054 
00059         virtual ~ScriptModule(void) {}
00060 
00061 
00062         /*************************************************************************
00063                 Abstract interface
00064         *************************************************************************/
00075         virtual void    executeScriptFile(const String& filename, const String& resourceGroup = "")     = 0;
00076 
00077 
00089         virtual int     executeScriptGlobal(const String& function_name)        = 0;
00090 
00091 
00108         virtual bool    executeScriptedEventHandler(const String& handler_name, const EventArgs& e)             = 0;
00109 
00110 
00121     virtual void executeString(const String& str) = 0;
00122 
00123 
00132     virtual void createBindings(void) {}
00133 
00134 
00144     virtual void destroyBindings(void) {}
00145 
00154     const String& getIdentifierString() const;
00155 
00156 protected:
00157     String d_identifierString;                 
00158 };
00159 
00160 
00165 class ScriptFunctor
00166 {
00167 public:
00168         ScriptFunctor(const String& functionName) : scriptFunctionName(functionName) {}
00169     ScriptFunctor(const ScriptFunctor& obj) : scriptFunctionName(obj.scriptFunctionName) {}
00170         bool    operator()(const EventArgs& e) const;
00171 
00172 private:
00173     // no assignment possible
00174     ScriptFunctor& operator=(const ScriptFunctor& rhs);
00175 
00176         const String    scriptFunctionName;
00177 };
00178 
00179 } // End of  CEGUI namespace section
00180 
00181 
00182 #endif  // end of guard _CEGUIScriptModule_h_

Generated on Sat Nov 26 10:09:55 2005 for Crazy Eddies GUI System by  doxygen 1.4.5