xkb_keymap_key_iterator Struct Reference

#include <xkbcommon.h>

Public Member Functions
XKB_EXPORT enum xkb_status	xkb_keymap_key_iterator_init (struct xkb_keymap_key_iterator *iter, const struct xkb_keymap *keymap, const struct xkb_keymap_key_iterator_config *config)
XKB_EXPORT xkb_keycode_t	xkb_keymap_key_iterator_next (struct xkb_keymap_key_iterator *iter)

Private Attributes
const void *	opaque0
const void *	opaque1

Detailed Description

Iterator over a keymap’s keys.

Warning

This struct should be considered opaque: do not inspect nor modify its fields!

Ownership:

_Exclusive_ ownership. Instances are allocated and managed by the caller (typically on the stack) and must be initialized using xkb_keymap_key_iterator_init(). No explicit destruction is required by xkbcommon.

Borrows the xkb_keymap passed during initialization.

Invariant

The borrowed xkb_keymap must remain valid for the entire lifetime of an xkb_keymap_key_iterator instance.

See also

xkb_keycode_t

xkb_keymap_key_iterator_init()

Since

1.14.0

Field Documentation

opaque0

const void* xkb_keymap_key_iterator::opaque0

private

Opaque field: do not inspect nor modify it!

opaque1

const void* xkb_keymap_key_iterator::opaque1

private

Opaque field: do not inspect nor modify it!

---

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

• include/xkbcommon/xkbcommon.h