Toolbar

A toolbar is created with a call to gtk.toolbar.Toolbar.new_.

A toolbar can contain instances of a subclass of #GtkToolItem. To add a #GtkToolItem to the a toolbar, use gtk.toolbar.Toolbar.insert. To remove an item from the toolbar use gtk.container.Container.remove. To add a button to the toolbar, add an instance of #GtkToolButton.

Toolbar items can be visually grouped by adding instances of #GtkSeparatorToolItem to the toolbar. If the GtkToolbar child property “expand” is #TRUE and the property #GtkSeparatorToolItem:draw is set to #FALSE, the effect is to force all following items to the end of the toolbar.

By default, a toolbar can be shrunk, upon which it will add an arrow button to show an overflow menu offering access to any #GtkToolItem child that has a proxy menu item. To disable this and request enough size for all children, call gtk.toolbar.Toolbar.setShowArrow to set #GtkToolbar:show-arrow to false.

Creating a context menu for the toolbar can be done by connecting to the #GtkToolbar::popup-context-menu signal.

CSS nodes

GtkToolbar has a single CSS node with name toolbar.

class Toolbar : Container , Orientable , ToolShell {

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

static GType _getGType();

GType _gType [@property getter];

Toolbar self();

static ToolbarGidBuilder builder();

gtk.types.IconSize iconSize [@property getter];

gtk.types.IconSize iconSize [@property setter];

bool iconSizeSet [@property getter];

bool iconSizeSet [@property setter];

bool showArrow [@property getter];

bool showArrow [@property setter];

gtk.types.ToolbarStyle toolbarStyle [@property getter];

gtk.types.ToolbarStyle toolbarStyle [@property setter];

this();

int getDropIndex(int x, int y);

gtk.types.IconSize getIconSize();

int getItemIndex(gtk.tool_item.ToolItem item);

int getNItems();

gtk.tool_item.ToolItem getNthItem(int n);

gtk.types.ReliefStyle getReliefStyle();

bool getShowArrow();

gtk.types.ToolbarStyle getStyle();

void insert(gtk.tool_item.ToolItem item, int pos);

void setDropHighlightItem(gtk.tool_item.ToolItem toolItem, int index);

void setIconSize(gtk.types.IconSize iconSize);

void setShowArrow(bool showArrow);

void setStyle(gtk.types.ToolbarStyle style);

void unsetIconSize();

void unsetStyle();

gulong connectFocusHomeOrEnd(T callback, Flag!"After" after);

gulong connectOrientationChanged(T callback, Flag!"After" after);

gulong connectPopupContextMenu(T callback, Flag!"After" after);

gulong connectStyleChanged(T callback, Flag!"After" after);

}

Constructors

this this(void* ptr, Flag!"Take" take)
this this(): Creates a new toolbar.

Members

Functions

connectFocusHomeOrEnd gulong connectFocusHomeOrEnd(T callback, Flag!"After" after): Connect to FocusHomeOrEnd signal.
connectOrientationChanged gulong connectOrientationChanged(T callback, Flag!"After" after): Connect to OrientationChanged signal.
connectPopupContextMenu gulong connectPopupContextMenu(T callback, Flag!"After" after): Connect to PopupContextMenu signal.
connectStyleChanged gulong connectStyleChanged(T callback, Flag!"After" after): Connect to StyleChanged signal.
getDropIndex int getDropIndex(int x, int y): Returns the position corresponding to the indicated point on toolbar. This is useful when dragging items to the toolbar: this function returns the position a new item should be inserted.
getIconSize gtk.types.IconSize getIconSize(): Retrieves the icon size for the toolbar. See gtk.toolbar.Toolbar.setIconSize.
getItemIndex int getItemIndex(gtk.tool_item.ToolItem item): Returns the position of item on the toolbar, starting from 0. It is an error if item is not a child of the toolbar.
getNItems int getNItems(): Returns the number of items on the toolbar.
getNthItem gtk.tool_item.ToolItem getNthItem(int n): Returns the n'th item on toolbar, or null if the toolbar does not contain an n'th item.
getReliefStyle gtk.types.ReliefStyle getReliefStyle(): Returns the relief style of buttons on toolbar. See gtk.button.Button.setRelief.
getShowArrow bool getShowArrow(): Returns whether the toolbar has an overflow menu. See gtk.toolbar.Toolbar.setShowArrow.
getStyle gtk.types.ToolbarStyle getStyle(): Retrieves whether the toolbar has text, icons, or both . See gtk.toolbar.Toolbar.setStyle.
insert void insert(gtk.tool_item.ToolItem item, int pos): Insert a #GtkToolItem into the toolbar at position pos. If pos is 0 the item is prepended to the start of the toolbar. If pos is negative, the item is appended to the end of the toolbar.
self Toolbar self(): Returns this, for use in with statements.
setDropHighlightItem void setDropHighlightItem(gtk.tool_item.ToolItem toolItem, int index): Highlights toolbar to give an idea of what it would look like if item was added to toolbar at the position indicated by index_. If item is null, highlighting is turned off. In that case index_ is ignored.
setIconSize void setIconSize(gtk.types.IconSize iconSize): This function sets the size of stock icons in the toolbar. You can call it both before you add the icons and after they’ve been added. The size you set will override user preferences for the default icon size.
setShowArrow void setShowArrow(bool showArrow): Sets whether to show an overflow menu when toolbar isn’t allocated enough size to show all of its items. If true, items which can’t fit in toolbar, and which have a proxy menu item set by gtk.tool_item.ToolItem.setProxyMenuItem or #GtkToolItem::create-menu-proxy, will be available in an overflow menu, which can be opened by an added arrow button. If false, toolbar will request enough size to fit all of its child items without any overflow.
setStyle void setStyle(gtk.types.ToolbarStyle style): Alters the view of toolbar to display either icons only, text only, or both.
unsetIconSize void unsetIconSize(): Unsets toolbar icon size set with gtk.toolbar.Toolbar.setIconSize, so that user preferences will be used to determine the icon size.
unsetStyle void unsetStyle(): Unsets a toolbar style set with gtk.toolbar.Toolbar.setStyle, so that user preferences will be used to determine the toolbar style.

