libxkbcommon 1.13.0
Library implementing the XKB specification for parsing keyboard descriptions and handling keyboard state
Loading...
Searching...
No Matches
Data Fields
xkb_layout_policy_update Struct Reference

#include <xkbcommon.h>

Data Fields

size_t size
 
enum xkb_layout_out_of_range_policy 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.

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.

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

◆ policy

enum xkb_layout_out_of_range_policy xkb_layout_policy_update::policy

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

See also
xkb_layout_out_of_range_policy

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


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