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 , ToolShell {

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

static GType _getGType();

GType _gType [@property getter];

ToolItemGroup self();

static ToolItemGroupGidBuilder builder();

bool collapsed [@property getter];

bool collapsed [@property setter];

pango.types.EllipsizeMode ellipsize [@property getter];

pango.types.EllipsizeMode ellipsize [@property setter];

gtk.types.ReliefStyle headerRelief [@property getter];

gtk.types.ReliefStyle headerRelief [@property setter];

string label [@property getter];

string label [@property setter];

gtk.widget.Widget labelWidget [@property getter];

gtk.widget.Widget labelWidget [@property setter];

this(string label);

bool getCollapsed();

gtk.tool_item.ToolItem getDropItem(int x, int y);

pango.types.EllipsizeMode getEllipsize();

gtk.types.ReliefStyle getHeaderRelief();

int getItemPosition(gtk.tool_item.ToolItem item);

string getLabel();

gtk.widget.Widget getLabelWidget();

uint getNItems();

gtk.tool_item.ToolItem getNthItem(uint index);

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

void setCollapsed(bool collapsed);

void setEllipsize(pango.types.EllipsizeMode ellipsize);

void setHeaderRelief(gtk.types.ReliefStyle style);

void setItemPosition(gtk.tool_item.ToolItem item, int position);

void setLabel(string label);

void setLabelWidget(gtk.widget.Widget labelWidget);

}

Constructors

this this(void* ptr, Flag!"Take" take)
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 gtk.tool_item.ToolItem getDropItem(int x, int y): Gets the tool item at position (x, y).
getEllipsize pango.types.EllipsizeMode getEllipsize(): Gets the ellipsization mode of group.
getHeaderRelief gtk.types.ReliefStyle getHeaderRelief(): Gets the relief mode of the header button of group.
getItemPosition int getItemPosition(gtk.tool_item.ToolItem item): Gets the position of item in group as index.
getLabel string getLabel(): Gets the label of group.
getLabelWidget gtk.widget.Widget getLabelWidget(): Gets the label widget of group. See gtk.tool_item_group.ToolItemGroup.setLabelWidget.
getNItems uint getNItems(): Gets the number of tool items in group.
getNthItem gtk.tool_item.ToolItem getNthItem(uint index): Gets the tool item at index in group.
insert void insert(gtk.tool_item.ToolItem item, int position): Inserts item at position in the list of children of group.
self ToolItemGroup self(): Returns this, for use in with statements.
setCollapsed void setCollapsed(bool collapsed): Sets whether the group should be collapsed or expanded.
setEllipsize void setEllipsize(pango.types.EllipsizeMode ellipsize): Sets the ellipsization mode which should be used by labels in group.
setHeaderRelief void setHeaderRelief(gtk.types.ReliefStyle style): Set the button relief of the group header. See gtk.button.Button.setRelief for details.
setItemPosition void setItemPosition(gtk.tool_item.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(gtk.widget.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.

Properties

_gType GType _gType [@property getter]
collapsed bool collapsed [@property getter]
collapsed bool collapsed [@property setter]
ellipsize pango.types.EllipsizeMode ellipsize [@property getter]
ellipsize pango.types.EllipsizeMode ellipsize [@property setter]
headerRelief gtk.types.ReliefStyle headerRelief [@property getter]
headerRelief gtk.types.ReliefStyle headerRelief [@property setter]
label string label [@property getter]
label string label [@property setter]
labelWidget gtk.widget.Widget labelWidget [@property getter]
labelWidget gtk.widget.Widget labelWidget [@property setter]

Static functions

_getGType GType _getGType()
builder ToolItemGroupGidBuilder builder(): Get builder for gtk.tool_item_group.ToolItemGroup

Mixed In Members

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 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 tool_item_group classes

ToolItemGroup

CSS nodes

From mixin ToolShellT!()

From `mixin ToolShellT!()`