imcontext: Improve the docs
authorMatthias Clasen <mclasen@redhat.com>
Tue, 13 Jul 2021 11:10:01 +0000 (07:10 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Wed, 14 Jul 2021 02:03:23 +0000 (22:03 -0400)
Add more details about supported input methods.

gtk/gtkimcontextsimple.c

index 68253797d9d006fc82659a9c98990f0aeb8b0d8e..71832056460adc669a2862b786fc6e4e5bbbd672 100644 (file)
@@ -40,6 +40,8 @@
  *
  * `GtkIMContextSimple` is an input method supporting table-based input methods.
  *
+ * ## Compose sequences
+ *
  * `GtkIMContextSimple` reads compose sequences from the first of the
  * following files that is found: ~/.config/gtk-4.0/Compose, ~/.XCompose,
  * /usr/share/X11/locale/$locale/Compose (for locales that have a nontrivial
  * If none of these files is found, `GtkIMContextSimple` uses a built-in table
  * of compose sequences that is derived from the X11 Compose files.
  *
+ * Note that compose sequences typically start with the Compose_key, which is
+ * often not available as a dedicated key on keyboards. Keyboard layouts may
+ * map this keysym to other keys, such as the right Control key.
+ *
  * ## Unicode characters
  *
  * `GtkIMContextSimple` also supports numeric entry of Unicode characters
  *     Ctrl-Shift-u 1 2 3 Enter
  *
  * yields U+0123 LATIN SMALL LETTER G WITH CEDILLA, i.e. ģ.
+ *
+ * ## Dead keys
+ *
+ * `GtkIMContextSimple` supports dead keys. For example, typing
+ *
+ *     dead_acute a
+ *
+ *  yields U+00E! LATIN SMALL LETTER_A WITH ACUTE, i.e. á. Note that this
+ *  depends on the keyboard layout including dead keys.
  */
 
 struct _GtkIMContextSimplePrivate