summaryrefslogtreecommitdiff
path: root/gdk/gdkkeyuni.c
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2020-06-22 13:24:34 -0400
committerMatthias Clasen <mclasen@redhat.com>2020-06-22 13:24:34 -0400
commitc6fe8818ed848349524b170aa27c90199c7c3c09 (patch)
treee2ad55b0141c0731dc0734d4c688d545338dd646 /gdk/gdkkeyuni.c
parent2df139cf4009e30fe76d7b9b3720c57d6b509662 (diff)
downloadgtk+-c6fe8818ed848349524b170aa27c90199c7c3c09.tar.gz
gdk: Clarify the docs of gdk_keyval_to_unicode
Explicitly state that the conversion does not take locale into account, and point out GDK_KEY_KP_Decimal as a candidate for special-casing.
Diffstat (limited to 'gdk/gdkkeyuni.c')
-rw-r--r--gdk/gdkkeyuni.c10
1 files changed, 7 insertions, 3 deletions
diff --git a/gdk/gdkkeyuni.c b/gdk/gdkkeyuni.c
index 863d2b4935..77261de6bf 100644
--- a/gdk/gdkkeyuni.c
+++ b/gdk/gdkkeyuni.c
@@ -878,11 +878,15 @@ static const struct {
/**
* gdk_keyval_to_unicode:
- * @keyval: a GDK key symbol
- *
+ * @keyval: a GDK key symbol
+ *
* Convert from a GDK key symbol to the corresponding ISO10646 (Unicode)
* character.
- *
+ *
+ * Note that the conversion does not take the current locale
+ * into consideration, which might be expected for particular
+ * keyvals, such as %GDK_KEY_KP_Decimal.
+ *
* Returns: the corresponding unicode character, or 0 if there
* is no corresponding character.
**/