Commit 5734339f authored by Stefan Monnier's avatar Stefan Monnier

* doc/lispref/keymaps.texi (Extended Menu Items, Easy Menu) <:key-sequence>:

Clarify the documentation further
parent 14a570af
Pipeline #5317 passed with stage
in 55 minutes and 53 seconds
......@@ -2223,14 +2223,11 @@ right value for selecting that button. Clicking on the button should
set the variable so that the button you clicked on becomes selected.
@item :key-sequence @var{key-sequence}
This property specifies which key sequence is likely to be bound to the
same command invoked by this menu item. If you specify a correct key
sequence, that sequence will be preferred over others.
If you specify an incorrect key sequence, it has no effect; before Emacs
displays @var{key-sequence} in the menu, it verifies that
@var{key-sequence} is really equivalent to this menu item. Specifying
@code{nil} for @var{key-sequence} is equivalent to the
This property specifies which key sequence to display as keyboard equivalent.
Before Emacs displays @var{key-sequence} in the menu, it verifies that
@var{key-sequence} is really equivalent to this menu item, so it only
has an effect if you specify a correct key sequence.
Specifying @code{nil} for @var{key-sequence} is equivalent to the
@code{:key-sequence} attribute being absent.
@item :keys @var{string}
......@@ -2913,17 +2910,17 @@ the following:
@table @code
@item :keys @var{keys}
@var{keys} is a keyboard equivalent to the menu item (a string). This
is normally not needed, as keyboard equivalents are computed
@var{keys} is a string to display as keyboard equivalent to the menu item.
This is normally not needed, as keyboard equivalents are computed
automatically. @var{keys} is expanded with
@code{substitute-command-keys} before it is displayed (@pxref{Keys in
Documentation}).
@item :key-sequence @var{keys}
@var{keys} is a hint for speeding up Emacs's first display of the
menu. It should be @code{nil} if you know that the menu item has no keyboard
equivalent; otherwise it should be a string or vector specifying a
keyboard equivalent for the menu item.
@var{keys} is a hint indicating which key sequence to display as
keyboard equivalent, in case the command is bound to several key sequences.
It has no effect if @var{keys} is not bound to same command as this
menu item.
@item :active @var{enable}
@var{enable} is an expression; if it evaluates to @code{nil}, the item
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment