diff options
| author | Stefan Monnier | 2020-04-10 17:04:19 -0400 |
|---|---|---|
| committer | Stefan Monnier | 2020-04-10 17:04:19 -0400 |
| commit | 6057d79a4eb4b95037068a1e9335a2418b2da5ec (patch) | |
| tree | 4c918669925009dd3c40ab63f515a602c87e8a55 /doc | |
| parent | 17a1bb5a032025d29413d5ad9316d3d001da3166 (diff) | |
| download | emacs-6057d79a4eb4b95037068a1e9335a2418b2da5ec.tar.gz emacs-6057d79a4eb4b95037068a1e9335a2418b2da5ec.zip | |
* doc/lispref/keymaps.texi (Extended Menu Items): Tweak :key-sequence
Don't make it sound like `:key-sequence nil` is any different than the
absence of `:key-sequence`. And the performance advantage of
`:key-sequence` disappeared long ago.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/keymaps.texi | 16 |
1 files changed, 3 insertions, 13 deletions
diff --git a/doc/lispref/keymaps.texi b/doc/lispref/keymaps.texi index 259efea3248..f3c984848e7 100644 --- a/doc/lispref/keymaps.texi +++ b/doc/lispref/keymaps.texi | |||
| @@ -2224,23 +2224,13 @@ set the variable so that the button you clicked on becomes selected. | |||
| 2224 | 2224 | ||
| 2225 | @item :key-sequence @var{key-sequence} | 2225 | @item :key-sequence @var{key-sequence} |
| 2226 | This property specifies which key sequence is likely to be bound to the | 2226 | This property specifies which key sequence is likely to be bound to the |
| 2227 | same command invoked by this menu item. If you specify the right key | 2227 | same command invoked by this menu item. If you specify a correct key |
| 2228 | sequence, that makes preparing the menu for display run much faster. | 2228 | sequence, that sequence will be preferred over others. |
| 2229 | 2229 | ||
| 2230 | If you specify the wrong key sequence, it has no effect; before Emacs | 2230 | If you specify in incorrect key sequence, it has no effect; before Emacs |
| 2231 | displays @var{key-sequence} in the menu, it verifies that | 2231 | displays @var{key-sequence} in the menu, it verifies that |
| 2232 | @var{key-sequence} is really equivalent to this menu item. | 2232 | @var{key-sequence} is really equivalent to this menu item. |
| 2233 | 2233 | ||
| 2234 | @item :key-sequence nil | ||
| 2235 | This property indicates that there is normally no key binding which is | ||
| 2236 | equivalent to this menu item. Using this property saves time in | ||
| 2237 | preparing the menu for display, because Emacs does not need to search | ||
| 2238 | the keymaps for a keyboard equivalent for this menu item. | ||
| 2239 | |||
| 2240 | However, if the user has rebound this item's definition to a key | ||
| 2241 | sequence, Emacs ignores the @code{:keys} property and finds the keyboard | ||
| 2242 | equivalent anyway. | ||
| 2243 | |||
| 2244 | @item :keys @var{string} | 2234 | @item :keys @var{string} |
| 2245 | This property specifies that @var{string} is the string to display | 2235 | This property specifies that @var{string} is the string to display |
| 2246 | as the keyboard equivalent for this menu item. You can use | 2236 | as the keyboard equivalent for this menu item. You can use |