gtk.tool_item

Module for [ToolItem] class

class ToolItem ToolItemGidBuilder ToolItemGidBuilderImpl

Types 3

classToolItem : gtk.bin.Bin, gtk.activatable.Activatable

#GtkToolItems are widgets that can appear on a toolbar. To create a toolbar item that contain something else than a button, use gtk.tool_item.ToolItem.new_. Use gtk.container.Container.add to add a child widget to the tool item.

For toolbar items that contain buttons, see the #GtkToolButton, #GtkToggleToolButton and #GtkRadioToolButton classes.

See the #GtkToolbar class for a description of the toolbar widget, and #GtkToolShell for a description of the tool shell interface.

Methods

GType _getGType() static nothrow

GType _gType() @property nothrow

ToolItem self() nothrowReturns `this`, for use in `with` statements.

ToolItemGidBuilder builder() static nothrowGet builder for [gtk.tool_item.ToolItem] Returns: New builder object

bool isImportant() @property nothrow

void isImportant(bool propval) @property nothrow

bool visibleHorizontal() @property nothrow

void visibleHorizontal(bool propval) @property nothrow

bool visibleVertical() @property nothrow

void visibleVertical(bool propval) @property nothrow

pango.types.EllipsizeMode getEllipsizeMode() nothrowReturns the ellipsize mode used for tool_item. Custom subclasses of #GtkToolItem should call this function to find out how text should be ellipsized. Returns: a #PangoEllipsizeMode indicating how t...

bool getExpand() nothrowReturns whether tool_item is allocated extra space. See [gtk.tool_item.ToolItem.setExpand]. Returns: true if tool_item is allocated extra space.

bool getHomogeneous() nothrowReturns whether tool_item is the same size as other homogeneous items. See [gtk.tool_item.ToolItem.setHomogeneous]. Returns: true if the item is the same size as other homogeneous items.

gtk.types.IconSize getIconSize() nothrowReturns the icon size used for tool_item. Custom subclasses of #GtkToolItem should call this function to find out what size icons they should use. Returns: a #GtkIconSize indicating the icon size u...

bool getIsImportant() nothrowReturns whether tool_item is considered important. See [gtk.tool_item.ToolItem.setIsImportant] Returns: true if tool_item is considered important.

gtk.types.Orientation getOrientation() nothrowReturns the orientation used for tool_item. Custom subclasses of #GtkToolItem should call this function to find out what size icons they should use. Returns: a #GtkOrientation indicating the orient...

gtk.widget.Widget getProxyMenuItem(string menuItemId) nothrowIf menu_item_id matches the string passed to [gtk.tool_item.ToolItem.setProxyMenuItem] return the corresponding #GtkMenuItem.

gtk.types.ReliefStyle getReliefStyle() nothrowReturns the relief style of tool_item. See [gtk.button.Button.setRelief]. Custom subclasses of #GtkToolItem should call this function in the handler of the #GtkToolItem::toolbar_reconfigured signal...

float getTextAlignment() nothrowReturns the text alignment used for tool_item. Custom subclasses of #GtkToolItem should call this function to find out how text should be aligned. Returns: a #gfloat indicating the horizontal text ...

gtk.types.Orientation getTextOrientation() nothrowReturns the text orientation used for tool_item. Custom subclasses of #GtkToolItem should call this function to find out how text should be orientated. Returns: a #GtkOrientation indicating the tex...

gtk.size_group.SizeGroup getTextSizeGroup() nothrowReturns the size group used for labels in tool_item. Custom subclasses of #GtkToolItem should call this function and use the size group for labels. Returns: a #GtkSizeGroup

gtk.types.ToolbarStyle getToolbarStyle() nothrowReturns the toolbar style used for tool_item. Custom subclasses of #GtkToolItem should call this function in the handler of the GtkToolItem::toolbar_reconfigured signal to find out in what style th...

bool getUseDragWindow() nothrowReturns whether tool_item has a drag window. See [gtk.tool_item.ToolItem.setUseDragWindow]. Returns: true if tool_item uses a drag window.

bool getVisibleHorizontal() nothrowReturns whether the tool_item is visible on toolbars that are docked horizontally. Returns: true if tool_item is visible on toolbars that are docked horizontally.

bool getVisibleVertical() nothrowReturns whether tool_item is visible when the toolbar is docked vertically. See [gtk.tool_item.ToolItem.setVisibleVertical]. Returns: Whether tool_item is visible when the toolbar is docked vertically

void rebuildMenu() nothrowCalling this function signals to the toolbar that the overflow menu item for tool_item has changed. If the overflow menu is visible when this function it called, the menu will be rebuilt.

gtk.widget.Widget retrieveProxyMenuItem() nothrowReturns the #GtkMenuItem that was last set by [gtk.tool_item.ToolItem.setProxyMenuItem], ie. the #GtkMenuItem that is going to appear in the overflow menu. Returns: The #GtkMenuItem that is going t...

void setExpand(bool expand) nothrowSets whether tool_item 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 wh...

void setHomogeneous(bool homogeneous) nothrowSets whether tool_item 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.

void setIsImportant(bool isImportant) nothrowSets whether tool_item should be considered important. The #GtkToolButton class uses this property to determine whether to show or hide its label when the toolbar style is [gtk.types.ToolbarStyle.B...

void setProxyMenuItem(string menuItemId, gtk.widget.Widget menuItem = null) nothrowSets the #GtkMenuItem used in the toolbar overflow menu. The menu_item_id is used to identify the caller of this function and should also be used with [gtk.tool_item.ToolItem.getProxyMenuItem].

void setTooltipMarkup(string markup) nothrowSets the markup text to be displayed as tooltip on the item. See [gtk.widget.Widget.setTooltipMarkup].

void setTooltipText(string text) nothrowSets the text to be displayed as tooltip on the item. See [gtk.widget.Widget.setTooltipText].

void setUseDragWindow(bool useDragWindow) nothrowSets whether tool_item has a drag window. When true the toolitem can be used as a drag source through [gtk.widget.Widget.dragSourceSet]. When tool_item has a drag window it will intercept all event...

void setVisibleHorizontal(bool visibleHorizontal) nothrowSets whether tool_item is visible when the toolbar is docked horizontally.

void setVisibleVertical(bool visibleVertical) nothrowSets whether tool_item 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 visible_vertical is fals...

void toolbarReconfigured() nothrowEmits the signal #GtkToolItem::toolbar_reconfigured on tool_item. #GtkToolbar and other #GtkToolShell implementations use this function to notify children, when some aspect of their configuration c...

gulong connectCreateMenuProxy(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  bool)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gtk.tool_item.ToolItem)))
   &&  Parameters!T.length <  2)

nothrowConnect to `CreateMenuProxy` signal.

gulong connectToolbarReconfigured(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gtk.tool_item.ToolItem)))
   &&  Parameters!T.length <  2)

nothrowConnect to `ToolbarReconfigured` signal.

Constructors

this(void * ptr, Flag!"Take" take)

this()Creates a new #GtkToolItem Returns: the new #GtkToolItem

classToolItemGidBuilderImpl(T) : gtk.bin.BinGidBuilderImpl!T, gtk.activatable.ActivatableGidBuilderImpl!T

Fluent builder implementation template for gtk.tool_item.ToolItem

Methods

T isImportant(bool propval) nothrow

T visibleHorizontal(bool propval) nothrow

T visibleVertical(bool propval) nothrow

classToolItemGidBuilder : ToolItemGidBuilderImpl!ToolItemGidBuilder

Fluent builder for gtk.tool_item.ToolItem

Methods

ToolItem build() nothrowCreate object from builder. Returns: New object