[gtk/keyval-to-uni-fix] gdk: Clarify the docs of gdk_keyval_to_unicode



commit c6fe8818ed848349524b170aa27c90199c7c3c09
Author: Matthias Clasen <mclasen redhat com>
Date:   Mon Jun 22 13:24:34 2020 -0400

    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.

 gdk/gdkkeyuni.c | 10 +++++++---
 1 file 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.
  **/


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]