ToolItemGroup

A #GtkToolItemGroup is used together with #GtkToolPalette to add #GtkToolItems to a palette like container with different categories and drag and drop support.

CSS nodes

GtkToolItemGroup has a single CSS node named toolitemgroup.

class ToolItemGroup : Container , ToolShellIF {

protected

GtkToolItemGroup* gtkToolItemGroup;

GtkToolItemGroup* getToolItemGroupStruct(bool transferOwnership);

void* getStruct();

void setStruct(GObject* obj);

this(GtkToolItemGroup* gtkToolItemGroup, bool ownedRef);

mixin ToolShellT!(GtkToolItemGroup) ;

GtkOrientation getOrientation();

static GType getType();

this(string label);

bool getCollapsed();

ToolItem getDropItem(int x, int y);

PangoEllipsizeMode getEllipsize();

GtkReliefStyle getHeaderRelief();

int getItemPosition(ToolItem item);

string getLabel();

Widget getLabelWidget();

uint getNItems();

ToolItem getNthItem(uint index);

void insert(ToolItem item, int position);

void setCollapsed(bool collapsed);

void setEllipsize(PangoEllipsizeMode ellipsize);

void setHeaderRelief(GtkReliefStyle style);

void setItemPosition(ToolItem item, int position);

void setLabel(string label);

void setLabelWidget(Widget labelWidget);

}

Constructors

