Re-exports
Modules
Structs
Top level library context object.
Iterator to a Context include paths
Compiled keymap object.
iterator to the layouts in Keymap
iterator to the leds in a Keymap
iterator to the modifiers in a Keymap
Keyboard state object.
Enums
Specifies the direction of the key (press / release).
Constants
Create this context with an empty include path.
Don’t take RMLVO names from the environment.
Do not apply any context flags.
Do not apply any flags.
The current/classic XKB text format, as generated by xkbcomp -xkb.
Get the keymap as a string in the format from which it was created.
Depressed layout, i.e. a key is physically holding it.
Effective layout, i.e. currently active and affects key processing
(derived from the other state components).
Use this unless you explictly care how the state came about.
Latched layout, i.e. will be unset after the next non-modifier
key press.
Locked layout, i.e. will be unset after the key provoking the lock
has been pressed again.
LEDs (derived from the other state components).
Returns true if all of the modifiers are active.
Returns true if any of the modifiers are active.
Makes matching non-exclusive, i.e. will not return false if a
modifier not specified in the arguments is active.
Depressed modifiers, i.e. a key is physically holding them.
Effective modifiers, i.e. currently active and affect key
processing (derived from the other state components).
Use this unless you explictly care how the state came about.
Latched modifiers, i.e. will be unset after the next non-modifier
key press.
Locked modifiers, i.e. will be unset after the key provoking the
lock has been pressed again.
Functions
Test whether a value is a valid extended keycode.
@sa xkb_keycode_t
Names to compile a keymap with, also known as RMLVO.
Get a keysym from its name.
Get the name of a keysym.
Get the Unicode/UTF-8 representation of a keysym.
Get the Unicode/UTF-32 representation of a keysym.
Type Definitions
Flags for context creation.
A number used to represent a physical key on a keyboard.
Flags for keymap compilation.
The possible keymap formats.
A number used to represent the symbols generated from a key on a keyboard.
Index of a keyboard layout.
A mask of layout indices
Index of a keyboard LED.
A mask of LED indices.
Index of a shift level.
Index of a modifier.
A mask of modifier indices.
Modifier and layout types for state objects. This enum is bitmaskable,
e.g. (xkb::STATE_MODS_DEPRESSED | xkb::STATE_MODS_LATCHED) is valid to
exclude locked modifiers.
Match flags for xkb_state_mod_indices_are_active and
xkb_state_mod_names_are_active, specifying how the conditions for a
successful match. xkb::STATE_MATCH_NON_EXCLUSIVE is bitmaskable with
the other modes.