fixed spacing in the headers to get rid of some warnings and some other
[blender.git] / intern / ghost / intern / GHOST_ModifierKeys.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version. The Blender
9  * Foundation also sells licenses for use in proprietary software under
10  * the Blender License.  See http://www.blender.org/BL/ for information
11  * about this.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
30  */
31
32 /**
33
34  * $Id$
35  * Copyright (C) 2001 NaN Technologies B.V.
36  * @author      Maarten Gribnau
37  * @date        May 17, 2001
38  */
39
40 #ifndef _GHOST_MODIFIER_KEYS_H_
41 #define _GHOST_MODIFIER_KEYS_H_
42
43 #include "GHOST_Types.h"
44
45 struct GHOST_ModifierKeys
46 {
47     /**
48      * Constructor.
49      */
50     GHOST_ModifierKeys();
51
52         /**
53          * Returns the modifier key's key code from a modifier key mask.
54          * @param mask The mask of the modifier key.
55          * @return The modifier key's key code.
56          */
57         static GHOST_TKey getModifierKeyCode(GHOST_TModifierKeyMask mask);
58
59     
60     /**
61      * Returns the state of a single modifier key.
62      * @param mask. Key state to return.
63      * @return The state of the key (pressed == true).
64      */
65     virtual bool get(GHOST_TModifierKeyMask mask) const;
66     
67     /**
68      * Updates the state of a single modifier key.
69      * @param mask. Key state to update.
70      * @param down. The new state of the key.
71      */
72     virtual void set(GHOST_TModifierKeyMask mask, bool down);
73     
74     /**
75      * Sets the state of all modifier keys to up.
76      */
77     virtual void clear();
78
79         /**
80          * Determines whether to modifier key states are equal.
81          * @param keys. The modifier key state to compare to.
82          * @return Indication of equality.
83          */
84         virtual bool equals(const GHOST_ModifierKeys& keys) const;
85     
86     /** Bitfield that stores the appropriate key state. */
87     GHOST_TUns8 m_LeftShift : 1;
88     /** Bitfield that stores the appropriate key state. */
89     GHOST_TUns8 m_RightShift : 1;
90     /** Bitfield that stores the appropriate key state. */
91     GHOST_TUns8 m_LeftAlt : 1;
92     /** Bitfield that stores the appropriate key state. */
93     GHOST_TUns8 m_RightAlt : 1;
94     /** Bitfield that stores the appropriate key state. */
95     GHOST_TUns8 m_LeftControl : 1;
96     /** Bitfield that stores the appropriate key state. */
97     GHOST_TUns8 m_RightControl : 1;
98     /** Bitfield that stores the appropriate key state. APPLE only! */
99     GHOST_TUns8 m_Command : 1;
100 };
101
102 #endif // _GHOST_MODIFIER_KEYS_H_
103