libxkbcommon  1.13.0
Library implementing the XKB specification for parsing keyboard descriptions and handling keyboard state
Public Member Functions
xkb_state_machine Struct Reference

#include <xkbcommon.h>

Public Member Functions

XKB_EXPORT struct xkb_state_machinexkb_state_machine_new (struct xkb_keymap *keymap, const struct xkb_state_machine_options *options)
 
XKB_EXPORT struct xkb_state_machinexkb_state_machine_ref (struct xkb_state_machine *sm)
 
XKB_EXPORT void xkb_state_machine_unref (struct xkb_state_machine *sm)
 
XKB_EXPORT struct xkb_keymapxkb_state_machine_get_keymap (const struct xkb_state_machine *sm)
 
XKB_EXPORT int xkb_state_machine_update_controls (struct xkb_state_machine *sm, struct xkb_event_iterator *events, enum xkb_keyboard_controls affect, enum xkb_keyboard_controls controls)
 
XKB_EXPORT int xkb_state_machine_update_key (struct xkb_state_machine *sm, struct xkb_event_iterator *events, xkb_keycode_t key, enum xkb_key_direction direction)
 
XKB_EXPORT int xkb_state_machine_update_latched_locked (struct xkb_state_machine *sm, struct xkb_event_iterator *events, xkb_mod_mask_t affect_latched_mods, xkb_mod_mask_t latched_mods, bool affect_latched_layout, int32_t latched_layout, xkb_mod_mask_t affect_locked_mods, xkb_mod_mask_t locked_mods, bool affect_locked_layout, int32_t locked_layout)
 

Detailed Description

Opaque keyboard state machine object.

State machine objects contain the active state of a keyboard (or keyboards) at the server side. It acts as a simple state machine, wherein key presses and releases are the input, and keyboard events are the output.

This API is intended for server applications; see Server State and Client State for details.

See the example for a Wayland server in the quick guide.

Since
1.14.0

The documentation for this struct was generated from the following file: