Mir
keyboard_event.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2014 Canonical Ltd.
3  *
4  * This program is free software: you can redistribute it and/or modify it
5  * under the terms of the GNU Lesser General Public License version 3,
6  * as published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by: Robert Carr <robert.carr@canonical.com>
17  */
18 
19 #ifndef MIR_TOOLKIT_KEYBOARD_EVENT_H_
20 #define MIR_TOOLKIT_KEYBOARD_EVENT_H_
21 
22 #include <xkbcommon/xkbcommon.h>
23 
24 #ifdef __cplusplus
25 
29 extern "C" {
30 #endif
31 
45 
49 typedef enum {
50  /* A key has come up (released) */
52  /* A key has gone down (pressed) */
54  /* System policy has triggered a key repeat on a key
55  which was already down */
58 
66 
74 xkb_keysym_t mir_keyboard_event_key_code(MirKeyboardEvent const* event);
75 
84 
92 
93 /*
94  * Retrieve the corresponding input event.
95  *
96  * \param [in] event The keyboard event
97  * \return The input event
98  */
100 
101 #ifdef __cplusplus
102 }
104 #endif
105 
106 #endif /* MIR_TOOLKIT_KEYBOARD_EVENT_H_ */
MirInputEventModifiers mir_keyboard_event_modifiers(MirKeyboardEvent const *event)
Retrieve the modifier keys pressed when the key action occured.
Definition: input_event.cpp:233
MirInputEvent const * mir_keyboard_event_input_event(MirKeyboardEvent const *event)
Definition: input_event.cpp:190
Definition: keyboard_event.h:56
MirKeyboardAction
Possible actions for changing key state.
Definition: keyboard_event.h:49
unsigned int MirInputEventModifiers
Definition: input_event.h:65
Definition: keyboard_event.h:53
int mir_keyboard_event_scan_code(MirKeyboardEvent const *event)
Retrieve the raw hardware scan code associated with the key acted on.
Definition: input_event.cpp:227
struct MirKeyboardEvent MirKeyboardEvent
An event type describing a change in keyboard state.
Definition: keyboard_event.h:44
xkb_keysym_t mir_keyboard_event_key_code(MirKeyboardEvent const *event)
Retrieve the xkb mapped keycode associated with the key acted on.
Definition: input_event.cpp:221
struct MirInputEvent MirInputEvent
Definition: event.h:56
MirKeyboardAction mir_keyboard_event_action(MirKeyboardEvent const *event)
Retrieve the action which triggered a given key event.
Definition: input_event.cpp:214
Definition: keyboard_event.h:51

Copyright © 2012-2015 Canonical Ltd.
Generated on Thu Oct 8 16:20:16 UTC 2015