xkb_layout_policy_update Struct Reference

#include <xkbcommon.h>

Data Fields
size_t	size
uint32_t	policy
xkb_layout_index_t	redirect

Detailed Description

Configures the policy used to bring out-of-range layout indices into range.

If policy is XKB_LAYOUT_OUT_OF_RANGE_REDIRECT, redirect specifies the target layout index; otherwise redirect is ignored.

Note

This struct uses a size-based versioning scheme to allow forward and backward compatibility between callers and the library:

Older callers (smaller struct)

Trailing fields unknown to the caller default to zero in the library.

Newer callers (larger struct)

Accepted only if all trailing bytes unknown to the library are zero.

Precondition

The struct MUST be initialized with memset() before setting any fields:

struct xkb_layout_policy_update update;
memset(&update, 0, sizeof(update));
update.size = sizeof(update);
update.policy = …;

Invariant

size MUST be explicitly set to sizeof(struct xkb_layout_policy_update).

All bytes of the struct, including padding, MUST remain zero except for explicitly assigned fields.

Since

1.14.0

See also

xkb_layout_out_of_range_policy

xkb_state_update::layout_policy

Field Documentation

size

size_t xkb_layout_policy_update::size

Size of this structure, for forward-compatibility.

See also

XKB_ERROR_ABI_INVALID_STRUCT_SIZE

XKB_ERROR_ABI_BACKWARD_COMPAT

XKB_ERROR_ABI_FORWARD_COMPAT

Since

1.14.0

policy

uint32_t xkb_layout_policy_update::policy

Policy to use to handle out-of-range layout indices.

See also

xkb_layout_out_of_range_policy

Since

1.14.0

redirect

xkb_layout_index_t xkb_layout_policy_update::redirect

Layout index to redirect to when policy is XKB_LAYOUT_OUT_OF_RANGE_REDIRECT.

Ignored otherwise.

Since

1.14.0

---

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

• include/xkbcommon/xkbcommon.h