Properties

_gType GType _gType [@property getter]
iconSize gtk.types.IconSize iconSize [@property getter]: Get iconSize property.
iconSize gtk.types.IconSize iconSize [@property setter]: Set iconSize property.
iconSizeSet bool iconSizeSet [@property getter]: Get iconSizeSet property.
iconSizeSet bool iconSizeSet [@property setter]: Set iconSizeSet property.
showArrow bool showArrow [@property getter]
showArrow bool showArrow [@property setter]
toolbarStyle gtk.types.ToolbarStyle toolbarStyle [@property getter]
toolbarStyle gtk.types.ToolbarStyle toolbarStyle [@property setter]

Static functions

_getGType GType _getGType()
builder ToolbarGidBuilder builder(): Get builder for gtk.toolbar.Toolbar

Mixed In Members

From `mixin OrientableT!()`

orientation gtk.types.Orientation orientation [@property getter]: Get orientation property.
orientation gtk.types.Orientation orientation [@property setter]: Set orientation property.
getOrientation gtk.types.Orientation getOrientation(): Retrieves the orientation of the orientable.
setOrientation void setOrientation(gtk.types.Orientation orientation): Sets the orientation of the orientable.

From `mixin ToolShellT!()`

getEllipsizeMode pango.types.EllipsizeMode getEllipsizeMode(): Retrieves the current ellipsize mode for the tool shell. Tool items must not call this function directly, but rely on gtk.tool_item.ToolItem.getEllipsizeMode instead.
getIconSize gtk.types.IconSize getIconSize(): Retrieves the icon size for the tool shell. Tool items must not call this function directly, but rely on gtk.tool_item.ToolItem.getIconSize instead.
toolShellGetOrientation gtk.types.Orientation toolShellGetOrientation(): Retrieves the current orientation for the tool shell. Tool items must not call this function directly, but rely on gtk.tool_item.ToolItem.getOrientation instead.
getReliefStyle gtk.types.ReliefStyle getReliefStyle(): Returns the relief style of buttons on shell. Tool items must not call this function directly, but rely on gtk.tool_item.ToolItem.getReliefStyle instead.
getStyle gtk.types.ToolbarStyle getStyle(): Retrieves whether the tool shell has text, icons, or both. Tool items must not call this function directly, but rely on gtk.tool_item.ToolItem.getToolbarStyle instead.
getTextAlignment float getTextAlignment(): Retrieves the current text alignment for the tool shell. Tool items must not call this function directly, but rely on gtk.tool_item.ToolItem.getTextAlignment instead.
getTextOrientation gtk.types.Orientation getTextOrientation(): Retrieves the current text orientation for the tool shell. Tool items must not call this function directly, but rely on gtk.tool_item.ToolItem.getTextOrientation instead.
getTextSizeGroup gtk.size_group.SizeGroup getTextSizeGroup(): Retrieves the current text size group for the tool shell. Tool items must not call this function directly, but rely on gtk.tool_item.ToolItem.getTextSizeGroup instead.
rebuildMenu void rebuildMenu(): Calling this function signals the tool shell that the overflow menu item for tool items have changed. If there is an overflow menu and if it is visible when this function it called, the menu will be rebuilt.

