Memory-managed wrapper type.

Type class for types which can be safely cast to ToolItem, for instance with toToolItem.

Cast to ToolItem, for types for which this is known to be safe. For general casts, use castTo.

A convenience alias for Nothing :: Maybe ToolItem.

Returns the ellipsize mode used for toolItem. Custom subclasses of ToolItem should call this function to find out how text should be ellipsized.

Since: 2.20

Returns whether toolItem is allocated extra space. See toolItemSetExpand.

Since: 2.4

Returns whether toolItem is the same size as other homogeneous items. See toolItemSetHomogeneous.

Since: 2.4

Returns the icon size used for toolItem. Custom subclasses of ToolItem should call this function to find out what size icons they should use.

Since: 2.4

Returns whether toolItem is considered important. See toolItemSetIsImportant

Since: 2.4

Returns the orientation used for toolItem. Custom subclasses of ToolItem should call this function to find out what size icons they should use.

Since: 2.4

If menuItemId matches the string passed to toolItemSetProxyMenuItem return the corresponding MenuItem.

Custom subclasses of ToolItem should use this function to update their menu item when the ToolItem changes. That the menuItemIds must match ensures that a ToolItem will not inadvertently change a menu item that they did not create.

Since: 2.4

Returns the relief style of toolItem. See buttonSetRelief. Custom subclasses of ToolItem should call this function in the handler of the ToolItem::toolbar_reconfigured signal to find out the relief style of buttons.

Since: 2.4

Returns the text alignment used for toolItem. Custom subclasses of ToolItem should call this function to find out how text should be aligned.

Since: 2.20

Returns the text orientation used for toolItem. Custom subclasses of ToolItem should call this function to find out how text should be orientated.

Since: 2.20

Returns the size group used for labels in toolItem. Custom subclasses of ToolItem should call this function and use the size group for labels.

Since: 2.20

Returns the toolbar style used for toolItem. Custom subclasses of ToolItem should call this function in the handler of the GtkToolItem::toolbar_reconfigured signal to find out in what style the toolbar is displayed and change themselves accordingly

Possibilities are:

• ToolbarStyleBoth, meaning the tool item should show both an icon and a label, stacked vertically
• ToolbarStyleIcons, meaning the toolbar shows only icons
• ToolbarStyleText, meaning the tool item should only show text
• ToolbarStyleBothHoriz, meaning the tool item should show both an icon and a label, arranged horizontally

Since: 2.4

Returns whether toolItem has a drag window. See toolItemSetUseDragWindow.

Since: 2.4

Returns whether the toolItem is visible on toolbars that are docked horizontally.

Since: 2.4

Returns whether toolItem is visible when the toolbar is docked vertically. See toolItemSetVisibleVertical.

Since: 2.4

Creates a new ToolItem

Since: 2.4

Calling this function signals to the toolbar that the overflow menu item for toolItem has changed. If the overflow menu is visible when this function it called, the menu will be rebuilt.

The function must be called when the tool item changes what it will do in response to the ToolItem::create-menu-proxy signal.

Since: 2.6

Returns the MenuItem that was last set by toolItemSetProxyMenuItem, ie. the MenuItem that is going to appear in the overflow menu.

Since: 2.4

Sets whether toolItem is allocated extra space when there is more room on the toolbar then needed for the items. The effect is that the item gets bigger when the toolbar gets bigger and smaller when the toolbar gets smaller.

Since: 2.4

Sets whether toolItem is to be allocated the same size as other homogeneous items. The effect is that all homogeneous items will have the same width as the widest of the items.

Since: 2.4

Sets whether toolItem should be considered important. The ToolButton class uses this property to determine whether to show or hide its label when the toolbar style is ToolbarStyleBothHoriz. The result is that only tool buttons with the “is_important” property set have labels, an effect known as “priority text”

Since: 2.4

