ToolPalette

A #GtkToolPalette allows you to add #GtkToolItems to a palette-like container with different categories and drag and drop support.

A #GtkToolPalette is created with a call to gtk.tool_palette.ToolPalette.new_.

#GtkToolItems cannot be added directly to a #GtkToolPalette - instead they are added to a #GtkToolItemGroup which can than be added to a #GtkToolPalette. To add a #GtkToolItemGroup to a #GtkToolPalette, use gtk.container.Container.add.

GtkWidget *palette, *group;
GtkToolItem *item;

palette = gtk_tool_palette_new ();
group = gtk_tool_item_group_new (_("Test Category"));
gtk_container_add (GTK_CONTAINER (palette), group);

item = gtk_tool_button_new (NULL, _("_Open"));
gtk_tool_button_set_icon_name (GTK_TOOL_BUTTON (item), "document-open");
gtk_tool_item_group_insert (GTK_TOOL_ITEM_GROUP (group), item, -1);

The easiest way to use drag and drop with #GtkToolPalette is to call gtk.tool_palette.ToolPalette.addDragDest with the desired drag source @palette and the desired drag target @widget. Then gtk.tool_palette.ToolPalette.getDragItem can be used to get the dragged item in the #GtkWidget::drag-data-received signal handler of the drag target.

static void
passive_canvas_drag_data_received (GtkWidget        *widget,
                                   GdkDragContext   *context,
                                   gint              x,
                                   gint              y,
                                   GtkSelectionData *selection,
                                   guint             info,
                                   guint             time,
                                   gpointer          data)
{
  GtkWidget *palette;
  GtkWidget *item;

  // Get the dragged item
  palette = gtk_widget_get_ancestor (gtk_drag_get_source_widget (context),
                                     GTK_TYPE_TOOL_PALETTE);
  if (palette != NULL)
    item = gtk_tool_palette_get_drag_item (GTK_TOOL_PALETTE (palette),
                                           selection);

  // Do something with item
}

GtkWidget *target, palette;

palette = gtk_tool_palette_new ();
target = gtk_drawing_area_new ();

g_signal_connect (G_OBJECT (target), "drag-data-received",
                  G_CALLBACK (passive_canvas_drag_data_received), NULL);
gtk_tool_palette_add_drag_dest (GTK_TOOL_PALETTE (palette), target,
                                GTK_DEST_DEFAULT_ALL,
                                GTK_TOOL_PALETTE_DRAG_ITEMS,
                                GDK_ACTION_COPY);

CSS nodes

GtkToolPalette has a single CSS node named toolpalette.

class ToolPalette : Container , Orientable , Scrollable {

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

static GType _getGType();

GType _gType [@property getter];

ToolPalette self();

static ToolPaletteGidBuilder builder();

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

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

bool iconSizeSet [@property getter];

bool iconSizeSet [@property setter];

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

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

this();

static gtk.target_entry.TargetEntry getDragTargetGroup();

static gtk.target_entry.TargetEntry getDragTargetItem();

void addDragDest(gtk.widget.Widget widget, gtk.types.DestDefaults flags, gtk.types.ToolPaletteDragTargets targets, gdk.types.DragAction actions);

gtk.widget.Widget getDragItem(gtk.selection_data.SelectionData selection);

gtk.tool_item_group.ToolItemGroup getDropGroup(int x, int y);

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

bool getExclusive(gtk.tool_item_group.ToolItemGroup group);

bool getExpand(gtk.tool_item_group.ToolItemGroup group);

int getGroupPosition(gtk.tool_item_group.ToolItemGroup group);

gtk.adjustment.Adjustment getHadjustment();

gtk.types.IconSize getIconSize();

gtk.types.ToolbarStyle getStyle();

gtk.adjustment.Adjustment getVadjustment();

void setDragSource(gtk.types.ToolPaletteDragTargets targets);

void setExclusive(gtk.tool_item_group.ToolItemGroup group, bool exclusive);

void setExpand(gtk.tool_item_group.ToolItemGroup group, bool expand);

void setGroupPosition(gtk.tool_item_group.ToolItemGroup group, int position);

void setIconSize(gtk.types.IconSize iconSize);

void setStyle(gtk.types.ToolbarStyle style);

void unsetIconSize();

void unsetStyle();

}

Constructors

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

Members

Functions

