procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

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

Browse source 
* doc/lispref/commands.texi (Misc Events):
This commit is contained in:
Yuuki Harano 2022-01-07 21:13:16 +09:00
parent d4e48c3642
commit a263824ae3
1 changed files with 15 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
doc/lispref/commands.texi
View 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