From: Yuuki Harano <masm+github@masm11.me>
Date: Fri, 7 Jan 2022 12:13:16 +0000 (+0900)
Subject: Write documentation about ARG of the preedit-text event on PGTK
X-Git-Tag: archive/raspbian/1%29.2+1-2+rpi1^2~5^2~16^2~3650
X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=a263824ae36e69df74916980f448da245ee0f241;p=emacs.git

Write documentation about ARG of the preedit-text event on PGTK

* doc/lispref/commands.texi (Misc Events):
---

diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi
index 3c3b69c64d1..fdbc05ce3d6 100644
--- a/doc/lispref/commands.texi
+++ b/doc/lispref/commands.texi
@@ -2137,7 +2137,21 @@ of @var{arg} are dependent on the window system being used.
 
 On X, @var{arg} is a string describing some text to place behind the
 cursor.  It can be @code{nil}, which means to remove any text
-previously displayed.  @c FIXME: what is the value of ARG on PGTK?
+previously displayed.
+
+On PGTK, @var{arg} is a list of strings with color information.  Its
+structure is as follows:
+
+@example
+   (
+     (TEXT (ul . COLOR) (bg . COLOR) (fg . COLOR))
+     ; ...
+   )
+@end example
+
+Color information can be omitted.  @code{COLOR} of @code{ul} can be
+@code{t} or a string.  @var{arg} can be @code{nil}, which means to
+remove any text previously displayed.
 
 This is a special event (@pxref{Special Events}), which normally
 should not be bound by the user to any command.  Emacs will typically