procyberian/emacs
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Document `keymap-unset' in lispref

Browse source 
* doc/lispref/keymaps.texi (Changing Key Bindings): Document
keymap-unset.
This commit is contained in:
Robert Pluim 2023-03-17 14:16:00 +01:00
parent bb3e0ded9e
commit e4a7d0cd6e
1 changed files with 11 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

11
doc/lispref/keymaps.texi
View file

@ -1427,6 +1427,17 @@ If @var{key} is @kbd{<t>}, this sets the default binding in
@var{keymap}. When an event has no binding of its own, the Emacs @var{keymap}. When an event has no binding of its own, the Emacs
command loop uses the keymap's default binding, if there is one. command loop uses the keymap's default binding, if there is one.
@findex keymap-unset
@defun keymap-unset keymap key &optional remove
This function is the inverse of @code{keymap-set}, it unsets the
binding for @var{key} in @var{keymap}, which is the same as setting
the binding to @code{nil}. In order to instead remove the binding
completely, specify @var{remove} as non-nil. This only makes a
difference if @var{keymap} has a parent keymap. When unsetting a key
in a child map, it will still shadow the same key in the parent
keymap. Removing the binding will allow the key in the parent keymap
to be used.
@cindex invalid prefix key error @cindex invalid prefix key error
@cindex key sequence error @cindex key sequence error
Every prefix of @var{key} must be a prefix key (i.e., bound to a keymap) Every prefix of @var{key} must be a prefix key (i.e., bound to a keymap)