Mir
|
MirInputEvent const * miral::toolkit::mir_event_get_input_event | ( | MirEvent const * | event | ) |
Retrieve the MirInputEvent associated with a MirEvent of type mir_event_type_input.
See <mir_toolkit/events/input/input_event.h> for accessors.
[in] | event | The event |
MirEventType miral::toolkit::mir_event_get_type | ( | MirEvent const * | event | ) |
Retrieves the type of a MirEvent.
Now preferred over direct access to ev->type. In particular ev->type will never be mir_event_type_input and mir_event_get_type is the only way to ensure mir_event_get_input_event will succeed.
[in] | event | The event |
MirEvent const * miral::toolkit::mir_input_event_get_event | ( | MirInputEvent const * | event | ) |
**
Retrieve the MirEvent associated with a given input event.
[in] | event | The input event |
int64_t miral::toolkit::mir_input_event_get_event_time | ( | MirInputEvent const * | event | ) |
**
Retrieve the time at which an input event occurred.
[in] | event | The input event |
MirKeyboardEvent const * miral::toolkit::mir_input_event_get_keyboard_event | ( | MirInputEvent const * | event | ) |
Retrieve the MirKeyboardEvent associated with a given input event.
[in] | event | The input event |
MirPointerEvent const * miral::toolkit::mir_input_event_get_pointer_event | ( | MirInputEvent const * | event | ) |
Retrieve the MirPointerEvent associated with a given input event.
[in] | event | The input event |
MirTouchEvent const * miral::toolkit::mir_input_event_get_touch_event | ( | MirInputEvent const * | event | ) |
Retrieve the MirTouchEvent associated with a given input event.
[in] | event | The input event |
MirInputEventType miral::toolkit::mir_input_event_get_type | ( | MirInputEvent const * | event | ) |
Retrieve the type of an input event.
E.g. key, touch...
[in] | event | The input event |
bool miral::toolkit::mir_input_event_has_cookie | ( | MirInputEvent const * | ev | ) |
Query if an input event contains a cookie.
[in] | ev | The input event |
MirKeyboardAction miral::toolkit::mir_keyboard_event_action | ( | MirKeyboardEvent const * | event | ) |
Retrieve the action which triggered a given key event.
[in] | event | The key event |
MirInputEvent const * miral::toolkit::mir_keyboard_event_input_event | ( | MirKeyboardEvent const * | event | ) |
Retrieve the corresponding input event.
[in] | event | The keyboard event |
xkb_keysym_t miral::toolkit::mir_keyboard_event_key_code | ( | MirKeyboardEvent const * | event | ) |
char const * miral::toolkit::mir_keyboard_event_key_text | ( | MirKeyboardEvent const * | event | ) |
Retrieve the text the key press would emit as null terminated utf8 string.
The text will only be available to key down and key repeat events. For mir_keyboard_action_up or key presses that do produce text an empty string will be returned.
[in] | event | The key event |
xkb_keysym_t miral::toolkit::mir_keyboard_event_keysym | ( | MirKeyboardEvent const * | event | ) |
Retrieve the xkb mapped keysym associated with the key acted on.
. May be interpreted as per <xkbcommon/xkbcommon-keysyms.h>
[in] | event | The key event |
MirInputEventModifiers miral::toolkit::mir_keyboard_event_modifiers | ( | MirKeyboardEvent const * | event | ) |
Retrieve the modifier keys pressed when the key action occured.
[in] | event | The key event |
int miral::toolkit::mir_keyboard_event_scan_code | ( | MirKeyboardEvent const * | event | ) |
Retrieve the raw hardware scan code associated with the key acted on.
May be interpreted as per <linux/input.h>
[in] | event | The key event |
MirPointerAction miral::toolkit::mir_pointer_event_action | ( | MirPointerEvent const * | event | ) |
Retrieve the action which occured to generate a given pointer event.
[in] | event | The pointer event |
float miral::toolkit::mir_pointer_event_axis_value | ( | MirPointerEvent const * | event, |
MirPointerAxis | axis | ||
) |
Retrieve the axis value reported by a given pointer event.
[in] | event | The pointer event |
[in] | axis | The axis to retreive a value from |
bool miral::toolkit::mir_pointer_event_button_state | ( | MirPointerEvent const * | event, |
MirPointerButton | button | ||
) |
Retrieve the state of a given pointer button when the action occurred.
[in] | event | The pointer event |
[in] | button | The button to check |
MirPointerButtons miral::toolkit::mir_pointer_event_buttons | ( | MirPointerEvent const * | event | ) |
Retreive the pointer button state as a masked set of values.
[in] | event | The pointer event |
MirInputEvent const * miral::toolkit::mir_pointer_event_input_event | ( | MirPointerEvent const * | event | ) |
Retrieve the corresponding input event.
[in] | event | The pointer event |
MirInputEventModifiers miral::toolkit::mir_pointer_event_modifiers | ( | MirPointerEvent const * | event | ) |
Retrieve the modifier keys pressed when the pointer action occured.
[in] | event | The pointer event |
MirTouchAction miral::toolkit::mir_touch_event_action | ( | MirTouchEvent const * | event, |
unsigned int | touch_index | ||
) |
Retrieve the action which occured for a touch at given index.
[in] | event | The touch event |
[in] | touch_index | The touch index. Must be less than (touch_count - 1). |
float miral::toolkit::mir_touch_event_axis_value | ( | MirTouchEvent const * | event, |
unsigned int | touch_index, | ||
MirTouchAxis | axis | ||
) |
Retrieve the axis value for a given axis on an indexed touch.
[in] | event | The touch event |
[in] | touch_index | The touch index. Must be less than (touch_count - 1). |
[in] | axis | The axis to retreive a value from |
MirTouchId miral::toolkit::mir_touch_event_id | ( | MirTouchEvent const * | event, |
unsigned int | touch_index | ||
) |
Retrieve the TouchID for a touch at given index.
[in] | event | The touch event |
[in] | touch_index | The touch index. Must be less than (touch_count - 1). |
MirInputEvent const * miral::toolkit::mir_touch_event_input_event | ( | MirTouchEvent const * | event | ) |
Retrieve the corresponding input event.
[in] | event | The touch event |
MirInputEventModifiers miral::toolkit::mir_touch_event_modifiers | ( | MirTouchEvent const * | event | ) |
Retrieve the modifier keys pressed when the touch action occured.
[in] | event | The key event |
unsigned int miral::toolkit::mir_touch_event_point_count | ( | MirTouchEvent const * | event | ) |
Retrieve the number of touches reported for a given touch event.
Each touch is said to be index in the event and may be accessed by index 0, 1, ... , (touch_count - 1)
[in] | event | The touch event |
MirTouchTooltype miral::toolkit::mir_touch_event_tooltype | ( | MirTouchEvent const * | event, |
unsigned int | touch_index | ||
) |
Retrieve the tooltype for touch at given index.
[in] | event | The touch event |
[in] | touch_index | The touch index. Must be less than (touch_count - 1). |
Copyright © 2012-2024
Canonical Ltd.
Generated on Thu Mar 21 18:45:15 UTC 2024
This documentation is licensed under the GPL version 2 or 3.