Mir
pointer_event.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2015 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_POINTER_EVENT_H_
20 #define MIR_TOOLKIT_POINTER_EVENT_H_
21 
22 #include <stdbool.h>
23 
24 #ifdef __cplusplus
25 
29 extern "C" {
30 #endif
31 
35 typedef struct MirPointerEvent MirPointerEvent;
36 
44 
52 
62  MirPointerButton button);
63 
72 
81  MirPointerAxis axis);
82 
90 
91 #ifdef __cplusplus
92 }
94 #endif
95 
96 #endif /* MIR_TOOLKIT_POINTER_EVENT_H_ */
MirInputEventModifiers
unsigned int MirInputEventModifiers
Definition: enums.h:88
mir_pointer_event_button_state
bool mir_pointer_event_button_state(MirPointerEvent const *event, MirPointerButton button)
Retrieve the state of a given pointer button when the action occurred.
mir_pointer_event_axis_value
float mir_pointer_event_axis_value(MirPointerEvent const *event, MirPointerAxis axis)
Retrieve the axis value reported by a given pointer event.
MirPointerEvent
struct MirPointerEvent MirPointerEvent
An event type describing a change in pointer device state.
Definition: pointer_event.h:35
mir_pointer_event_input_event
MirInputEvent const * mir_pointer_event_input_event(MirPointerEvent const *event)
Retrieve the corresponding input event.
MirPointerButton
MirPointerButton
Definition: enums.h:198
MirPointerAction
MirPointerAction
Possible pointer actions.
Definition: enums.h:160
MirPointerAxis
MirPointerAxis
Identifiers for pointer axis.
Definition: enums.h:178
MirInputEvent
struct MirInputEvent MirInputEvent
Definition: event.h:42
mir_pointer_event_modifiers
MirInputEventModifiers mir_pointer_event_modifiers(MirPointerEvent const *event)
Retrieve the modifier keys pressed when the pointer action occured.
MirPointerButtons
unsigned int MirPointerButtons
Definition: enums.h:208
mir_pointer_event_action
MirPointerAction mir_pointer_event_action(MirPointerEvent const *event)
Retrieve the action which occured to generate a given pointer event.
mir_pointer_event_buttons
MirPointerButtons mir_pointer_event_buttons(MirPointerEvent const *event)
Retreive the pointer button state as a masked set of values.

Copyright © 2012-2021 Canonical Ltd.
Generated on Thu Jun 24 19:55:23 UTC 2021
This documentation is licensed under the GPL version 2 or 3.