Class tool-item - cl-cffi-gtk3 API documentation

Package: gtk

Class gtk:tool-item

Superclasses

gtk:bin, gtk:container, gtk:widget, gtk:buildable, gtk:activatable, gobject:object, common-lisp:standard-object, common-lisp:t

Documented Subclasses

gtk:separator-tool-item, gtk:tool-button

Direct Slots

is-important

The is-important property of type :boolean (Read / Write)
Whether the toolbar item is considered important. When true, toolbar buttons show text in :both-horiz mode.
Default value: false

visible-horizontal

The visible-horizontal property of type :boolean (Read / Write)
Whether the toolbar item is visible when the toolbar is in a horizontal orientation.
Default value: true

visible-vertical

The visible-vertical property of type :boolean (Read / Write)
Whether the toolbar item is visible when the toolbar is in a vertical orientation.
Default value: true

Details

The gtk:tool-item widget is a widget that can appear on a toolbar. To create a toolbar item that contain something else than a button, use the gtk:tool-item-new function. Use the gtk:container-add function to add a child widget to the tool item. For toolbar items that contain buttons, see the gtk:tool-button, gtk:toggle-tool-button and gtk:radio-tool-button widgets.

See the gtk:toolbar documentation for a description of the toolbar widget, and the gtk:tool-shell documentation for a description of the tool shell interface.

Signal Details

The "create-menu-proxy" signal

lambda (item)    :run-last

The signal is emitted when the toolbar needs information from item about whether the item should appear in the toolbar overflow menu. In response the tool item should either.

Call the gtk:tool-item-proxy-menu-item function with nil and return true to indicate that the tool item should not appear in the overflow menu,
call the gtk:tool-item-proxy-menu-item function with a new menu item and return true, or
return false to indicate that the signal was not handled by the tool item. This means that the tool item will not appear in the overflow menu unless a later handler installs a menu item.

The toolbar may cache the result of this signal. When the tool item changes how it will respond to this signal it must call the gtk:tool-item-rebuild-menu function to invalidate the cache and ensure that the toolbar rebuilds its overflow menu.

item: The gtk:tool-item widget the signal was emitted on.
Returns: True if the signal was handled, false if not.

The "toolbar-reconfigured" signal

lambda (item)    :run-last

The signal is emitted when some property of the toolbar that the item is a child of changes. For custom subclasses of the gtk:tool-item class, the default handler of this signal use the gtk:tool-shell-orientation, gtk:tool-shell-style, gtk:tool-shell-icon-size, or gtk:tool-shell-relief-style functions to find out what the toolbar should look like and change themselves accordingly.

item: The gtk:tool-item widget the signal was emitted on.

#2023-3-28