Inherited Members

From Container

_getGType GType _getGType()
_gType GType _gType [@property getter]
self Container self(): Returns this, for use in with statements.
builder ContainerGidBuilder builder(): Get builder for gtk.container.Container
borderWidth uint borderWidth [@property getter]
borderWidth uint borderWidth [@property setter]
child gtk.widget.Widget child [@property setter]
resizeMode gtk.types.ResizeMode resizeMode [@property getter]
resizeMode gtk.types.ResizeMode resizeMode [@property setter]
add void add(gtk.widget.Widget widget): Adds widget to container. Typically used for simple containers such as #GtkWindow, #GtkFrame, or #GtkButton; for more complicated layout containers such as #GtkBox or #GtkGrid, this function will pick default packing parameters that may not be correct. So consider functions such as gtk.box.Box.packStart and gtk.grid.Grid.attach as an alternative to gtk.container.Container.add in those cases. A widget may be added to only one container at a time; you can’t place the same widget inside two different containers.
checkResize void checkResize()
childGetProperty void childGetProperty(gtk.widget.Widget child, string propertyName, gobject.value.Value value): Gets the value of a child property for child and container.
childNotify void childNotify(gtk.widget.Widget child, string childProperty): Emits a #GtkWidget::child-notify signal for the [child property][child-properties] child_property on the child.
childNotifyByPspec void childNotifyByPspec(gtk.widget.Widget child, gobject.param_spec.ParamSpec pspec): Emits a #GtkWidget::child-notify signal for the [child property][child-properties] specified by pspec on the child.
childSetProperty void childSetProperty(gtk.widget.Widget child, string propertyName, gobject.value.Value value): Sets a child property for child and container.
childType gobject.types.GType childType(): Returns the type of the children supported by the container.
forall void forall(gtk.types.Callback callback): Invokes callback on each direct child of container, including children that are considered “internal” (implementation details of the container). “Internal” children generally weren’t added by the user of the container, but were added by the container implementation itself.
foreach_ void foreach_(gtk.types.Callback callback): Invokes callback on each non-internal child of container. See gtk.container.Container.forall for details on what constitutes an “internal” child. For all practical purposes, this function should iterate over precisely those child widgets that were added to the container by the application with explicit add() calls.
getBorderWidth uint getBorderWidth(): Retrieves the border width of the container. See gtk.container.Container.setBorderWidth.
getChildren gtk.widget.Widget[] getChildren(): Returns the container’s non-internal children. See gtk.container.Container.forall for details on what constitutes an "internal" child.
getFocusChain bool getFocusChain(gtk.widget.Widget[] focusableWidgets): Retrieves the focus chain of the container, if one has been set explicitly. If no focus chain has been explicitly set, GTK+ computes the focus chain based on the positions of the children. In that case, GTK+ stores null in focusable_widgets and returns false.
getFocusChild gtk.widget.Widget getFocusChild(): Returns the current focus child widget inside container. This is not the currently focused widget. That can be obtained by calling gtk.window.Window.getFocus.
getFocusHadjustment gtk.adjustment.Adjustment getFocusHadjustment(): Retrieves the horizontal focus adjustment for the container. See gtk_container_set_focus_hadjustment ().
getFocusVadjustment gtk.adjustment.Adjustment getFocusVadjustment(): Retrieves the vertical focus adjustment for the container. See gtk.container.Container.setFocusVadjustment.
getPathForChild gtk.widget_path.WidgetPath getPathForChild(gtk.widget.Widget child): Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including child.
getResizeMode gtk.types.ResizeMode getResizeMode(): Returns the resize mode for the container. See gtk_container_set_resize_mode ().
propagateDraw void propagateDraw(gtk.widget.Widget child, cairo.context.Context cr): When a container receives a call to the draw function, it must send synthetic #GtkWidget::draw calls to all children that don’t have their own #GdkWindows. This function provides a convenient way of doing this. A container, when it receives a call to its #GtkWidget::draw function, calls gtk.container.Container.propagateDraw once for each child, passing in the cr the container received.
remove void remove(gtk.widget.Widget widget): Removes widget from container. widget must be inside container. Note that container will own a reference to widget, and that this may be the last reference held; so removing a widget from its container can destroy that widget. If you want to use widget again, you need to add a reference to it before removing it from a container, using gobject.object.ObjectWrap.ref_. If you don’t want to use widget again it’s usually more efficient to simply destroy it directly using gtk.widget.Widget.destroy since this will remove it from the container and help break any circular reference count cycles.
resizeChildren void resizeChildren()
setBorderWidth void setBorderWidth(uint borderWidth): Sets the border width of the container.
setFocusChain void setFocusChain(gtk.widget.Widget[] focusableWidgets): Sets a focus chain, overriding the one computed automatically by GTK+.
setFocusChild void setFocusChild(gtk.widget.Widget child): Sets, or unsets if child is null, the focused child of container.
setFocusHadjustment void setFocusHadjustment(gtk.adjustment.Adjustment adjustment): Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the horizontal alignment. See gtk.scrolled_window.ScrolledWindow.getHadjustment for a typical way of obtaining the adjustment and gtk.container.Container.setFocusVadjustment for setting the vertical adjustment.
setFocusVadjustment void setFocusVadjustment(gtk.adjustment.Adjustment adjustment): Hooks up an adjustment to focus handling in a container, so when a child of the container is focused, the adjustment is scrolled to show that widget. This function sets the vertical alignment. See gtk.scrolled_window.ScrolledWindow.getVadjustment for a typical way of obtaining the adjustment and gtk.container.Container.setFocusHadjustment for setting the horizontal adjustment.
setReallocateRedraws void setReallocateRedraws(bool needsRedraws): Sets the reallocate_redraws flag of the container to the given value.
setResizeMode void setResizeMode(gtk.types.ResizeMode resizeMode): Sets the resize mode for the container.
unsetFocusChain void unsetFocusChain(): Removes a focus chain explicitly set with gtk.container.Container.setFocusChain.
connectAdd gulong connectAdd(T callback, Flag!"After" after): Connect to Add signal.
connectCheckResize gulong connectCheckResize(T callback, Flag!"After" after): Connect to CheckResize signal.
connectRemove gulong connectRemove(T callback, Flag!"After" after): Connect to Remove signal.
connectSetFocusChild gulong connectSetFocusChild(T callback, Flag!"After" after): Connect to SetFocusChild signal.

