aboutsummaryrefslogtreecommitdiff
path: root/xkbcommon
diff options
context:
space:
mode:
authorHaibo Huang <hhb@google.com>2020-11-24 20:52:35 -0800
committerElliott Hughes <enh@google.com>2021-01-25 10:21:07 -0800
commit91f38399c2ea2fca0a88d624fc72d203df0e108a (patch)
treefb7f4b6e3a06f43f823ea3e298418084e0a7175b /xkbcommon
parentcda6b377eb5ce92136d53566702110c00b76cff8 (diff)
downloadlibxkbcommon-91f38399c2ea2fca0a88d624fc72d203df0e108a.tar.gz
Upgrade libxkbcommon to xkbcommon-1.0.3
1. Run meson build locally: meson config -Denable-x11=false -Denable-wayland=false -Denable-docs=false cd config ninja 2. Remove #defines for missing functions Test: make Change-Id: Ia109e0203569acb6380e2147c095fae57782fb72
Diffstat (limited to 'xkbcommon')
-rw-r--r--xkbcommon/xkbcommon.h12
1 files changed, 12 insertions, 0 deletions
diff --git a/xkbcommon/xkbcommon.h b/xkbcommon/xkbcommon.h
index d6a02a7..ee7143c 100644
--- a/xkbcommon/xkbcommon.h
+++ b/xkbcommon/xkbcommon.h
@@ -208,6 +208,15 @@ typedef uint32_t xkb_keysym_t;
* Therefore, it is not safe to use the name as a unique identifier for a
* layout. Layout names are case-sensitive.
*
+ * Layout names are specified in the layout's definition, for example
+ * "English (US)". These are different from the (conventionally) short names
+ * which are used to locate the layout, for example "us" or "us(intl)". These
+ * names are not present in a compiled keymap.
+ *
+ * If the user selects layouts from a list generated from the XKB registry
+ * (using libxkbregistry or directly), and this metadata is needed later on, it
+ * is recommended to store it along with the keymap.
+ *
* Layouts are also called "groups" by XKB.
*
* @sa xkb_keymap_num_layouts() xkb_keymap_num_layouts_for_key()
@@ -1087,6 +1096,7 @@ xkb_keymap_num_layouts(struct xkb_keymap *keymap);
* a name, returns NULL.
*
* @sa xkb_layout_index_t
+ * For notes on layout names.
* @memberof xkb_keymap
*/
const char *
@@ -1099,6 +1109,8 @@ xkb_keymap_layout_get_name(struct xkb_keymap *keymap, xkb_layout_index_t idx);
* XKB_LAYOUT_INVALID. If more than one layout in the keymap has this name,
* returns the lowest index among them.
*
+ * @sa xkb_layout_index_t
+ * For notes on layout names.
* @memberof xkb_keymap
*/
xkb_layout_index_t