MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
hotkeyhandler.h
1 //© Copyright 2010 - 2012 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 #ifndef _uihotkeyhandler_h
41 #define _uihotkeyhandler_h
42 
43 #include "datatypes.h"
44 #include "Input/inputenumerations.h"
45 #include "Input/metacode.h"
46 
47 namespace Mezzanine
48 {
49  namespace UI
50  {
51  class Button;
52  ///////////////////////////////////////////////////////////////////////////////
53  /// @class HotKeyHandler
54  /// @headerfile hotkeyhandler.h
55  /// @brief This class is responsible for the registration and handling of hotkeys in the UI system.
56  /// @details
57  ///////////////////////////////////////
59  {
60  public:
61  /// @brief A convenience type for handling hotkey pairs.
62  typedef std::pair< Input::InputCode, UI::Button* > HotKeyPair;
63  /// @brief Basic container type for hotkey binding storage by this class.
64  typedef std::multimap< Input::InputCode, UI::Button* > HotKeyContainer;
65  /// @brief Iterator type for hotkey bindings stored by this class.
66  typedef HotKeyContainer::iterator HotKeyIterator;
67  /// @brief Const Iterator type for hotkey bindings stored by this class.
68  typedef HotKeyContainer::const_iterator ConstHotKeyIterator;
69  protected:
70  /// @internal
71  /// @brief A container storing all registered hotkey bindings.
73  public:
74  /// @brief Class constructor.
75  HotKeyHandler();
76  /// @brief Class destructor.
77  ~HotKeyHandler();
78 
79  ///////////////////////////////////////////////////////////////////////////////
80  // HotKey Management
81 
82  /// @brief Binds a key to a button.
83  /// @details This function allows buttons to behave like they are pressed without mouse input.
84  /// @param HotKey The key or button (on the input device) to activate the button.
85  /// @param BoundButton The button being bound to the hotkey.
86  void BindHotKey(const Input::MetaCode& HotKey, UI::Button* BoundButton);
87  /// @brief Removes a previously set hotkey binding.
88  /// @param HotKey The key or button (on the input device) to activate the button.
89  /// @param BoundButton The button currently bound to the hotkey.
90  void UnbindHotKey(const Input::MetaCode& HotKey, UI::Button* BoundButton);
91  /// @brief Clears all registered hotkeys.
92  void RemoveAllHotKeys();
93  };//HotKeyHandler
94  }//UI
95 }//Mezzanine
96 
97 #endif