libinput  0.9.0
A wrapper library for input devices
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Data Structures | Functions
Keyboard events

Key events are generated when a key changes its logical state, usually by being pressed or released. More...

Data Structures

struct  libinput_event_keyboard
 A keyboard event representing a key press/release. More...
 

Functions

uint32_t libinput_event_keyboard_get_time (struct libinput_event_keyboard *event)
 
uint32_t libinput_event_keyboard_get_key (struct libinput_event_keyboard *event)
 
enum libinput_key_state libinput_event_keyboard_get_key_state (struct libinput_event_keyboard *event)
 
struct libinput_eventlibinput_event_keyboard_get_base_event (struct libinput_event_keyboard *event)
 
uint32_t libinput_event_keyboard_get_seat_key_count (struct libinput_event_keyboard *event)
 For the key of a LIBINPUT_EVENT_KEYBOARD_KEY event, return the total number of keys pressed on all devices on the associated seat after the event was triggered. More...
 

Detailed Description

Key events are generated when a key changes its logical state, usually by being pressed or released.

Function Documentation

struct libinput_event* libinput_event_keyboard_get_base_event ( struct libinput_event_keyboard event)
Returns
The generic libinput_event of this event
uint32_t libinput_event_keyboard_get_key ( struct libinput_event_keyboard event)
Returns
The keycode that triggered this key event
enum libinput_key_state libinput_event_keyboard_get_key_state ( struct libinput_event_keyboard event)
Returns
The state change of the key
uint32_t libinput_event_keyboard_get_seat_key_count ( struct libinput_event_keyboard event)

For the key of a LIBINPUT_EVENT_KEYBOARD_KEY event, return the total number of keys pressed on all devices on the associated seat after the event was triggered.

"

Note
It is an application bug to call this function for events other than LIBINPUT_EVENT_KEYBOARD_KEY. For other events, this function returns 0.
Returns
the seat wide pressed key count for the key of this event
uint32_t libinput_event_keyboard_get_time ( struct libinput_event_keyboard event)
Returns
The event time for this event