engine2/src/shared/keybinder.h

   1 /*
   2     fegdk: FE Game Development Kit
   3     Copyright (C) 2001-2008 Alexey "waker" Yakovenko
   4
   5     This library is free software; you can redistribute it and/or
   6     modify it under the terms of the GNU Library General Public
   7     License as published by the Free Software Foundation; either
   8     version 2 of the License, or (at your option) any later version.
   9
  10     This library is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13     Library General Public License for more details.
  14
  15     You should have received a copy of the GNU Library General Public
  16     License along with this library; if not, write to the Free
  17     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18
  19     Alexey Yakovenko
  20     waker@users.sourceforge.net
  21 */
  22
  23 #ifndef __F_KEYBINDER_H
  24 #define __F_KEYBINDER_H
  25
  26 #include "f_baseobject.h"
  27
  28 namespace fe
  29 {
  30
  31         /** The keyBinderClass is used to bind key combinations to some user-specified actions.
  32          * Only one action may be bound to one keycombo.
  33          */
  34         class FE_API keyBinder : public baseObject
  35         {
  36         private:
  37                 // the whole system may be a bit slow due to std::map lookup
  38                 // --> may be replaced with ushort array w/ 64k cost
  39
  40                 // maps keycode to action
  41                 typedef std::map <int, cStr> handlersMap;
  42                 handlersMap mHandlers;
  43
  44         public:
  45
  46                 enum { lalt = (1<<16), lctrl = (1<<17), lshift = (1<<18), ralt = (1<<19), rctrl = (1<<20), rshift = (1<<21), alt = (1<<22), shift = (1<<23), ctrl = (1<<24)};
  47
  48                 keyBinder (void);
  49                 virtual ~keyBinder (void);
  50
  51                 /** Binds keycombo to a console command (string value).
  52                  * @param keycombo Same as for bindToUserAction
  53                  * @param cmd Pointer to a string, containint console command
  54                  */
  55                 void bind (int keycombo, const char *cmd);
  56
  57                 /** Unbinds specified combo.
  58                 * @param keycombo Key combination
  59                  */
  60                 void unbind (int keycombo);
  61
  62                 /** Unbinds all keys, i.e. resets entire system.
  63                  */
  64                 void unbindAll (void);
  65
  66                 /**
  67                  * @return keycode for string value
  68                  */
  69                 int keycodeForString (const char *str) const;
  70
  71                 /**
  72                  * Handles key press.
  73                  * @param keycode specifies keycombo to handle
  74                  * @return true if keycombo was accepted
  75                  */
  76                 bool keyDown (int keycombo);
  77
  78                 /**
  79                  * Handles key release.
  80                  * @param keycombo specifies keycombo to handle
  81                  * @return true if keycombo was accepted
  82                  */
  83                 bool keyUp (int keycombo);
  84
  85         };
  86
  87 }
  88
  89 #endif // __F_KEYBINDER_H