From 1ba7d9ecda5e32de121b4e72486df4d0a262b029 Mon Sep 17 00:00:00 2001 From: Ran Benita Date: Fri, 19 Sep 2014 12:35:52 +0300 Subject: [PATCH] doc: reorder "Keymap Components" functions Put the general keymap stuff before key-specific functions. Signed-off-by: Ran Benita --- xkbcommon.map | 6 ++-- xkbcommon/xkbcommon.h | 70 +++++++++++++++++++++---------------------- 2 files changed, 38 insertions(+), 38 deletions(-) diff --git a/xkbcommon.map b/xkbcommon.map index 919c0dc..28122b4 100644 --- a/xkbcommon.map +++ b/xkbcommon.map @@ -36,12 +36,12 @@ global: xkb_keymap_num_layouts; xkb_keymap_layout_get_name; xkb_keymap_layout_get_index; - xkb_keymap_num_layouts_for_key; - xkb_keymap_num_levels_for_key; - xkb_keymap_key_get_syms_by_level; xkb_keymap_num_leds; xkb_keymap_led_get_name; xkb_keymap_led_get_index; + xkb_keymap_num_layouts_for_key; + xkb_keymap_num_levels_for_key; + xkb_keymap_key_get_syms_by_level; xkb_keymap_key_repeats; xkb_state_new; xkb_state_ref; diff --git a/xkbcommon/xkbcommon.h b/xkbcommon/xkbcommon.h index a7ea076..c3cde41 100644 --- a/xkbcommon/xkbcommon.h +++ b/xkbcommon/xkbcommon.h @@ -1005,6 +1005,41 @@ xkb_keymap_layout_get_name(struct xkb_keymap *keymap, xkb_layout_index_t idx); xkb_layout_index_t xkb_keymap_layout_get_index(struct xkb_keymap *keymap, const char *name); +/** + * Get the number of LEDs in the keymap. + * + * @warning The range [ 0...xkb_keymap_num_leds() ) includes all of the LEDs + * in the keymap, but may also contain inactive LEDs. When iterating over + * this range, you need the handle this case when calling functions such as + * xkb_keymap_led_get_name() or xkb_state_led_index_is_active(). + * + * @sa xkb_led_index_t + * @memberof xkb_keymap + */ +xkb_led_index_t +xkb_keymap_num_leds(struct xkb_keymap *keymap); + +/** + * Get the name of a LED by index. + * + * @returns The name. If the index is invalid, returns NULL. + * + * @memberof xkb_keymap + */ +const char * +xkb_keymap_led_get_name(struct xkb_keymap *keymap, xkb_led_index_t idx); + +/** + * Get the index of a LED by name. + * + * @returns The index. If no LED with this name exists, returns + * XKB_LED_INVALID. + * + * @memberof xkb_keymap + */ +xkb_led_index_t +xkb_keymap_led_get_index(struct xkb_keymap *keymap, const char *name); + /** * Get the number of layouts for a specific key. * @@ -1067,41 +1102,6 @@ xkb_keymap_key_get_syms_by_level(struct xkb_keymap *keymap, xkb_level_index_t level, const xkb_keysym_t **syms_out); -/** - * Get the number of LEDs in the keymap. - * - * @warning The range [ 0...xkb_keymap_num_leds() ) includes all of the LEDs - * in the keymap, but may also contain inactive LEDs. When iterating over - * this range, you need the handle this case when calling functions such as - * xkb_keymap_led_get_name() or xkb_state_led_index_is_active(). - * - * @sa xkb_led_index_t - * @memberof xkb_keymap - */ -xkb_led_index_t -xkb_keymap_num_leds(struct xkb_keymap *keymap); - -/** - * Get the name of a LED by index. - * - * @returns The name. If the index is invalid, returns NULL. - * - * @memberof xkb_keymap - */ -const char * -xkb_keymap_led_get_name(struct xkb_keymap *keymap, xkb_led_index_t idx); - -/** - * Get the index of a LED by name. - * - * @returns The index. If no LED with this name exists, returns - * XKB_LED_INVALID. - * - * @memberof xkb_keymap - */ -xkb_led_index_t -xkb_keymap_led_get_index(struct xkb_keymap *keymap, const char *name); - /** * Determine whether a key should repeat or not. *