StreetLight
/
libxkbcommon
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: reorder "Keymap Components" functions 

Put the general keymap stuff before key-specific functions.

Signed-off-by: Ran Benita <ran234@gmail.com>
master
Ran Benita 2014-09-19 12:35:52 +03:00
parent 494e318946
commit 1ba7d9ecda
2 changed files with 38 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
xkbcommon.map
View File

@ -36,12 +36,12 @@ global:
xkb_keymap_num_layouts; xkb_keymap_num_layouts;
xkb_keymap_layout_get_name; xkb_keymap_layout_get_name;
xkb_keymap_layout_get_index; 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_num_leds;
xkb_keymap_led_get_name; xkb_keymap_led_get_name;
xkb_keymap_led_get_index; 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_keymap_key_repeats;
xkb_state_new; xkb_state_new;
xkb_state_ref; xkb_state_ref;

70
xkbcommon/xkbcommon.h
View File

@ -1005,6 +1005,41 @@ xkb_keymap_layout_get_name(struct xkb_keymap *keymap, xkb_layout_index_t idx);
xkb_layout_index_t xkb_layout_index_t
xkb_keymap_layout_get_index(struct xkb_keymap *keymap, const char *name); 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. * 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, xkb_level_index_t level,
const xkb_keysym_t **syms_out); 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. * Determine whether a key should repeat or not.
* *