libxkbcommon 1.13.0
Library implementing the XKB specification for parsing keyboard descriptions and handling keyboard state
Loading...
Searching...
No Matches
Public Member Functions
xkb_machine_builder Struct Reference

#include <xkbcommon.h>

Public Member Functions

XKB_EXPORT struct xkb_machine_builderxkb_machine_builder_new (struct xkb_keymap *keymap, enum xkb_machine_builder_flags flags)
 
XKB_EXPORT void xkb_machine_builder_destroy (struct xkb_machine_builder *builder)
 
XKB_EXPORT struct xkb_keymapxkb_machine_builder_get_keymap (const struct xkb_machine_builder *builder)
 
XKB_EXPORT enum xkb_error_code xkb_machine_builder_update_a11y_flags (struct xkb_machine_builder *builder, enum xkb_a11y_flags affect, enum xkb_a11y_flags flags)
 
XKB_EXPORT enum xkb_error_code xkb_machine_builder_remap_mods (struct xkb_machine_builder *builder, xkb_mod_mask_t source, xkb_mod_mask_t target)
 
XKB_EXPORT enum xkb_error_code xkb_machine_builder_update_shortcut_mods (struct xkb_machine_builder *builder, xkb_mod_mask_t affect, xkb_mod_mask_t mask)
 
XKB_EXPORT enum xkb_error_code xkb_machine_builder_remap_shortcut_layout (struct xkb_machine_builder *builder, xkb_layout_index_t source, xkb_layout_index_t target)
 

Detailed Description

Opaque builder object to configure an xkb_machine.

Create with xkb_machine_builder_new(), configure with the xkb_machine_builder_* functions, then build the state machine with xkb_machine::xkb_machine_new(). The builder object may be reused to create multiple xkb_machine objects and destroyed when no longer needed. If a single xkb_machine object is built, then the builder may be destroyed immediately after xkb_machine::xkb_machine_new() returns.

Since
1.14.0
See also
xkb_machine_builder::xkb_machine_builder_new()
xkb_machine::xkb_machine_new()

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