addDragDest void addDragDest(gtk.widget.Widget widget, gtk.types.DestDefaults flags, gtk.types.ToolPaletteDragTargets targets, gdk.types.DragAction actions): Sets palette as drag source (see gtk.tool_palette.ToolPalette.setDragSource) and sets widget as a drag destination for drags from palette. See gtk.widget.Widget.dragDestSet.
getDragItem gtk.widget.Widget getDragItem(gtk.selection_data.SelectionData selection): Get the dragged item from the selection. This could be a #GtkToolItem or a #GtkToolItemGroup.
getDropGroup gtk.tool_item_group.ToolItemGroup getDropGroup(int x, int y): Gets the group at position (x, y).
getDropItem gtk.tool_item.ToolItem getDropItem(int x, int y): Gets the item at position (x, y). See gtk.tool_palette.ToolPalette.getDropGroup.
getExclusive bool getExclusive(gtk.tool_item_group.ToolItemGroup group): Gets whether group is exclusive or not. See gtk.tool_palette.ToolPalette.setExclusive.
getExpand bool getExpand(gtk.tool_item_group.ToolItemGroup group): Gets whether group should be given extra space. See gtk.tool_palette.ToolPalette.setExpand.
getGroupPosition int getGroupPosition(gtk.tool_item_group.ToolItemGroup group): Gets the position of group in palette as index. See gtk.tool_palette.ToolPalette.setGroupPosition.
getHadjustment gtk.adjustment.Adjustment getHadjustment(): Gets the horizontal adjustment of the tool palette.
getIconSize gtk.types.IconSize getIconSize(): Gets the size of icons in the tool palette. See gtk.tool_palette.ToolPalette.setIconSize.
getStyle gtk.types.ToolbarStyle getStyle(): Gets the style (icons, text or both) of items in the tool palette.
getVadjustment gtk.adjustment.Adjustment getVadjustment(): Gets the vertical adjustment of the tool palette.
self ToolPalette self(): Returns this, for use in with statements.
setDragSource void setDragSource(gtk.types.ToolPaletteDragTargets targets): Sets the tool palette as a drag source. Enables all groups and items in the tool palette as drag sources on button 1 and button 3 press with copy and move actions. See gtk.widget.Widget.dragSourceSet.
setExclusive void setExclusive(gtk.tool_item_group.ToolItemGroup group, bool exclusive): Sets whether the group should be exclusive or not. If an exclusive group is expanded all other groups are collapsed.
setExpand void setExpand(gtk.tool_item_group.ToolItemGroup group, bool expand): Sets whether the group should be given extra space.
setGroupPosition void setGroupPosition(gtk.tool_item_group.ToolItemGroup group, int position): Sets the position of the group as an index of the tool palette. If position is 0 the group will become the first child, if position is -1 it will become the last child.
setIconSize void setIconSize(gtk.types.IconSize iconSize): Sets the size of icons in the tool palette.
setStyle void setStyle(gtk.types.ToolbarStyle style): Sets the style (text, icons or both) of items in the tool palette.
unsetIconSize void unsetIconSize(): Unsets the tool palette icon size set with gtk.tool_palette.ToolPalette.setIconSize, so that user preferences will be used to determine the icon size.
unsetStyle void unsetStyle(): Unsets a toolbar style set with gtk.tool_palette.ToolPalette.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.
toolbarStyle gtk.types.ToolbarStyle toolbarStyle [@property getter]: Get toolbarStyle property.
toolbarStyle gtk.types.ToolbarStyle toolbarStyle [@property setter]: Set toolbarStyle property.

Static functions

