mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-11-26 07:33:47 +00:00
Code Issues Releases Activity

Improve `keymap-set-after' documentation

Browse Source 
* doc/lispref/keymaps.texi (Changing Key Bindings): Mention `key-valid-p'
(Modifying Menus): Correct description of KEY arg.
This commit is contained in:
Robert Pluim 2023-01-19 15:56:21 +01:00
parent c7e02eaa3d
commit 8904a26a9d
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/lispref/keymaps.texi
View File

@ -1378,7 +1378,8 @@ Binding Conventions}).
or if @var{key} is not a valid key. or if @var{key} is not a valid key.
@var{key} is a string representing a single key or a series of key @var{key} is a string representing a single key or a series of key
strokes. Key strokes are separated by a single space character. strokes, and must satisfy @code{key-valid-p}. Key strokes are
separated by a single space character.
Each key stroke is either a single character, or the name of an Each key stroke is either a single character, or the name of an
event, surrounded by angle brackets. In addition, any key stroke event, surrounded by angle brackets. In addition, any key stroke
@ -1413,6 +1414,7 @@ The only keys that have a special shorthand syntax are @kbd{NUL},
The modifiers have to be specified in alphabetical order: The modifiers have to be specified in alphabetical order:
@samp{A-C-H-M-S-s}, which is @samp{Alt-Control-Hyper-Meta-Shift-super}. @samp{A-C-H-M-S-s}, which is @samp{Alt-Control-Hyper-Meta-Shift-super}.
@findex keymap-set
@defun keymap-set keymap key binding @defun keymap-set keymap key binding
This function sets the binding for @var{key} in @var{keymap}. (If This function sets the binding for @var{key} in @var{keymap}. (If
@var{key} is more than one event long, the change is actually made @var{key} is more than one event long, the change is actually made
@ -3079,13 +3081,13 @@ the menu. To put it elsewhere in the menu, use @code{keymap-set-after}:
@defun keymap-set-after map key binding &optional after @defun keymap-set-after map key binding &optional after
Define a binding in @var{map} for @var{key}, with value @var{binding}, Define a binding in @var{map} for @var{key}, with value @var{binding},
just like @code{define-key}, but position the binding in @var{map} after just like @code{define-key}, but position the binding in @var{map} after
the binding for the event @var{after}. The argument @var{key} should be the binding for the event @var{after}. The argument @var{key} should
of length one---a vector or string with just one element. But represent a single menu item or key, and @var{after} should be a
@var{after} should be a single event type---a symbol or a character, not single event type---a symbol or a character, not a sequence. The new
a sequence. The new binding goes after the binding for @var{after}. If binding goes after the binding for @var{after}. If @var{after} is
@var{after} is @code{t} or is omitted, then the new binding goes last, at @code{t} or is omitted, then the new binding goes last, at the end of
the end of the keymap. However, new bindings are added before any the keymap. However, new bindings are added before any inherited
inherited keymap. keymap.
Here is an example: Here is an example: