diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/commands.texi | 41 |
1 files changed, 17 insertions, 24 deletions
diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi index 32b4df6b3bf..01565727e15 100644 --- a/doc/lispref/commands.texi +++ b/doc/lispref/commands.texi | |||
| @@ -2670,35 +2670,28 @@ size of the object beneath the gesture: image, window, etc. | |||
| 2670 | 2670 | ||
| 2671 | @cindex @code{low-level-key} event | 2671 | @cindex @code{low-level-key} event |
| 2672 | @item (low-level-key @var{is-key-press} @var{key} @var{modifier} @var{time} @var{frame}) | 2672 | @item (low-level-key @var{is-key-press} @var{key} @var{modifier} @var{time} @var{frame}) |
| 2673 | This event is sent on the physical press or release of keys, only on GUI | 2673 | This event is sent on the physical press or release of keys, only on |
| 2674 | systems, currently X, MS-Windows and PGTK, and only if the variable | 2674 | systems where it is supported, currently X, MS-Windows and PGTK, and |
| 2675 | @code{enable-low-level-key-events} has a non-@code{nil} value. See its | 2675 | only if the variable @code{enable-low-level-key-events} has a |
| 2676 | documentation for the values it can take, that allow to filter which | 2676 | non-@code{nil} value. See its documentation for the values to use, that |
| 2677 | keys should generate this kind of event. | 2677 | can activate the events for all or some keys. |
| 2678 | 2678 | ||
| 2679 | @var{is-key-press} is @code{t} for a key press, @code{nil} for a key release. | 2679 | @var{is-key-press} is @code{t} for a key press, @code{nil} for a key |
| 2680 | @var{time} is the event's time in milliseconds, @var{frame} is the | 2680 | release. @var{time} is the event's time in milliseconds, as reported by |
| 2681 | frame receiving it. @var{modifier} is @code{nil} if the key is not a | 2681 | the underlying platform, and should only be used to measure time |
| 2682 | intervals between events of this same kind. @var{frame} is the frame | ||
| 2683 | receiving the event. @var{modifier} is @code{nil} if the key is not a | ||
| 2682 | modifier key, @code{t} if it is, but it is unknown which one, or one of | 2684 | modifier key, @code{t} if it is, but it is unknown which one, or one of |
| 2683 | @code{shift}, @code{control}, @code{meta}, @code{alt}, @code{super}, | 2685 | @code{shift}, @code{control}, @code{meta}, @code{alt}, @code{super}, |
| 2684 | @code{hyper}. | 2686 | @code{hyper}. |
| 2685 | 2687 | ||
| 2686 | @var{key}, an integer, identifies the key pressed or released. This | 2688 | @var{key}, an integer, identifies the key pressed or released. This |
| 2687 | number is platform dependent, but there are variables for most keys that | 2689 | number is platform dependent. |
| 2688 | can be used in place of the numbers to identify them. For example, the | 2690 | |
| 2689 | variable @code{xk-backspace} identifies the @key{backspace} key. | 2691 | This is a special event (@pxref{Special Events}), ignored by |
| 2690 | 2692 | default. Loading @file{low-level-key.el} sets a handler | |
| 2691 | The names are parallel to those for KeySyms on X, as defined in | 2693 | that can generate normal input events for key press, release and multi |
| 2692 | @file{xkeysymdef.h}. For example, @code{XK_Shift_L} (the left shift | 2694 | tap. See the function @code{llk-bind}. |
| 2693 | key), corresponds to @code{xk-shift-l}. The @file{xkeysymdef.h} file | ||
| 2694 | defines different KeySyms for capital and small versions of letters. | ||
| 2695 | For this event, only the capital version is used, with the variables | ||
| 2696 | @code{xk-a}, @code{xk-b}, etc. | ||
| 2697 | |||
| 2698 | These variables are initialized by calling the function @code{llk-init}. | ||
| 2699 | This function also binds a handler to this event, which allows to detect | ||
| 2700 | double taps on keys (normally modifier keys) and bind commands or | ||
| 2701 | functions to be run. See the function @code{llk-bind}. | ||
| 2702 | 2695 | ||
| 2703 | @cindex @code{preedit-text} event | 2696 | @cindex @code{preedit-text} event |
| 2704 | @item (preedit-text @var{arg}) | 2697 | @item (preedit-text @var{arg}) |