redisplay-menu-bar Function

Summary

Updates the menu bar of an interface.

Package

capi

Signature

redisplay-menu-bar interface &key redo-items

Arguments

interface⇩	An interface.
redo-items⇩	A generalized boolean.

Description

The function redisplay-menu-bar updates the menu bar of interface, such that menus become enabled and disabled as appropriate.

When redo-items is non-nil, redisplay-menu-bar redoes the items in menu and menu-component that have an items-function, by calling the items-function and setting the items. The default value of redo-items is t.

Notes

redo-items defaults to t in order to ensure that any accelerator associated with any item is up-to-date. When the menu bar contains menus (including sub-menus and menu-components) that have an items-function, redisplay-menu-bar may take a relatively long time (tens of milliseconds). If it is called often (for example, each time the user types a character), then it is better to call redisplay-menu-bar with redo-items nil.

Compatibility note

This function has been superseded by redisplay-interface, which updates the menu bar, but also updates other state objects such as buttons, list panels and so on.

See also

interface
redisplay-interface