toolkit_event.h File Reference

#include <mir_toolkit/events/enums.h>
#include <xkbcommon/xkbcommon.h>

Include dependency graph for toolkit_event.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	miral
	Mir Abstraction Layer.
namespace	miral::toolkit

Typedefs
typedef int32_t	MirTouchId
	An identifier for a touch-point. More...

Functions
MirEventType	miral::toolkit::mir_event_get_type (MirEvent const *event)
	Retrieves the type of a MirEvent. More...
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. More...
int64_t	miral::toolkit::mir_input_event_get_event_time (MirInputEvent const *event)
	‍** More...
MirInputEventType	miral::toolkit::mir_input_event_get_type (MirInputEvent const *event)
	Retrieve the type of an input event. More...
MirKeyboardEvent const *	miral::toolkit::mir_input_event_get_keyboard_event (MirInputEvent const *event)
	Retrieve the MirKeyboardEvent associated with a given input event. More...
MirTouchEvent const *	miral::toolkit::mir_input_event_get_touch_event (MirInputEvent const *event)
	Retrieve the MirTouchEvent associated with a given input event. More...
MirPointerEvent const *	miral::toolkit::mir_input_event_get_pointer_event (MirInputEvent const *event)
	Retrieve the MirPointerEvent associated with a given input event. More...
bool	miral::toolkit::mir_input_event_has_cookie (MirInputEvent const *ev)
	Query if an input event contains a cookie. More...
MirEvent const *	miral::toolkit::mir_input_event_get_event (MirInputEvent const *event)
	‍** More...
MirKeyboardAction	miral::toolkit::mir_keyboard_event_action (MirKeyboardEvent const *event)
	Retrieve the action which triggered a given key event. More...
xkb_keysym_t	miral::toolkit::mir_keyboard_event_keysym (MirKeyboardEvent const *event)
	Retrieve the xkb mapped keysym associated with the key acted on. More...
xkb_keysym_t	miral::toolkit::mir_keyboard_event_key_code (MirKeyboardEvent const *event)
int	miral::toolkit::mir_keyboard_event_scan_code (MirKeyboardEvent const *event)
	Retrieve the raw hardware scan code associated with the key acted on. More...
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. More...
MirInputEventModifiers	miral::toolkit::mir_keyboard_event_modifiers (MirKeyboardEvent const *event)
	Retrieve the modifier keys pressed when the key action occured. More...
MirInputEvent const *	miral::toolkit::mir_keyboard_event_input_event (MirKeyboardEvent const *event)
	Retrieve the corresponding input event. More...
MirInputEventModifiers	miral::toolkit::mir_touch_event_modifiers (MirTouchEvent const *event)
	Retrieve the modifier keys pressed when the touch action occured. More...
unsigned int	miral::toolkit::mir_touch_event_point_count (MirTouchEvent const *event)
	Retrieve the number of touches reported for a given touch event. More...
MirTouchId	miral::toolkit::mir_touch_event_id (MirTouchEvent const *event, unsigned int touch_index)
	Retrieve the TouchID for a touch at given index. More...
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. More...
MirTouchTooltype	miral::toolkit::mir_touch_event_tooltype (MirTouchEvent const *event, unsigned int touch_index)
	Retrieve the tooltype for touch at given index. More...
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. More...
MirInputEvent const *	miral::toolkit::mir_touch_event_input_event (MirTouchEvent const *event)
	Retrieve the corresponding input event. More...
MirInputEventModifiers	miral::toolkit::mir_pointer_event_modifiers (MirPointerEvent const *event)
	Retrieve the modifier keys pressed when the pointer action occured. More...
MirPointerAction	miral::toolkit::mir_pointer_event_action (MirPointerEvent const *event)
	Retrieve the action which occured to generate a given pointer event. More...
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. More...
MirPointerButtons	miral::toolkit::mir_pointer_event_buttons (MirPointerEvent const *event)
	Retreive the pointer button state as a masked set of values. More...
float	miral::toolkit::mir_pointer_event_axis_value (MirPointerEvent const *event, MirPointerAxis axis)
	Retrieve the axis value reported by a given pointer event. More...
MirInputEvent const *	miral::toolkit::mir_pointer_event_input_event (MirPointerEvent const *event)
	Retrieve the corresponding input event. More...

Typedef Documentation

MirTouchId

typedef int32_t MirTouchId

An identifier for a touch-point.

TouchId's are unique per-gesture. That is to say, once a touch has gone down at time T, no other touch will use that touch's ID until all touches at time T have come up.