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 2 or 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
29 extern "C" {
30 #endif
31 
41 typedef struct MirKeyboardEvent MirKeyboardEvent;
42 
50 
58 xkb_keysym_t mir_keyboard_event_key_code(MirKeyboardEvent const* event);
59 
68 
80 
88 
96 
97 #ifdef __cplusplus
98 }
100 #endif
101 
102 #endif /* MIR_TOOLKIT_KEYBOARD_EVENT_H_ */
xkb_keysym_t mir_keyboard_event_key_code(MirKeyboardEvent const *event)
Retrieve the xkb mapped keycode associated with the key acted on.
MirKeyboardAction mir_keyboard_event_action(MirKeyboardEvent const *event)
Retrieve the action which triggered a given key event.
MirInputEventModifiers mir_keyboard_event_modifiers(MirKeyboardEvent const *event)
Retrieve the modifier keys pressed when the key action occured.
int mir_keyboard_event_scan_code(MirKeyboardEvent const *event)
Retrieve the raw hardware scan code associated with the key acted on.
struct MirKeyboardEvent MirKeyboardEvent
An event type describing a change in keyboard state.
Definition: keyboard_event.h:41
MirInputEvent const * mir_keyboard_event_input_event(MirKeyboardEvent const *event)
Retrieve the corresponding input event.
MirKeyboardAction
Possible actions for changing key state.
Definition: enums.h:93
struct MirInputEvent MirInputEvent
Definition: event.h:42
char const * mir_keyboard_event_key_text(MirKeyboardEvent const *event)
Retrieve the text the key press would emit as null terminated utf8 string.
unsigned int MirInputEventModifiers
Definition: enums.h:88

Copyright © 2012-2021 Canonical Ltd.
Generated on Wed Jul 28 02:57:36 UTC 2021
This documentation is licensed under the GPL version 2 or 3.