[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
master a263824ae3: Write documentation about ARG of the preedit-text eve
From: |
Yuuki Harano |
Subject: |
master a263824ae3: Write documentation about ARG of the preedit-text event on PGTK |
Date: |
Fri, 7 Jan 2022 07:18:28 -0500 (EST) |
branch: master
commit a263824ae36e69df74916980f448da245ee0f241
Author: Yuuki Harano <masm+github@masm11.me>
Commit: Yuuki Harano <masm+github@masm11.me>
Write documentation about ARG of the preedit-text event on PGTK
* doc/lispref/commands.texi (Misc Events):
---
doc/lispref/commands.texi | 16 +++++++++++++++-
1 file changed, 15 insertions(+), 1 deletion(-)
diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi
index 3c3b69c64d..fdbc05ce3d 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
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- master a263824ae3: Write documentation about ARG of the preedit-text event on PGTK,
Yuuki Harano <=