All Manuals > CAPI User Guide and Reference Manual > 21 CAPI Reference Entries

interface-toolbar-state Accessor


Reads or changes the properties of an interface toolbar that give information about its state.




interface-toolbar-state interface key => value

(setf interface-toolbar-state) value interface key => value

An instance of interface or a subclass.
One of the toolbar-states plist keys.
The value associated with the toolbar-states plist key.
The value associated with the toolbar-states plist key.

The accessor interface-toolbar-state reads or changes the properties of the interface toolbar of interface that give information about its state. The user can also change these properties by customizing the toolbar, so you cannot assume that the value will be the same each time you read it.

See 9 Adding Toolbars for information on how to specify an interface toolbar.

key can be one of the following, with the corresponding value:

visible is true if the toolbar is visible and false if it is hidden. The default is true.
items is a list of the names of the toolbar-items which are shown on the toolbar, in the order they are shown. The built-in names :separator, :space and :flexible-space represent various kinds of gap between items. On Microsoft Windows, an item can be a list of the form (:titled-separator title) which starts a dockable group of items that displays title when it is undocked. The default items includes all items in toolbar-items, with :separator between each toolbar-component.
display is a keyword describing what is displayed for each item. It can be :image (just shows an image), :title (just shows the title), :image-and-title (shows both title and image) or :image-and-title-horizontal (shows title and image horizontally, only supported on GTK+). The default is platform-specific.
size is a keyword describing the size of the items. It can be one of :small, :normal or :large. Some of these sizes might be the same as others. The default is platform-specific.

You can set all of the keys simultaneously by setting the interface-toolbar-state accessor or providing the toolbar-states initarg.


The value :separator in items may or may not actually be visible, depending on the windowing system. On macOS Lion it is zero width.

See also

9 Adding Toolbars

CAPI User Guide and Reference Manual (Macintosh version) - 01 Dec 2021 19:31:27