diff options
| author | Yuuki Harano <masm+github@masm11.me> | 2022-01-07 21:13:16 +0900 |
|---|---|---|
| committer | Yuuki Harano <masm+github@masm11.me> | 2022-01-07 21:17:27 +0900 |
| commit | a263824ae36e69df74916980f448da245ee0f241 (patch) | |
| tree | e2036d4513823101247dcb8ed5d55aa9cd6e8b38 /doc/lispref/commands.texi | |
| parent | d4e48c36420ec3a56c56f24cfa3888811b02e019 (diff) | |
| download | emacs-a263824ae36e69df74916980f448da245ee0f241.tar.gz emacs-a263824ae36e69df74916980f448da245ee0f241.tar.bz2 emacs-a263824ae36e69df74916980f448da245ee0f241.zip | |
Write documentation about ARG of the preedit-text event on PGTK
* doc/lispref/commands.texi (Misc Events):
Diffstat (limited to 'doc/lispref/commands.texi')
| -rw-r--r-- | doc/lispref/commands.texi | 16 |
1 files changed, 15 insertions, 1 deletions
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 |