Toolbar

A toolbar is created with a call to gtk_toolbar_new().

A toolbar can contain instances of a subclass of GtkToolItem. To add a GtkToolItem to the a toolbar, use gtk_toolbar_insert(). To remove an item from the toolbar use gtk_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 "draw" is set to FALSE, the effect is to force all following items to the end of the toolbar.

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

class Toolbar : Container , OrientableIF , ToolShellIF {}

Constructors

this
this(GtkToolbar* gtkToolbar)

Sets our main struct and passes it to the parent class

this
this()

Creates a new toolbar.

Members

Functions

addOnFocusHomeOrEnd
void addOnFocusHomeOrEnd(bool delegate(gboolean, Toolbar) dlg, ConnectFlags connectFlags)

A keybinding signal used internally by GTK+. This signal can't be used in application code TRUE if the first item should be focused TRUE if the signal was handled, FALSE if not

addOnOrientationChanged
void addOnOrientationChanged(void delegate(GtkOrientation, Toolbar) dlg, ConnectFlags connectFlags)

Emitted when the orientation of the toolbar changes.

addOnPopupContextMenu
void addOnPopupContextMenu(bool delegate(gint, gint, gint, Toolbar) dlg, ConnectFlags connectFlags)

Emitted when the user right-clicks the toolbar or uses the keybinding to display a popup menu. Application developers should handle this signal if they want to display a context menu on the toolbar. The context-menu should appear at the coordinates given by x and y. The mouse button number is given by the button parameter. If the menu was popped up using the keybaord, button is -1.

addOnStyleChanged
void addOnStyleChanged(void delegate(GtkToolbarStyle, Toolbar) dlg, ConnectFlags connectFlags)

Emitted when the style of the toolbar changes. See Also GtkToolItem

getDropIndex
int getDropIndex(int x, int y)

Returns the position corresponding to the indicated point on Since 2.4

getItemIndex
int getItemIndex(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. Since 2.4

getNItems
int getNItems()

Returns the number of items on the toolbar. Since 2.4

getNthItem
ToolItem getNthItem(int n)

Returns the n'th item on toolbar, or NULL if the toolbar does not contain an n'th item. Since 2.4

getShowArrow
int getShowArrow()

Returns whether the toolbar has an overflow menu. See gtk_toolbar_set_show_arrow(). Since 2.4

getStruct
void* getStruct()

the main Gtk struct as a void*

getToolbarStruct
GtkToolbar* getToolbarStruct()

Get the main Gtk struct

getToolbarStyle
GtkToolbarStyle getToolbarStyle()

Retrieves whether the toolbar has text, icons, or both . See gtk_toolbar_set_style().

insert
void insert(ToolItem toolItem, 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. Since 2.4

setDropHighlightItem
void setDropHighlightItem(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. The tool_item passed to this function must not be part of any widget hierarchy. When an item is set as drop highlight item it can not added to any widget hierarchy or used as highlight item for another toolbar. Since 2.4

setIconSize
void setIconSize(GtkIconSize 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. This should only be used for special-purpose toolbars, normal application toolbars should respect the user preferences for the size of icons.

setShowArrow
void setShowArrow(int showArrow)

Sets whether to show an overflow menu when toolbar doesn't have room for all items on it. If TRUE, items that there are not room are available through an overflow menu. Since 2.4

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
setStyle
void setStyle(GtkToolbarStyle 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_set_icon_size(), so that user preferences will be used to determine the icon size.

unsetStyle
void unsetStyle()

Unsets a toolbar style set with gtk_toolbar_set_style(), so that user preferences will be used to determine the toolbar style.

Mixins

__anonymous
mixin OrientableT!(GtkToolbar)
Undocumented in source.
__anonymous
mixin ToolShellT!(GtkToolbar)
Undocumented in source.

Static functions

callBackFocusHomeOrEnd
gboolean callBackFocusHomeOrEnd(GtkToolbar* toolbarStruct, gboolean focusHome, Toolbar _toolbar)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackOrientationChanged
void callBackOrientationChanged(GtkToolbar* toolbarStruct, GtkOrientation orientation, Toolbar _toolbar)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackPopupContextMenu
gboolean callBackPopupContextMenu(GtkToolbar* toolbarStruct, gint x, gint y, gint button, Toolbar _toolbar)
Undocumented in source. Be warned that the author may not have intended to support it.
callBackStyleChanged
void callBackStyleChanged(GtkToolbar* toolbarStruct, GtkToolbarStyle style, Toolbar _toolbar)
Undocumented in source. Be warned that the author may not have intended to support it.

Variables

connectedSignals
int[string] connectedSignals;
gtkToolbar
GtkToolbar* gtkToolbar;

the main Gtk struct

onFocusHomeOrEndListeners
bool delegate(gboolean, Toolbar)[] onFocusHomeOrEndListeners;
Undocumented in source.
onOrientationChangedListeners
void delegate(GtkOrientation, Toolbar)[] onOrientationChangedListeners;
Undocumented in source.
onPopupContextMenuListeners
bool delegate(gint, gint, gint, Toolbar)[] onPopupContextMenuListeners;
Undocumented in source.
onStyleChangedListeners
void delegate(GtkToolbarStyle, Toolbar)[] onStyleChangedListeners;
Undocumented in source.

Inherited Members

From Container

gtkContainer
GtkContainer* gtkContainer;

the main Gtk struct

getContainerStruct
GtkContainer* getContainerStruct()

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
removeAll
void removeAll()

Removes all widgets from the container

connectedSignals
int[string] connectedSignals;
onAddListeners
void delegate(Widget, Container)[] onAddListeners;
Undocumented in source.
addOnAdd
void addOnAdd(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackAdd
void callBackAdd(GtkContainer* containerStruct, GtkWidget* widget, Container _container)
Undocumented in source. Be warned that the author may not have intended to support it.
onCheckResizeListeners
void delegate(Container)[] onCheckResizeListeners;
Undocumented in source.
addOnCheckResize
void addOnCheckResize(void delegate(Container) dlg, ConnectFlags connectFlags)
callBackCheckResize
void callBackCheckResize(GtkContainer* containerStruct, Container _container)
Undocumented in source. Be warned that the author may not have intended to support it.
onRemoveListeners
void delegate(Widget, Container)[] onRemoveListeners;
Undocumented in source.
addOnRemove
void addOnRemove(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackRemove
void callBackRemove(GtkContainer* containerStruct, GtkWidget* widget, Container _container)
Undocumented in source. Be warned that the author may not have intended to support it.
onSetFocusChildListeners
void delegate(Widget, Container)[] onSetFocusChildListeners;
Undocumented in source.
addOnSetFocusChild
void addOnSetFocusChild(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackSetFocusChild
void callBackSetFocusChild(GtkContainer* containerStruct, GtkWidget* widget, Container _container)
Undocumented in source. Be warned that the author may not have intended to support it.
add
void add(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_pack_start() and gtk_grid_attach() as an alternative to gtk_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.

remove
void remove(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 while it's not inside a container, using g_object_ref(). If you don't want to use widget again it's usually more efficient to simply destroy it directly using gtk_widget_destroy() since this will remove it from the container and help break any circular reference count cycles.

getResizeMode
GtkResizeMode getResizeMode()

Returns the resize mode for the container. See gtk_container_set_resize_mode().

setResizeMode
void setResizeMode(GtkResizeMode resizeMode)

Sets the resize mode for the container. The resize mode of a container determines whether a resize request will be passed to the container's parent, queued for later execution or executed immediately.

checkResize
void checkResize()
foreac
void foreac(GtkCallback callback, void* callbackData)

Invokes callback on each non-internal child of container. See gtk_container_forall() for details on what constitutes an "internal" child. Most applications should use gtk_container_foreach(), rather than gtk_container_forall().

getChildren
ListG getChildren()

Returns the container's non-internal children. See gtk_container_forall() for details on what constitutes an "internal" child.

getPathForChild
WidgetPath getPathForChild(Widget child)

Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including child.

setReallocateRedraws
void setReallocateRedraws(int needsRedraws)

Sets the reallocate_redraws flag of the container to the given value. Containers requesting reallocation redraws get automatically redrawn if any of their children changed allocation.

getFocusChild
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_get_focus(). Since 2.14

setFocusChild
void setFocusChild(Widget child)

Sets, or unsets if child is NULL, the focused child of container. This function emits the GtkContainer::set_focus_child signal of container. Implementations of GtkContainer can override the default behaviour by overriding the class closure of this signal. This is function is mostly meant to be used by widgets. Applications can use gtk_widget_grab_focus() to manualy set the focus to a specific widget.

getFocusVadjustment
Adjustment getFocusVadjustment()

Retrieves the vertical focus adjustment for the container. See gtk_container_set_focus_vadjustment().

setFocusVadjustment
void setFocusVadjustment(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_get_vadjustment() for a typical way of obtaining the adjustment and gtk_container_set_focus_hadjustment() for setting the horizontal adjustment. The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the container.

getFocusHadjustment
Adjustment getFocusHadjustment()

Retrieves the horizontal focus adjustment for the container. See gtk_container_set_focus_hadjustment().

setFocusHadjustment
void setFocusHadjustment(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_get_hadjustment() for a typical way of obtaining the adjustment and gtk_container_set_focus_vadjustment() for setting the vertical adjustment. The adjustments have to be in pixel units and in the same coordinate system as the allocation for immediate children of the container.

resizeChildren
void resizeChildren()

Warning gtk_container_resize_children is deprecated and should not be used in newly-written code. 3.10

childType
GType childType()

Returns the type of the children supported by the container. Note that this may return G_TYPE_NONE to indicate that no more children can be added, e.g. for a GtkPaned which already has two children.

childGetProperty
void childGetProperty(Widget child, string propertyName, Value value)

Gets the value of a child property for child and container.

childSetProperty
void childSetProperty(Widget child, string propertyName, Value value)

Sets a child property for child and container.

childGetValist
void childGetValist(Widget child, string firstPropertyName, void* varArgs)

Gets the values of one or more child properties for child and container.

childSetValist
void childSetValist(Widget child, string firstPropertyName, void* varArgs)

Sets one or more child properties for child and container.

childNotify
void childNotify(Widget child, string childProperty)

Emits a "child-notify" signal for the child property child_property on widget. This is an analogue of g_object_notify() for child properties. Also see gtk_widget_child_notify().

forall
void forall(GtkCallback callback, void* callbackData)

Invokes callback on each 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. Most applications should use gtk_container_foreach(), rather than gtk_container_forall(). Virtual: forall

getBorderWidth
uint getBorderWidth()

Retrieves the border width of the container. See gtk_container_set_border_width().

setBorderWidth
void setBorderWidth(uint borderWidth)

Sets the border width of the container. The border width of a container is the amount of space to leave around the outside of the container. The only exception to this is GtkWindow; because toplevel windows can't leave space outside, they leave the space inside. The border is added on all sides of the container. To add space to only one side, one approach is to create a GtkAlignment widget, call gtk_widget_set_size_request() to give it a size, and place it on the side of the container as a spacer.

propagateDraw
void propagateDraw(Widget child, Context cr)

When a container receives a call to the draw function, it must send synthetic "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 "draw" function, calls gtk_container_propagate_draw() once for each child, passing in the cr the container received. gtk_container_propagate_draw() takes care of translating the origin of cr, and deciding whether the draw needs to be sent to the child. It is a convenient and optimized way of getting the same effect as calling gtk_widget_draw() on the child directly. In most cases, a container can simply either inherit the "draw" implementation from GtkContainer, or do some drawing and then chain to the ::draw implementation from GtkContainer.

getFocusChain
int getFocusChain(ListG 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.

setFocusChain
void setFocusChain(ListG focusableWidgets)

Sets a focus chain, overriding the one computed automatically by GTK+. In principle each widget in the chain should be a descendant of the container, but this is not enforced by this method, since it's allowed to set the focus chain before you pack the widgets, or have a widget in the chain that isn't always packed. The necessary checks are done when the focus chain is actually traversed.

unsetFocusChain
void unsetFocusChain()

Removes a focus chain explicitly set with gtk_container_set_focus_chain().

classFindChildProperty
ParamSpec classFindChildProperty(GObjectClass* cclass, string propertyName)

Finds a child property of a container class by name.

classInstallChildProperty
void classInstallChildProperty(GtkContainerClass* cclass, uint propertyId, ParamSpec pspec)

Installs a child property on a container class.

classListChildProperties
ParamSpec[] classListChildProperties(GObjectClass* cclass)

Returns all child properties of a container class.

classHandleBorderWidth
void classHandleBorderWidth(GtkContainerClass* klass)

Modifies a subclass of GtkContainerClass to automatically add and remove the border-width setting on GtkContainer. This allows the subclass to ignore the border width in its size request and allocate methods. The intent is for a subclass to invoke this in its class_init function. gtk_container_class_handle_border_width() is necessary because it would break API too badly to make this behavior the default. So subclasses must "opt in" to the parent class handling border_width for them.

From OrientableIF

getOrientableTStruct
GtkOrientable* getOrientableTStruct()

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getOrientation
GtkOrientation getOrientation()

Retrieves the orientation of the orientable. Since 2.16

setOrientation
void setOrientation(GtkOrientation orientation)

Sets the orientation of the orientable. Since 2.16

From ToolShellIF

getToolShellTStruct
GtkToolShell* getToolShellTStruct()

Get the main Gtk struct

getStruct
void* getStruct()

the main Gtk struct as a void*

getOrientation
GtkOrientation getOrientation()

Retrieves the current orientation for the tool shell. Tool items must not call this function directly, but rely on gtk_tool_item_get_orientation() instead. Since 2.14

getEllipsizeMode
PangoEllipsizeMode getEllipsizeMode()

Retrieves the current ellipsize mode for the tool shell. Tool items must not call this function directly, but rely on gtk_tool_item_get_ellipsize_mode() instead. Since 2.20

getIconSize
GtkIconSize getIconSize()

Retrieves the icon size for the tool shell. Tool items must not call this function directly, but rely on gtk_tool_item_get_icon_size() instead. Since 2.14

getReliefStyle
GtkReliefStyle getReliefStyle()

Returns the relief style of buttons on shell. Tool items must not call this function directly, but rely on gtk_tool_item_get_relief_style() instead. Since 2.14

getToolBarStyle
GtkToolbarStyle getToolBarStyle()

Retrieves whether the tool shell has text, icons, or both. Tool items must not call this function directly, but rely on gtk_tool_item_get_toolbar_style() instead. Since 2.14

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_get_text_alignment() instead. Since 2.20

getTextOrientation
GtkOrientation getTextOrientation()

Retrieves the current text orientation for the tool shell. Tool items must not call this function directly, but rely on gtk_tool_item_get_text_orientation() instead. Since 2.20

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. Tool items must not call this function directly, but rely on gtk_tool_item_rebuild_menu() instead. Since 2.14

getTextSizeGroup
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_get_text_size_group() instead. Since 2.20

Meta