Module smithay_client_toolkit::seat::keyboard

Utilities for keymap interpretation of keyboard input

This module provides an implementation for wl_keyboard objects using libxkbcommon to interpret the keyboard input given the user keymap.

The entry point of this module is the map_keyboard function which, given a wl_seat and a callback, setup keymap interpretation and key repetition for the wl_keyboard of this seat.

Key repetition relies on an event source, that needs to be inserted in your calloop event loop. Not doing so will prevent key repetition to work (but the rest of the functionnality will not be affected).

Modules

• ffi 🔒
• keysyms
• state 🔒

Structs

• KbdHandler 🔒
• KbdRepeat 🔒
• ModifiersState
  Represents the current state of the keyboard modifiers
• RMLVO
  The RMLVO description of a keymap
• RepeatData 🔒
• RepeatDetails 🔒
• RepeatSource
  An event source managing the key repetition of a keyboard

Enums

• Error
  An error that occurred while trying to initialize a mapped keyboard
• Event
  Events received from a mapped keyboard
• KeyState
  physical key state
• RepeatKind
  Possible kinds of key repetition

Constants

• MICROS_IN_SECOND 🔒

Functions

• map_keyboard
  Implement a keyboard for keymap translation with key repetition
• map_keyboard_repeat
  Implement a keyboard for keymap translation with key repetition
• rate_to_gap 🔒

Type Aliases

• KbdCallback 🔒