this this(GtkToolItemGroup* gtkToolItemGroup, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(string label): Creates a new tool item group with label @label.

Members

Functions

getCollapsed bool getCollapsed(): Gets whether @group is collapsed or expanded.
getDropItem ToolItem getDropItem(int x, int y): Gets the tool item at position (x, y).
getEllipsize PangoEllipsizeMode getEllipsize(): Gets the ellipsization mode of @group.
getHeaderRelief GtkReliefStyle getHeaderRelief(): Gets the relief mode of the header button of @group.
getItemPosition int getItemPosition(ToolItem item): Gets the position of @item in @group as index.
getLabel string getLabel(): Gets the label of @group.
getLabelWidget Widget getLabelWidget(): Gets the label widget of @group. See gtk_tool_item_group_set_label_widget().
getNItems uint getNItems(): Gets the number of tool items in @group.
getNthItem ToolItem getNthItem(uint index): Gets the tool item at @index in group.
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
getStruct void* getStruct(): the main Gtk struct as a void*
getToolItemGroupStruct GtkToolItemGroup* getToolItemGroupStruct(bool transferOwnership): Get the main Gtk struct
insert void insert(ToolItem item, int position): Inserts @item at @position in the list of children of @group.
setCollapsed void setCollapsed(bool collapsed): Sets whether the @group should be collapsed or expanded.
setEllipsize void setEllipsize(PangoEllipsizeMode ellipsize): Sets the ellipsization mode which should be used by labels in @group.
setHeaderRelief void setHeaderRelief(GtkReliefStyle style): Set the button relief of the group header. See gtk_button_set_relief() for details.
setItemPosition void setItemPosition(ToolItem item, int position): Sets the position of @item in the list of children of @group.
setLabel void setLabel(string label): Sets the label of the tool item group. The label is displayed in the header of the group.
setLabelWidget void setLabelWidget(Widget labelWidget): Sets the label of the tool item group. The label widget is displayed in the header of the group, in place of the usual label.
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.

Mixins

__anonymous mixin ToolShellT!(GtkToolItemGroup): Undocumented in source.

Static functions

getType GType getType()

Variables

gtkToolItemGroup GtkToolItemGroup* gtkToolItemGroup;: the main Gtk struct

Inherited Members

From Container

gtkContainer GtkContainer* gtkContainer;: the main Gtk struct
getContainerStruct GtkContainer* getContainerStruct(bool transferOwnership): 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
getType GType getType()
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.
checkResize void checkResize()
childGetProperty void childGetProperty(Widget child, string propertyName, Value value): Gets the value of 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.
childNotify void childNotify(Widget child, string childProperty): Emits a #GtkWidget::child-notify signal for the [child property][child-properties] @child_property on the child.
childNotifyByPspec void childNotifyByPspec(Widget child, ParamSpec pspec): Emits a #GtkWidget::child-notify signal for the [child property][child-properties] specified by @pspec on the child.
childSetProperty void childSetProperty(Widget child, string propertyName, Value value): Sets a child property for @child and @container.
childSetValist void childSetValist(Widget child, string firstPropertyName, void* varArgs): Sets one or more child properties for @child and @container.
childType GType childType(): Returns the type of the children supported by the container.
forall void forall(GtkCallback callback, void* callbackData): 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.
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. 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_set_border_width().
getChildren ListG getChildren(): Returns the container’s non-internal children. See gtk_container_forall() for details on what constitutes an "internal" child.
getFocusChain bool 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.
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().
getFocusHadjustment Adjustment getFocusHadjustment(): Retrieves the horizontal focus adjustment for the container. See gtk_container_set_focus_hadjustment ().
getFocusVadjustment Adjustment getFocusVadjustment(): Retrieves the vertical focus adjustment for the container. See gtk_container_set_focus_vadjustment().
getPathForChild WidgetPath getPathForChild(Widget child): Returns a newly created widget path representing all the widget hierarchy from the toplevel down to and including @child.
getResizeMode GtkResizeMode getResizeMode(): Returns the resize mode for the container. See gtk_container_set_resize_mode ().
propagateDraw void propagateDraw(Widget child, 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_propagate_draw() once for each child, passing in the @cr the container received.
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 before removing it from 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.
resizeChildren void resizeChildren()
setBorderWidth void setBorderWidth(uint borderWidth): Sets the border width of the container.
setFocusChain void setFocusChain(ListG focusableWidgets): Sets a focus chain, overriding the one computed automatically by GTK+.
setFocusChild void setFocusChild(Widget child): Sets, or unsets if @child is %NULL, the focused child of @container.
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.
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.
setReallocateRedraws void setReallocateRedraws(bool needsRedraws): Sets the @reallocate_redraws flag of the container to the given value.
setResizeMode void setResizeMode(GtkResizeMode resizeMode): Sets the resize mode for the container.
unsetFocusChain void unsetFocusChain(): Removes a focus chain explicitly set with gtk_container_set_focus_chain().
OnAddDelegateWrapper class OnAddDelegateWrapper: Undocumented in source.
onAddListeners OnAddDelegateWrapper[] onAddListeners;: Undocumented in source.
addOnAdd gulong addOnAdd(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackAdd void callBackAdd(GtkContainer* containerStruct, GtkWidget* object, OnAddDelegateWrapper wrapper): Undocumented in source. Be warned that the author may not have intended to support it.
callBackAddDestroy void callBackAddDestroy(OnAddDelegateWrapper wrapper, GClosure* closure): Undocumented in source. Be warned that the author may not have intended to support it.
OnCheckResizeDelegateWrapper class OnCheckResizeDelegateWrapper: Undocumented in source.
onCheckResizeListeners OnCheckResizeDelegateWrapper[] onCheckResizeListeners;: Undocumented in source.
addOnCheckResize gulong addOnCheckResize(void delegate(Container) dlg, ConnectFlags connectFlags)
callBackCheckResize void callBackCheckResize(GtkContainer* containerStruct, OnCheckResizeDelegateWrapper wrapper): Undocumented in source. Be warned that the author may not have intended to support it.
callBackCheckResizeDestroy void callBackCheckResizeDestroy(OnCheckResizeDelegateWrapper wrapper, GClosure* closure): Undocumented in source. Be warned that the author may not have intended to support it.
OnRemoveDelegateWrapper class OnRemoveDelegateWrapper: Undocumented in source.
onRemoveListeners OnRemoveDelegateWrapper[] onRemoveListeners;: Undocumented in source.
addOnRemove gulong addOnRemove(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackRemove void callBackRemove(GtkContainer* containerStruct, GtkWidget* object, OnRemoveDelegateWrapper wrapper): Undocumented in source. Be warned that the author may not have intended to support it.
callBackRemoveDestroy void callBackRemoveDestroy(OnRemoveDelegateWrapper wrapper, GClosure* closure): Undocumented in source. Be warned that the author may not have intended to support it.
OnSetFocusChildDelegateWrapper class OnSetFocusChildDelegateWrapper: Undocumented in source.
onSetFocusChildListeners OnSetFocusChildDelegateWrapper[] onSetFocusChildListeners;: Undocumented in source.
addOnSetFocusChild gulong addOnSetFocusChild(void delegate(Widget, Container) dlg, ConnectFlags connectFlags)
callBackSetFocusChild void callBackSetFocusChild(GtkContainer* containerStruct, GtkWidget* object, OnSetFocusChildDelegateWrapper wrapper): Undocumented in source. Be warned that the author may not have intended to support it.
callBackSetFocusChildDestroy void callBackSetFocusChildDestroy(OnSetFocusChildDelegateWrapper wrapper, GClosure* closure): Undocumented in source. Be warned that the author may not have intended to support it.

From ToolShellIF

getToolShellStruct GtkToolShell* getToolShellStruct(bool transferOwnership): 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.
getType GType getType()
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.
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.
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.
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.
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.
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.
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.
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.