ryzom/client/src/r2/lua_event_forwarder.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This source file has been modified by the following contributors:
   5 // Copyright (C) 2013  Laszlo KIS-ADAM (dfighter) <dfighter1985@gmail.com>
   6 //
   7 // This program is free software: you can redistribute it and/or modify
   8 // it under the terms of the GNU Affero General Public License as
   9 // published by the Free Software Foundation, either version 3 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 // GNU Affero General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU Affero General Public License
  18 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 #ifndef R2_LUA_EVENT_FORWARDER_H
  21 #define R2_LUA_EVENT_FORWARDER_H
  22
  23 namespace NLGUI
  24 {
  25         class CLuaState;
  26         class CLuaString;
  27 }
  28
  29 using namespace NLGUI;
  30
  31 namespace R2
  32 {
  33
  34 /** helper class to forward events to a lua table
  35   * Derivers should tell how to handle an event with a given name and number of parameters, and how to access lua
  36         */
  37
  38 class CLuaEventForwarder
  39 {
  40 public:
  41         virtual ~CLuaEventForwarder() {}
  42         // events
  43         void onActChanged();
  44         void onContinentChanged();
  45         void onPostCreate();
  46         void onCreate();
  47         void onErase();
  48         void onPreHrcMove();    // instance is about to move in the hierarchy of object
  49         void onPostHrcMove();  // instance has moved in the hierarchy of objects
  50         void onFocus(bool focused);
  51         void onSelect(bool selected);
  52         void onAttrModified(const std::string &attrName, sint32 index);
  53         //virtual void onTableModified(const std::string &tableName, const std::string &keyInTable, sint32 indexInTable);
  54         // from CDisplayerBase : event from targeted instances
  55         void onTargetInstancePreHrcMove(const std::string &refMakerAttr, sint32 refMakerAttrIndex);     // instance is about to move in the hierarchy of object
  56         void onTargetInstancePostHrcMove(const std::string &refMakerAttr, sint32 refMakerAttrIndex);  // instance has moved in the hierarchy of objects
  57         void onTargetInstanceCreated(const std::string &refMakerAttr, sint32 refMakerAttrIndex);
  58         void onTargetInstanceErased(const std::string &refMakerAttr, sint32 refMakerAttrIndex);
  59         void onTargetInstanceEraseRequested(const std::string &refMakerAttr, sint32 refMakerAttrIndex);
  60         void onTargetInstanceAttrModified(      const std::string &refMakerAttr, sint32 refMakerAttrIndex,
  61                                                                                                         const std::string &targetAttrName, sint32 targetAttrIndex);
  62 protected:
  63         // for derivers
  64         virtual NLGUI::CLuaState *getLua() = 0;
  65         virtual void executeHandler(const CLuaString &eventName, int numArgs) = 0;
  66 };
  67
  68 } // R2
  69
  70 #endif