Opaque compiled keymap object. More...

#include <xkbcommon.h>

Public Member Functions
struct xkb_keymap *	xkb_keymap_new_from_names (struct xkb_context context, const struct xkb_rule_names names, enum xkb_keymap_compile_flags flags)
	Create a keymap from RMLVO names.
struct xkb_keymap *	xkb_keymap_new_from_file (struct xkb_context context, FILE file, enum xkb_keymap_format format, enum xkb_keymap_compile_flags flags)
	Create a keymap from a keymap file.
struct xkb_keymap *	xkb_keymap_new_from_string (struct xkb_context context, const char string, enum xkb_keymap_format format, enum xkb_keymap_compile_flags flags)
	Create a keymap from a keymap string.
struct xkb_keymap *	xkb_keymap_ref (struct xkb_keymap *keymap)
	Take a new reference on a keymap.
void	xkb_keymap_unref (struct xkb_keymap *keymap)
	Release a reference on a keymap, and possibly free it.
char *	xkb_keymap_get_as_string (struct xkb_keymap *keymap, enum xkb_keymap_format format)
	Get the compiled keymap as a string.
xkb_mod_index_t	xkb_keymap_num_mods (struct xkb_keymap *keymap)
	Get the number of modifiers in the keymap.
const char *	xkb_keymap_mod_get_name (struct xkb_keymap *keymap, xkb_mod_index_t idx)
	Get the name of a modifier by index.
xkb_mod_index_t	xkb_keymap_mod_get_index (struct xkb_keymap keymap, const char name)
	Get the index of a modifier by name.
xkb_layout_index_t	xkb_keymap_num_layouts (struct xkb_keymap *keymap)
	Get the number of layouts in the keymap.
const char *	xkb_keymap_layout_get_name (struct xkb_keymap *keymap, xkb_layout_index_t idx)
	Get the name of a layout by index.
xkb_layout_index_t	xkb_keymap_layout_get_index (struct xkb_keymap keymap, const char name)
	Get the index of a layout by name.
xkb_layout_index_t	xkb_keymap_num_layouts_for_key (struct xkb_keymap *keymap, xkb_keycode_t key)
	Get the number of layouts for a specific key.
xkb_level_index_t	xkb_keymap_num_levels_for_key (struct xkb_keymap *keymap, xkb_keycode_t key, xkb_layout_index_t layout)
	Get the number of shift levels for a specific key and layout.
int	xkb_keymap_key_get_syms_by_level (struct xkb_keymap keymap, xkb_keycode_t key, xkb_layout_index_t layout, xkb_level_index_t level, const xkb_keysym_t *syms_out)
	Get the keysyms obtained from pressing a key in a given layout and shift level.
xkb_led_index_t	xkb_keymap_num_leds (struct xkb_keymap *keymap)
	Get the number of LEDs in the keymap.
const char *	xkb_keymap_led_get_name (struct xkb_keymap *keymap, xkb_led_index_t idx)
	Get the name of a LED by index.
xkb_led_index_t	xkb_keymap_led_get_index (struct xkb_keymap keymap, const char name)
	Get the index of a LED by name.
int	xkb_keymap_key_repeats (struct xkb_keymap *keymap, xkb_keycode_t key)
	Determine whether a key should repeat or not.

Detailed Description

Opaque compiled keymap object.

The keymap object holds all of the static keyboard information obtained from compiling XKB files.

A keymap is immutable after it is created (besides reference counts, etc.); if you need to change it, you must create a new one.

A keymap object is created, accessed and destroyed through the xkb_keymap_*() API.

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

/home/daniels/wayland/libxkbcommon/xkbcommon/xkbcommon.h

Public Member Functions

Detailed Description