xkb_keymap_key_iterator_config Struct Reference

#include <xkbcommon.h>

Data Fields
uint32_t	size
uint32_t	flags
xkb_keycode_t	start

Detailed Description

Options for initializing an xkb_keymap_key_iterator.

Note

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

See also

xkb_keymap_key_iterator::xkb_keymap_key_iterator_init()

Since

1.14.0

Field Documentation

size

uint32_t xkb_keymap_key_iterator_config::size

Size of this structure in bytes.

See also

Extensible structure ABI contract

Since

1.14.0

flags

uint32_t xkb_keymap_key_iterator_config::flags

Flags to control the iterator behavior, or 0 (XKB_KEYMAP_KEY_ITERATOR_NO_FLAGS) for the default.

Since

1.14.0

start

xkb_keycode_t xkb_keymap_key_iterator_config::start

Keycode to start the iteration from.

This field is ignored if set to 0, in which case it defaults to:

• the highest keycode defined in the corresponding keymap if #flags contains XKB_KEYMAP_KEY_ITERATOR_DESCENDING_ORDER;
• otherwise the lowest defined keycode in the keymap.

Remarks

The resulting start keycode is not guaranteed to be returned by xkb_keymap_key_iterator::xkb_keymap_key_iterator_next(): it depends on:

• Whether the keycode is valid and the corresponding key is defined (i.e. has a name), otherwise it falls back to the next defined key in the specified direction, if any.
• The rest of the configuration, e.g. XKB_KEYMAP_KEY_ITERATOR_INCLUDE_UNBOUND.

Since

1.14.0

---

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

• include/xkbcommon/xkbcommon.h