From Orientable

_getGType GType _getGType()
orientation gtk.types.Orientation orientation [@property getter]: Get orientation property.
orientation gtk.types.Orientation orientation [@property setter]: Set orientation property.
getOrientation gtk.types.Orientation getOrientation(): Retrieves the orientation of the orientable.
setOrientation void setOrientation(gtk.types.Orientation orientation): Sets the orientation of the orientable.

From ToolShell

_getGType GType _getGType()
getEllipsizeMode pango.types.EllipsizeMode getEllipsizeMode(): Retrieves the current ellipsize mode for the tool shell. Tool items must not call this function directly, but rely on gtk.tool_item.ToolItem.getEllipsizeMode instead.
getIconSize gtk.types.IconSize getIconSize(): Retrieves the icon size for the tool shell. Tool items must not call this function directly, but rely on gtk.tool_item.ToolItem.getIconSize instead.
toolShellGetOrientation gtk.types.Orientation toolShellGetOrientation(): Retrieves the current orientation for the tool shell. Tool items must not call this function directly, but rely on gtk.tool_item.ToolItem.getOrientation instead.
getReliefStyle gtk.types.ReliefStyle getReliefStyle(): Returns the relief style of buttons on shell. Tool items must not call this function directly, but rely on gtk.tool_item.ToolItem.getReliefStyle instead.
getStyle gtk.types.ToolbarStyle getStyle(): Retrieves whether the tool shell has text, icons, or both. Tool items must not call this function directly, but rely on gtk.tool_item.ToolItem.getToolbarStyle instead.
getTextAlignment float getTextAlignment(): Retrieves the current text alignment for the tool shell. Tool items must not call this function directly, but rely on gtk.tool_item.ToolItem.getTextAlignment instead.
getTextOrientation gtk.types.Orientation getTextOrientation(): Retrieves the current text orientation for the tool shell. Tool items must not call this function directly, but rely on gtk.tool_item.ToolItem.getTextOrientation instead.
getTextSizeGroup gtk.size_group.SizeGroup getTextSizeGroup(): Retrieves the current text size group for the tool shell. Tool items must not call this function directly, but rely on gtk.tool_item.ToolItem.getTextSizeGroup instead.
rebuildMenu void rebuildMenu(): Calling this function signals the tool shell that the overflow menu item for tool items have changed. If there is an overflow menu and if it is visible when this function it called, the menu will be rebuilt.

gtk toolbar classes

Toolbar

CSS nodes

From mixin OrientableT!()

From mixin ToolShellT!()

From `mixin OrientableT!()`

From `mixin ToolShellT!()`