Fix T69593: Color strip won't update
[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
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    * Returns the state of a single modifier key.
51    * \param mask: Key state to return.
52    * \return The state of the key (pressed == true).
53    */
54   bool get(GHOST_TModifierKeyMask mask) const;
55
56   /**
57    * Updates the state of a single modifier key.
58    * \param mask: Key state to update.
59    * \param down: The new state of the key.
60    */
61   void set(GHOST_TModifierKeyMask mask, bool down);
62
63   /**
64    * Sets the state of all modifier keys to up.
65    */
66   void clear();
67
68   /**
69    * Determines whether to modifier key states are equal.
70    * \param keys: The modifier key state to compare to.
71    * \return Indication of equality.
72    */
73   bool equals(const GHOST_ModifierKeys &keys) const;
74
75   /** Bitfield that stores the appropriate key state. */
76   GHOST_TUns8 m_LeftShift : 1;
77   /** Bitfield that stores the appropriate key state. */
78   GHOST_TUns8 m_RightShift : 1;
79   /** Bitfield that stores the appropriate key state. */
80   GHOST_TUns8 m_LeftAlt : 1;
81   /** Bitfield that stores the appropriate key state. */
82   GHOST_TUns8 m_RightAlt : 1;
83   /** Bitfield that stores the appropriate key state. */
84   GHOST_TUns8 m_LeftControl : 1;
85   /** Bitfield that stores the appropriate key state. */
86   GHOST_TUns8 m_RightControl : 1;
87   /** Bitfield that stores the appropriate key state. */
88   GHOST_TUns8 m_OS : 1;
89 };
90
91 #endif  // __GHOST_MODIFIERKEYS_H__