]> git.eshelyaron.com Git - emacs.git/commitdiff
Write documentation about ARG of the preedit-text event on PGTK
authorYuuki Harano <masm+github@masm11.me>
Fri, 7 Jan 2022 12:13:16 +0000 (21:13 +0900)
committerYuuki Harano <masm+github@masm11.me>
Fri, 7 Jan 2022 12:17:27 +0000 (21:17 +0900)
* doc/lispref/commands.texi (Misc Events):

doc/lispref/commands.texi

index 3c3b69c64d1eb36aff799968c59ce03ea7dc39fb..fdbc05ce3d62cd8d55756f4014742b5a9c738688 100644 (file)
@@ -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