1 CAPI Reference Entries

toolbar-component

Class

Summary

A toolbar component is used to group several toolbar buttons together. Each component is separated from the surrounding components and buttons.

Toolbar components are choices, and may be used to implement toolbars on which groups of button have single-selection or multiple-selection functionality.

Superclasses

toolbar-object choice

Slots

images

A list of images, in one-to-one correspondence with the items. Elements corresponding totoolbar-button items ortoolbar-component items are ignored

callbacks

A list of callback functions, in one-to-one correspondence with the items.Elements corresponding totoolbar-button items ortoolbar-component items are ignored

tooltips

A list of tooltip strings, in one-to-one correspondence with the items. Elements corresponding totoolbar-button items ortoolbar-component items are ignored

default-image-set

An optionalimage-set object which can be used to specify images. Seetoolbar-button andimage-set for more details.

Description

The classtoolbar-component inherits from choice, and hence has a list of items. Its behavior is broadly similar tobutton-panel.

The:items keyword may be used to specify a mixture of toolbar buttons and toolbar components, or may contain arbitrary objects as items. The list may also contain CAPI panes, which will appear within the toolbar. This is typically used withtext-input-panes,option-panes, andtext-input-choices.

For items that are not toolbar buttons or toolbar components, a toolbar button is automatically created, using the appropriate elements of theimages,callbacks andtooltips lists. If no image is specified, the item itself is used as the image. For more information on acceptable values for images, seetoolbar-button.

See also

toolbar
toolbar-button