Sets the MenuItem used in the toolbar overflow menu. The menuItemId is used to identify the caller of this function and should also be used with toolItemGetProxyMenuItem.

See also ToolItem::create-menu-proxy.

Since: 2.4

Sets the markup text to be displayed as tooltip on the item. See widgetSetTooltipMarkup.

Since: 2.12

Sets the text to be displayed as tooltip on the item. See widgetSetTooltipText.

Since: 2.12

Sets whether toolItem has a drag window. When True the toolitem can be used as a drag source through widgetDragSourceSet. When toolItem has a drag window it will intercept all events, even those that would otherwise be sent to a child of toolItem.

Since: 2.4

Sets whether toolItem is visible when the toolbar is docked horizontally.

Since: 2.4

Sets whether toolItem is visible when the toolbar is docked vertically. Some tool items, such as text entries, are too wide to be useful on a vertically docked toolbar. If visibleVertical is False toolItem will not appear on toolbars that are docked vertically.

Since: 2.4

Emits the signal ToolItem::toolbar_reconfigured on toolItem. Toolbar and other ToolShell implementations use this function to notify children, when some aspect of their configuration changes.

Since: 2.14

Construct a GValueConstruct with valid value for the “is-important” property. This is rarely needed directly, but it is used by new.

Get the value of the “is-important” property. When overloading is enabled, this is equivalent to

get toolItem #isImportant

Set the value of the “is-important” property. When overloading is enabled, this is equivalent to

set toolItem [ #isImportant := value ]

Construct a GValueConstruct with valid value for the “visible-horizontal” property. This is rarely needed directly, but it is used by new.

Get the value of the “visible-horizontal” property. When overloading is enabled, this is equivalent to

get toolItem #visibleHorizontal

Set the value of the “visible-horizontal” property. When overloading is enabled, this is equivalent to

set toolItem [ #visibleHorizontal := value ]

Construct a GValueConstruct with valid value for the “visible-vertical” property. This is rarely needed directly, but it is used by new.

Get the value of the “visible-vertical” property. When overloading is enabled, this is equivalent to

get toolItem #visibleVertical

Set the value of the “visible-vertical” property. When overloading is enabled, this is equivalent to

set toolItem [ #visibleVertical := value ]

Type for the callback on the (unwrapped) C side.

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

• call toolItemSetProxyMenuItem with a Nothing pointer and return True to indicate that the item should not appear in the overflow menu
• call toolItemSetProxyMenuItem with a new menu item and return True, or
• return False to indicate that the signal was not handled by the item. This means that the 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 toolItemRebuildMenu to invalidate the cache and ensure that the toolbar rebuilds its overflow menu.

Connect a signal handler for the “create-menu-proxy” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after toolItem #createMenuProxy callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_ToolItemCreateMenuProxyCallback.

A convenience synonym for Nothing :: Maybe ToolItemCreateMenuProxyCallback.

Connect a signal handler for the “create-menu-proxy” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on toolItem #createMenuProxy callback

Wrap a ToolItemCreateMenuProxyCallback into a C_ToolItemCreateMenuProxyCallback.

Type for the callback on the (unwrapped) C side.

This signal is emitted when some property of the toolbar that the item is a child of changes. For custom subclasses of ToolItem, the default handler of this signal use the functions

• toolShellGetOrientation
• toolShellGetStyle
• toolShellGetIconSize
• toolShellGetReliefStyle

to find out what the toolbar should look like and change themselves accordingly.

Connect a signal handler for the “toolbar-reconfigured” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after toolItem #toolbarReconfigured callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_ToolItemToolbarReconfiguredCallback.

A convenience synonym for Nothing :: Maybe ToolItemToolbarReconfiguredCallback.

Connect a signal handler for the “toolbar-reconfigured” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on toolItem #toolbarReconfigured callback

Wrap a ToolItemToolbarReconfiguredCallback into a C_ToolItemToolbarReconfiguredCallback.