xkb_synthetic_update Struct Reference

#include <xkbcommon.h>

Collaboration diagram for xkb_synthetic_update:

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

Private Attributes
uint32_t	reserved0

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”.

Note

This struct uses a size-based versioning; see Extensible structure ABI contract for further details.

See also

xkb_state::xkb_state_update_synthetic()

xkb_machine::xkb_machine_process_synthetic()

struct xkb_state_components_update

struct xkb_layout_policy_update

Since

1.14.0

Field Documentation

size

uint32_t xkb_synthetic_update::size

Size of this structure in bytes.

See also

Extensible structure ABI contract

Since

1.14.0

reserved0

uint32_t xkb_synthetic_update::reserved0

private

Reserved for future extensions.

Precondition

Must be set to 0 by the caller.

components

const struct xkb_state_components_update* xkb_synthetic_update::components

Components updates, or NULL for no change.

See also

enum xkb_state_component

Since

1.14.0

layout_policy

const struct xkb_layout_policy_update* xkb_synthetic_update::layout_policy

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

See also

enum xkb_layout_out_of_range_policy

Since

1.14.0

---

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

• include/xkbcommon/xkbcommon.h