diff options
| author | Robert Pluim <rpluim@gmail.com> | 2023-01-19 15:56:21 +0100 |
|---|---|---|
| committer | Robert Pluim <rpluim@gmail.com> | 2023-01-20 15:14:44 +0100 |
| commit | 8904a26a9d227e464ac1c6b054a0e3cf1bfb3016 (patch) | |
| tree | 886eefae7040868703851ceb4949c21ab23e7112 /doc/lispref/keymaps.texi | |
| parent | c7e02eaa3d9af545f2acbb747da7a606fb0d1277 (diff) | |
| download | emacs-8904a26a9d227e464ac1c6b054a0e3cf1bfb3016.tar.gz | |
Improve `keymap-set-after' documentation
* doc/lispref/keymaps.texi (Changing Key Bindings): Mention `key-valid-p'
(Modifying Menus): Correct description of KEY arg.
Diffstat (limited to 'doc/lispref/keymaps.texi')
| -rw-r--r-- | doc/lispref/keymaps.texi | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/doc/lispref/keymaps.texi b/doc/lispref/keymaps.texi index 1c548af1990..7876780dcd4 100644 --- a/doc/lispref/keymaps.texi +++ b/doc/lispref/keymaps.texi @@ -1378,7 +1378,8 @@ Binding Conventions}). or if @var{key} is not a valid 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 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: @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 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 @@ -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 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 -the binding for the event @var{after}. The argument @var{key} should be -of length one---a vector or string with just one element. But -@var{after} should be a single event type---a symbol or a character, not -a sequence. The new binding goes after the binding for @var{after}. If -@var{after} is @code{t} or is omitted, then the new binding goes last, at -the end of the keymap. However, new bindings are added before any -inherited keymap. +the binding for the event @var{after}. The argument @var{key} should +represent a single menu item or key, and @var{after} should be a +single event type---a symbol or a character, not a sequence. The new +binding goes after the binding for @var{after}. If @var{after} is +@code{t} or is omitted, then the new binding goes last, at the end of +the keymap. However, new bindings are added before any inherited +keymap. Here is an example: |