src/hotkeys.h

   1 /*
   2  * This file is part of OpenTTD.
   3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   6  */
   7
   8 /** @file hotkeys.h %Hotkey related functions. */
   9
  10 #ifndef HOTKEYS_H
  11 #define HOTKEYS_H
  12
  13 #include "gfx_type.h"
  14 #include "window_type.h"
  15 #include "string_type.h"
  16
  17 /**
  18  * All data for a single hotkey. The name (for saving/loading a configfile),
  19  * a list of keycodes and a number to help identifying this hotkey.
  20  */
  21 struct Hotkey {
  22         Hotkey(uint16_t default_keycode, const std::string &name, int num);
  23         Hotkey(const std::vector<uint16_t> &default_keycodes, const std::string &name, int num);
  24
  25         void AddKeycode(uint16_t keycode);
  26
  27         const std::string name;
  28         int num;
  29         std::set<uint16_t> keycodes;
  30 };
  31
  32 struct IniFile;
  33
  34 /**
  35  * List of hotkeys for a window.
  36  */
  37 struct HotkeyList {
  38         typedef EventState (*GlobalHotkeyHandlerFunc)(int hotkey);
  39
  40         HotkeyList(const std::string &ini_group, const std::vector<Hotkey> &items, GlobalHotkeyHandlerFunc global_hotkey_handler = nullptr);
  41         ~HotkeyList();
  42
  43         void Load(const IniFile &ini);
  44         void Save(IniFile &ini) const;
  45
  46         int CheckMatch(uint16_t keycode, bool global_only = false) const;
  47
  48         GlobalHotkeyHandlerFunc global_hotkey_handler;
  49 private:
  50         const std::string ini_group;
  51         std::vector<Hotkey> items;
  52
  53         /**
  54          * Dummy private copy constructor to prevent compilers from
  55          * copying the structure, which fails due to _hotkey_lists.
  56          */
  57         HotkeyList(const HotkeyList &other);
  58 };
  59
  60 bool IsQuitKey(uint16_t keycode);
  61
  62 void LoadHotkeysFromConfig();
  63 void SaveHotkeysToConfig();
  64
  65
  66 void HandleGlobalHotkeys(char32_t key, uint16_t keycode);
  67
  68 #endif /* HOTKEYS_H */