src/common/common/KeyboardKey.h

   1 ////////////////////////////////////////////////////////////////////////////////
   2 //    Scorched3D (c) 2000-2009
   3 //
   4 //    This file is part of Scorched3D.
   5 //
   6 //    Scorched3D is free software; you can redistribute it and/or modify
   7 //    it under the terms of the GNU General Public License as published by
   8 //    the Free Software Foundation; either version 2 of the License, or
   9 //    (at your option) any later version.
  10 //
  11 //    Scorched3D is distributed in the hope that it will be useful,
  12 //    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 //    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 //    GNU General Public License for more details.
  15 //
  16 //    You should have received a copy of the GNU General Public License
  17 //    along with Scorched3D; if not, write to the Free Software
  18 //    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19 ////////////////////////////////////////////////////////////////////////////////
  20
  21 #ifndef __keyboardKey_h__
  22 #define __keyboardKey_h__
  23
  24 #include <string>
  25 #include <list>
  26 #include <vector>
  27
  28 class KeyboardKey
  29 {
  30 public:
  31         struct KeyEntry
  32         {
  33                 unsigned int key;
  34                 unsigned int state;
  35         };
  36
  37         KeyboardKey(const char *name,
  38                 const char *title,
  39                 const char *description,
  40                 int group,
  41                 bool command);
  42         virtual ~KeyboardKey();
  43
  44         bool keyDown(char *buffer, unsigned int keyState, bool repeat = true);
  45         bool keyMatch(unsigned key);
  46
  47         bool addKeys(std::list<std::string> &keyNames,
  48                 std::list<std::string> &keyStates);
  49         void addKey(unsigned int position,
  50                 unsigned int key, unsigned int state);
  51         void removeKey(unsigned int position);
  52         bool hasKey(unsigned int key, unsigned int state);
  53
  54         std::vector<KeyEntry> &getKeys() { return keys_; }
  55         const char *getName() { return name_.c_str(); }
  56         const char *getTitle() { return title_.c_str(); }
  57         const char *getDescription() { return description_.c_str(); }
  58         int getGroup() { return group_; }
  59         bool getNameIsCommand() { return command_; }
  60         bool getChanged() { return changed_; }
  61         void setChanged(bool changed) { changed_ = changed; }
  62
  63         static bool translateKeyName(const char *name, unsigned int &key);
  64         static bool translateKeyState(const char *name, unsigned int &state);
  65         static bool translateKeyNameValue(unsigned int key, const char *&name);
  66         static bool translateKeyStateValue(unsigned int state, const char *&name);
  67
  68 protected:
  69         std::string name_;
  70         std::string title_;
  71         std::string description_;
  72         std::vector<KeyEntry> keys_;
  73         int group_;
  74         bool keyToogle_;
  75         bool command_;
  76         bool changed_;
  77
  78 private:
  79         KeyboardKey(const KeyboardKey &);
  80         const KeyboardKey & operator=(const KeyboardKey &);
  81
  82 };
  83
  84 #endif // __keyboardKey_h__
  85