The simpler and older way to define a menu keymap binding looks like this:
(item-string . real-binding)
The CAR, item-string, is the string to be displayed in the menu. It should be short--preferably one to three words. It should describe the action of the command it corresponds to.
You can also supply a second string, called the help string, as follows:
(item-string help-string . real-binding)
Currently Emacs does not actually use help-string; it knows only how to ignore help-string in order to extract real-binding. In the future we may use help-string as extended documentation for the menu item, available on request.
As far as define-key
is concerned, item-string and
help-string are part of the event's binding. However,
lookup-key
returns just real-binding, and only
real-binding is used for executing the key.
If real-binding is nil
, then item-string appears in
the menu but cannot be selected.
If real-binding is a symbol and has a non-nil
menu-enable
property, that property is an expression that
controls whether the menu item is enabled. Every time the keymap is
used to display a menu, Emacs evaluates the expression, and it enables
the menu item only if the expression's value is non-nil
. When a
menu item is disabled, it is displayed in a "fuzzy" fashion, and
cannot be selected.
The menu bar does not recalculate which items are enabled every time you
look at a menu. This is because the X toolkit requires the whole tree
of menus in advance. To force recalculation of the menu bar, call
force-mode-line-update
(see section Mode Line Format).
You've probably noticed that menu items show the equivalent keyboard key sequence (if any) to invoke the same command. To save time on recalculation, menu display caches this information in a sublist in the binding, like this:
(item-string [help-string] (key-binding-data) . real-binding)
Don't put these sublists in the menu item yourself; menu display calculates them automatically. Don't mention keyboard equivalents in the item strings themselves, since that is redundant.
Go to the first, previous, next, last section, table of contents.