xkb_state_update Struct Reference

#include <xkbcommon.h>

Collaboration diagram for xkb_state_update:

Data Fields
size_t	size
const struct xkb_state_components_update *	components
const struct xkb_layout_policy_update *	layout_policy

Detailed Description

Request to process an out-of-band atomic update through an xkb_machine or xkb_state.

Used with xkb_state::xkb_state_update_synthetic() and xkb_machine::xkb_machine_process_synthetic() to atomically apply any combination of:

• Latched and locked modifier and layout changes (via components)
• Boolean keyboard control changes (via components)
• Parameterized keyboard control changes (via layout_policy)

A NULL pointer means “not set / no change”.

Since

1.14.0

See also

xkb_state::xkb_state_update_synthetic()

xkb_machine::xkb_machine_process_synthetic()

xkb_state_components_update

xkb_layout_policy_update

Field Documentation

size

size_t xkb_state_update::size

Size of this structure, for forward-compatibility.

Must be set to sizeof(struct xkb_state_update). If the caller’s size exceeds the library’s (e.g. version mismatch), an error is returned unless all extra bytes are zero.

components

const struct xkb_state_components_update* xkb_state_update::components

Components updates, or NULL for no change.

See also

xkb_state_component

layout_policy

const struct xkb_layout_policy_update* xkb_state_update::layout_policy

Out-of-range layout policy update, or NULL for no change.

See also

xkb_layout_out_of_range_policy

---

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

• include/xkbcommon/xkbcommon.h