blob: 75173f5a525afabf3bb6892454ca28bed384925f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program 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; either version 2
* of the License, or (at your option) any later version.
*
* This program 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. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved.
*
* The Original Code is: all of this file.
*
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file ghost/intern/GHOST_ModifierKeys.h
* \ingroup GHOST
* Declaration of GHOST_ModifierKeys struct.
*/
#ifndef __GHOST_MODIFIERKEYS_H__
#define __GHOST_MODIFIERKEYS_H__
#include "GHOST_Types.h"
/**
* Stores the state of modifier keys.
* Discriminates between left and right modifier keys.
* \author Maarten Gribnau
* \date May 17, 2001
*/
struct GHOST_ModifierKeys {
/**
* Constructor.
*/
GHOST_ModifierKeys();
~GHOST_ModifierKeys();
/**
* Returns the modifier key's key code from a modifier key mask.
* \param mask The mask of the modifier key.
* \return The modifier key's key code.
*/
static GHOST_TKey getModifierKeyCode(GHOST_TModifierKeyMask mask);
/**
* Returns the state of a single modifier key.
* \param mask. Key state to return.
* \return The state of the key (pressed == true).
*/
bool get(GHOST_TModifierKeyMask mask) const;
/**
* Updates the state of a single modifier key.
* \param mask. Key state to update.
* \param down. The new state of the key.
*/
void set(GHOST_TModifierKeyMask mask, bool down);
/**
* Sets the state of all modifier keys to up.
*/
void clear();
/**
* Determines whether to modifier key states are equal.
* \param keys. The modifier key state to compare to.
* \return Indication of equality.
*/
bool equals(const GHOST_ModifierKeys& keys) const;
/** Bitfield that stores the appropriate key state. */
GHOST_TUns8 m_LeftShift : 1;
/** Bitfield that stores the appropriate key state. */
GHOST_TUns8 m_RightShift : 1;
/** Bitfield that stores the appropriate key state. */
GHOST_TUns8 m_LeftAlt : 1;
/** Bitfield that stores the appropriate key state. */
GHOST_TUns8 m_RightAlt : 1;
/** Bitfield that stores the appropriate key state. */
GHOST_TUns8 m_LeftControl : 1;
/** Bitfield that stores the appropriate key state. */
GHOST_TUns8 m_RightControl : 1;
/** Bitfield that stores the appropriate key state. */
GHOST_TUns8 m_OS : 1;
};
#endif // __GHOST_MODIFIERKEYS_H__
|
