From 67aed063f6460e8add0fcfdebf562a3062cc26a2 Mon Sep 17 00:00:00 2001 From: Cecilio Pardo Date: Mon, 2 Dec 2024 17:30:42 +0100 Subject: [PATCH] low-level-key-event: Minor doc style improvement * doc/lispref/commands.texi (Misc Events): Improve style and clarify the dependence on `enable-low-level-key-events`. * src/keyboard.c (syms_of_keyboard): Fix markup. --- doc/lispref/commands.texi | 7 +++++-- src/keyboard.c | 4 ++-- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi index f138788edab..32b4df6b3bf 100644 --- a/doc/lispref/commands.texi +++ b/doc/lispref/commands.texi @@ -2671,11 +2671,14 @@ size of the object beneath the gesture: image, window, etc. @cindex @code{low-level-key} event @item (low-level-key @var{is-key-press} @var{key} @var{modifier} @var{time} @var{frame}) This event is sent on the physical press or release of keys, only on GUI -systems, currently X, MS-Windows and PGTK. +systems, currently X, MS-Windows and PGTK, and only if the variable +@code{enable-low-level-key-events} has a non-@code{nil} value. See its +documentation for the values it can take, that allow to filter which +keys should generate this kind of event. @var{is-key-press} is @code{t} for a key press, @code{nil} for a key release. @var{time} is the event's time in milliseconds, @var{frame} is the -frame receiving it. @var{modifier} is @code{nil} if the key is not a +frame receiving it. @var{modifier} is @code{nil} if the key is not a modifier key, @code{t} if it is, but it is unknown which one, or one of @code{shift}, @code{control}, @code{meta}, @code{alt}, @code{super}, @code{hyper}. diff --git a/src/keyboard.c b/src/keyboard.c index 72727288216..4bf02a06696 100644 --- a/src/keyboard.c +++ b/src/keyboard.c @@ -13159,12 +13159,12 @@ The value configures the set of keys that are handled: If t, send events for all keys. If a number, send events for the corresponding keysym. When calling -'llk-init', a set of variables with the xk- prefix is initialized with +`llk-init', a set of variables with the xk- prefix is initialized with the numeric values for keysyms. Because this number are platform dependent, only the variables should be used to refer to a key. For example, the 'xk-backspace' variable refer to the backspace key, with the numeric value 0xff08 on X, and the 0x08 on MS-Windows. You can see -all defined variables on the variable 'llk-keysyms'. +all defined variables on the variable `llk-keysyms'. If a symbol, a predefined set of keys is selected. The only currently valid symbol is 'modifiers.