_getGType GType _getGType()
builder ToolPaletteGidBuilder builder(): Get builder for gtk.tool_palette.ToolPalette
getDragTargetGroup gtk.target_entry.TargetEntry getDragTargetGroup(): Get the target entry for a dragged #GtkToolItemGroup.
getDragTargetItem gtk.target_entry.TargetEntry getDragTargetItem(): Gets the target entry for a dragged #GtkToolItem.

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 ScrollableT!()`

hadjustment gtk.adjustment.Adjustment hadjustment [@property getter]: Get hadjustment property.
hadjustment gtk.adjustment.Adjustment hadjustment [@property setter]: Set hadjustment property.
hscrollPolicy gtk.types.ScrollablePolicy hscrollPolicy [@property getter]: Get hscrollPolicy property.
hscrollPolicy gtk.types.ScrollablePolicy hscrollPolicy [@property setter]: Set hscrollPolicy property.
vadjustment gtk.adjustment.Adjustment vadjustment [@property getter]: Get vadjustment property.
vadjustment gtk.adjustment.Adjustment vadjustment [@property setter]: Set vadjustment property.
vscrollPolicy gtk.types.ScrollablePolicy vscrollPolicy [@property getter]: Get vscrollPolicy property.
vscrollPolicy gtk.types.ScrollablePolicy vscrollPolicy [@property setter]: Set vscrollPolicy property.
getBorder bool getBorder(gtk.border.Border border): Returns the size of a non-scrolling border around the outside of the scrollable. An example for this would be treeview headers. GTK+ can use this information to display overlayed graphics, like the overshoot indication, at the right position.
getHadjustment gtk.adjustment.Adjustment getHadjustment(): Retrieves the #GtkAdjustment used for horizontal scrolling.
getHscrollPolicy gtk.types.ScrollablePolicy getHscrollPolicy(): Gets the horizontal #GtkScrollablePolicy.
getVadjustment gtk.adjustment.Adjustment getVadjustment(): Retrieves the #GtkAdjustment used for vertical scrolling.
getVscrollPolicy gtk.types.ScrollablePolicy getVscrollPolicy(): Gets the vertical #GtkScrollablePolicy.
setHadjustment void setHadjustment(gtk.adjustment.Adjustment hadjustment): Sets the horizontal adjustment of the #GtkScrollable.
setHscrollPolicy void setHscrollPolicy(gtk.types.ScrollablePolicy policy): Sets the #GtkScrollablePolicy to determine whether horizontal scrolling should start below the minimum width or below the natural width.
setVadjustment void setVadjustment(gtk.adjustment.Adjustment vadjustment): Sets the vertical adjustment of the #GtkScrollable.
setVscrollPolicy void setVscrollPolicy(gtk.types.ScrollablePolicy policy): Sets the #GtkScrollablePolicy to determine whether vertical scrolling should start below the minimum height or below the natural height.

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 Scrollable

_getGType GType _getGType()
hadjustment gtk.adjustment.Adjustment hadjustment [@property getter]: Get hadjustment property.
hadjustment gtk.adjustment.Adjustment hadjustment [@property setter]: Set hadjustment property.
hscrollPolicy gtk.types.ScrollablePolicy hscrollPolicy [@property getter]: Get hscrollPolicy property.
hscrollPolicy gtk.types.ScrollablePolicy hscrollPolicy [@property setter]: Set hscrollPolicy property.
vadjustment gtk.adjustment.Adjustment vadjustment [@property getter]: Get vadjustment property.
vadjustment gtk.adjustment.Adjustment vadjustment [@property setter]: Set vadjustment property.
vscrollPolicy gtk.types.ScrollablePolicy vscrollPolicy [@property getter]: Get vscrollPolicy property.
vscrollPolicy gtk.types.ScrollablePolicy vscrollPolicy [@property setter]: Set vscrollPolicy property.
getBorder bool getBorder(gtk.border.Border border): Returns the size of a non-scrolling border around the outside of the scrollable. An example for this would be treeview headers. GTK+ can use this information to display overlayed graphics, like the overshoot indication, at the right position.
getHadjustment gtk.adjustment.Adjustment getHadjustment(): Retrieves the #GtkAdjustment used for horizontal scrolling.
getHscrollPolicy gtk.types.ScrollablePolicy getHscrollPolicy(): Gets the horizontal #GtkScrollablePolicy.
getVadjustment gtk.adjustment.Adjustment getVadjustment(): Retrieves the #GtkAdjustment used for vertical scrolling.
getVscrollPolicy gtk.types.ScrollablePolicy getVscrollPolicy(): Gets the vertical #GtkScrollablePolicy.
setHadjustment void setHadjustment(gtk.adjustment.Adjustment hadjustment): Sets the horizontal adjustment of the #GtkScrollable.
setHscrollPolicy void setHscrollPolicy(gtk.types.ScrollablePolicy policy): Sets the #GtkScrollablePolicy to determine whether horizontal scrolling should start below the minimum width or below the natural width.
setVadjustment void setVadjustment(gtk.adjustment.Adjustment vadjustment): Sets the vertical adjustment of the #GtkScrollable.
setVscrollPolicy void setVscrollPolicy(gtk.types.ScrollablePolicy policy): Sets the #GtkScrollablePolicy to determine whether vertical scrolling should start below the minimum height or below the natural height.

gtk tool_palette classes

ToolPalette

CSS nodes

From mixin OrientableT!()

From mixin ScrollableT!()

From `mixin OrientableT!()`

From `mixin ScrollableT!()`