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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
/*
* Copyright © Canonical Ltd.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License version 2 or 3,
* as published by the Free Software Foundation.
*
* 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef MIR_TOOLKIT_EVENTS_INPUT_DEVICE_STATE_EVENT_H_
#define MIR_TOOLKIT_EVENTS_INPUT_DEVICE_STATE_EVENT_H_
#include <mir_toolkit/events/event.h>
#include <mir_toolkit/mir_input_device_types.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* MirInputDeviceStateEvent informs clients about the current state of the
* input devices. This is necessary when the client did not receive the most
* recent input events. The event is sent when the server was resumed after
* a pause, or when the client just received the input focus.
*
* The event contains a single pointer button state and the current cursor
* position and the pressed modifier keys. Additionally for key and pointer
* devices the pressed keys and buttons are supplied individually.
*/
/**
* Retrieve the button state.
*
* \param[in] ev The input device state event
* \return The combined pointer button state
*/
MirPointerButtons mir_input_device_state_event_pointer_buttons(
MirInputDeviceStateEvent const* ev);
/**
* Retrieve the pointer position
*
* \param[in] ev The input device state event
* \param[in] axis The pointer axis: mir_pointer_axis_x or mir_pointer_axis_y
* \return The pointer position
*/
float mir_input_device_state_event_pointer_axis(
MirInputDeviceStateEvent const* ev, MirPointerAxis axis);
/**
* Retrieve the time associated with a MirInputDeviceStateEvent
*
* \param[in] ev The input device state event
* \return The time in nanoseconds since epoch
*/
int64_t mir_input_device_state_event_time(
MirInputDeviceStateEvent const* ev);
/**
* Retrieve the modifier keys pressed on all input devices.
*
* \param[in] ev The input device state event
* \return The modifier mask
*/
MirInputEventModifiers mir_input_device_state_event_modifiers(
MirInputDeviceStateEvent const* ev);
/**
* Retrieve the number of attached input devices.
*
* \param[in] ev The input device state event
* \return The time in nanoseconds since epoch
*/
uint32_t mir_input_device_state_event_device_count(
MirInputDeviceStateEvent const* ev);
/**
* Retrieve the device id
*
* \param[in] ev The input device state event
* \param[in] index The index of the input device
* \return The device id
*/
MirInputDeviceId mir_input_device_state_event_device_id(
MirInputDeviceStateEvent const* ev, uint32_t index);
/*
* Retrieve a pressed key on the device identified by the \a index.
* The key is encoded as a scan code.
*
* \param[in] ev The input device state event
* \param[in] index The index of the input device
* \param[in] pressed_index The index of the pressed key
* \return The pressed key at index pressed_index
*/
uint32_t mir_input_device_state_event_device_pressed_keys_for_index(
MirInputDeviceStateEvent const* ev, uint32_t index, uint32_t pressed_index);
/**
* Retrieve the size of scan code array of the device identified by the \a index.
*
* \param[in] ev The input device state event
* \param[in] index The index of the input device
* \return Size of the pressed keys array
*/
uint32_t mir_input_device_state_event_device_pressed_keys_count(
MirInputDeviceStateEvent const* ev, uint32_t index);
/**
* Retrieve the pointer button state of the device identified by the \a index
*
* \param[in] ev The input device state event
* \param[in] index The index of the input device
* \return The pointer button state of the device
*/
MirPointerButtons mir_input_device_state_event_device_pointer_buttons(
MirInputDeviceStateEvent const* ev, uint32_t index);
#ifdef __cplusplus
}
#endif
#endif /* MIR_TOOLKIT_EVENTS_INPUT_DEVICE_STATE_EVENT_H_ */
|
