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

CEGUIScriptModule.h

Go to the documentation of this file.
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 CEGUIBASE_API 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         *************************************************************************/
00072         virtual void    executeScriptFile(const String& filename)       = 0;
00073 
00074 
00086         virtual int     executeScriptGloabl(const String& function_name)        = 0;
00087 
00088 
00105         virtual bool    executeScriptedEventHandler(const String& handler_name, const EventArgs& e)             = 0;
00106 };
00107 
00108 
00113 class ScriptFunctor
00114 {
00115 public:
00116         ScriptFunctor(const String functionName) : scriptFunctionName(functionName) {}
00117         bool    operator()(const EventArgs& e) const;
00118 
00119 private:
00120         const String    scriptFunctionName;
00121 };
00122 
00123 } // End of  CEGUI namespace section
00124 
00125 
00126 #endif  // end of guard _CEGUIScriptModule_h_

Generated on Wed Feb 16 12:41:07 2005 for Crazy Eddies GUI System by  doxygen 1.3.9.1