Cleanup: remove contributors for CMake files
[blender.git] / intern / ghost / intern / GHOST_ModifierKeys.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file ghost/intern/GHOST_ModifierKeys.h
21  *  \ingroup GHOST
22  * Declaration of GHOST_ModifierKeys struct.
23  */
24
25 #ifndef __GHOST_MODIFIERKEYS_H__
26 #define __GHOST_MODIFIERKEYS_H__
27
28 #include "GHOST_Types.h"
29
30 /**
31  * Stores the state of modifier keys.
32  * Discriminates between left and right modifier keys.
33  */
34 struct GHOST_ModifierKeys {
35         /**
36          * Constructor.
37          */
38         GHOST_ModifierKeys();
39
40         ~GHOST_ModifierKeys();
41
42         /**
43          * Returns the modifier key's key code from a modifier key mask.
44          * \param mask The mask of the modifier key.
45          * \return The modifier key's key code.
46          */
47         static GHOST_TKey getModifierKeyCode(GHOST_TModifierKeyMask mask);
48
49
50         /**
51          * Returns the state of a single modifier key.
52          * \param mask: Key state to return.
53          * \return The state of the key (pressed == true).
54          */
55         bool get(GHOST_TModifierKeyMask mask) const;
56
57         /**
58          * Updates the state of a single modifier key.
59          * \param mask: Key state to update.
60          * \param down: The new state of the key.
61          */
62         void set(GHOST_TModifierKeyMask mask, bool down);
63
64         /**
65          * Sets the state of all modifier keys to up.
66          */
67         void clear();
68
69         /**
70          * Determines whether to modifier key states are equal.
71          * \param keys: The modifier key state to compare to.
72          * \return Indication of equality.
73          */
74         bool equals(const GHOST_ModifierKeys& keys) const;
75
76         /** Bitfield that stores the appropriate key state. */
77         GHOST_TUns8 m_LeftShift : 1;
78         /** Bitfield that stores the appropriate key state. */
79         GHOST_TUns8 m_RightShift : 1;
80         /** Bitfield that stores the appropriate key state. */
81         GHOST_TUns8 m_LeftAlt : 1;
82         /** Bitfield that stores the appropriate key state. */
83         GHOST_TUns8 m_RightAlt : 1;
84         /** Bitfield that stores the appropriate key state. */
85         GHOST_TUns8 m_LeftControl : 1;
86         /** Bitfield that stores the appropriate key state. */
87         GHOST_TUns8 m_RightControl : 1;
88         /** Bitfield that stores the appropriate key state. */
89         GHOST_TUns8 m_OS : 1;
90 };
91
92 #endif // __GHOST_MODIFIERKEYS_H__