xkb_rmlvo_builder Struct Reference

#include <xkbcommon.h>

Public Member Functions
XKB_EXPORT struct xkb_rmlvo_builder *	xkb_rmlvo_builder_new (struct xkb_context *context, const char *rules, const char *model, enum xkb_rmlvo_builder_flags flags)
XKB_EXPORT bool	xkb_rmlvo_builder_append_layout (struct xkb_rmlvo_builder *rmlvo, const char *layout, const char *variant, const char *const *options, size_t options_len)
XKB_EXPORT bool	xkb_rmlvo_builder_append_option (struct xkb_rmlvo_builder *rmlvo, const char *option)
XKB_EXPORT struct xkb_rmlvo_builder *	xkb_rmlvo_builder_ref (struct xkb_rmlvo_builder *rmlvo)
XKB_EXPORT void	xkb_rmlvo_builder_unref (struct xkb_rmlvo_builder *rmlvo)

Detailed Description

Opaque RMLVO configuration object.

It denotes the configuration values by which a user picks a keymap.

Ownership:

_Shared_ ownership using reference counting. Heap-allocated by xkb_rmlvo_builder_new(), which creates the first reference. Take additional references with xkb_rmlvo_builder_ref() and release each of them with exactly one xkb_rmlvo_builder_unref() call. The object is destroyed once its last reference has been released.

Owns a reference to the xkb_context passed during initialization, kept for the entire lifetime of the xkb_rmlvo_builder instance and released when calling xkb_rmlvo_builder_unref().

Invariant

The referenced xkb_context remains valid for the entire lifetime of an xkb_rmlvo_builder instance thanks to reference counting on xkb_context. You may release your own reference as soon as the xkb_rmlvo_builder is created.

See also

Introduction to RMLVO

Rules

Since

1.11.0

---

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

• include/xkbcommon/xkbcommon.h