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_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_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_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_add_drag_dest() with the desired drag source @palette and the desired drag target @widget. Then gtk_tool_palette_get_drag_item() 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 , OrientableIF , ScrollableIF {

protected

GtkToolPalette* gtkToolPalette;

GtkToolPalette* getToolPaletteStruct();

void* getStruct();

void setStruct(GObject* obj);

this(GtkToolPalette* gtkToolPalette, bool ownedRef);

mixin OrientableT!(GtkToolPalette) ;

mixin ScrollableT!(GtkToolPalette) ;

static GType getType();

this();

static TargetEntry getDragTargetGroup();

static TargetEntry getDragTargetItem();

void addDragDest(Widget widget, GtkDestDefaults flags, GtkToolPaletteDragTargets targets, GdkDragAction actions);

Widget getDragItem(SelectionData selection);

ToolItemGroup getDropGroup(int x, int y);

ToolItem getDropItem(int x, int y);

bool getExclusive(ToolItemGroup group);

bool getExpand(ToolItemGroup group);

int getGroupPosition(ToolItemGroup group);

GtkIconSize getIconSize();

GtkToolbarStyle getToolbarStyle();

void setDragSource(GtkToolPaletteDragTargets targets);

void setExclusive(ToolItemGroup group, bool exclusive);

void setExpand(ToolItemGroup group, bool expand);

void setGroupPosition(ToolItemGroup group, int position);

void setIconSize(GtkIconSize iconSize);

void setStyle(GtkToolbarStyle style);

void unsetIconSize();

void unsetStyle();

}

Constructors

this this(GtkToolPalette* gtkToolPalette, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(): Creates a new tool palette.

Members

Functions

addDragDest void addDragDest(Widget widget, GtkDestDefaults flags, GtkToolPaletteDragTargets targets, GdkDragAction actions): Sets @palette as drag source (see gtk_tool_palette_set_drag_source()) and sets @widget as a drag destination for drags from @palette. See gtk_drag_dest_set().
getDragItem Widget getDragItem(SelectionData selection): Get the dragged item from the selection. This could be a #GtkToolItem or a #GtkToolItemGroup.
getDropGroup ToolItemGroup getDropGroup(int x, int y): Gets the group at position (x, y).
getDropItem ToolItem getDropItem(int x, int y): Gets the item at position (x, y). See gtk_tool_palette_get_drop_group().
getExclusive bool getExclusive(ToolItemGroup group): Gets whether @group is exclusive or not. See gtk_tool_palette_set_exclusive().
getExpand bool getExpand(ToolItemGroup group): Gets whether group should be given extra space. See gtk_tool_palette_set_expand().
getGroupPosition int getGroupPosition(ToolItemGroup group): Gets the position of @group in @palette as index. See gtk_tool_palette_set_group_position().
getIconSize GtkIconSize getIconSize(): Gets the size of icons in the tool palette. See gtk_tool_palette_set_icon_size().
getStruct void* getStruct(): the main Gtk struct as a void*
getToolPaletteStruct GtkToolPalette* getToolPaletteStruct(): Get the main Gtk struct
getToolbarStyle GtkToolbarStyle getToolbarStyle(): Gets the style (icons, text or both) of items in the tool palette.
setDragSource void setDragSource(GtkToolPaletteDragTargets 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_drag_source_set().
setExclusive void setExclusive(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(ToolItemGroup group, bool expand): Sets whether the group should be given extra space.
setGroupPosition void setGroupPosition(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(GtkIconSize iconSize): Sets the size of icons in the tool palette.
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): 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_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_tool_palette_set_style(), so that user preferences will be used to determine the toolbar style.

Mixins

__anonymous mixin OrientableT!(GtkToolPalette): Undocumented in source.
__anonymous mixin ScrollableT!(GtkToolPalette): Undocumented in source.

Static functions

getDragTargetGroup TargetEntry getDragTargetGroup(): Get the target entry for a dragged #GtkToolItemGroup.
getDragTargetItem TargetEntry getDragTargetItem(): Gets the target entry for a dragged #GtkToolItem.
getType GType getType()

Variables

gtkToolPalette GtkToolPalette* gtkToolPalette;: the main Gtk struct

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
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.
internalRemoveOnAdd void internalRemoveOnAdd(OnAddDelegateWrapper source): 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.
internalRemoveOnCheckResize void internalRemoveOnCheckResize(OnCheckResizeDelegateWrapper source): 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.
internalRemoveOnRemove void internalRemoveOnRemove(OnRemoveDelegateWrapper source): 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.
internalRemoveOnSetFocusChild void internalRemoveOnSetFocusChild(OnSetFocusChildDelegateWrapper source): Undocumented in source. Be warned that the author may not have intended to support it.

From OrientableIF

getOrientableStruct GtkOrientable* getOrientableStruct(): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getOrientation GtkOrientation getOrientation(): Retrieves the orientation of the @orientable.
setOrientation void setOrientation(GtkOrientation orientation): Sets the orientation of the @orientable.

From ScrollableIF

getScrollableStruct GtkScrollable* getScrollableStruct(): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getBorder bool getBorder(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 Adjustment getHadjustment(): Retrieves the #GtkAdjustment used for horizontal scrolling.
getHscrollPolicy GtkScrollablePolicy getHscrollPolicy(): Gets the horizontal #GtkScrollablePolicy.
getVadjustment Adjustment getVadjustment(): Retrieves the #GtkAdjustment used for vertical scrolling.
getVscrollPolicy GtkScrollablePolicy getVscrollPolicy(): Gets the vertical #GtkScrollablePolicy.
setHadjustment void setHadjustment(Adjustment hadjustment): Sets the horizontal adjustment of the #GtkScrollable.
setHscrollPolicy void setHscrollPolicy(GtkScrollablePolicy policy): Sets the #GtkScrollablePolicy to determine whether horizontal scrolling should start below the minimum width or below the natural width.
setVadjustment void setVadjustment(Adjustment vadjustment): Sets the vertical adjustment of the #GtkScrollable.
setVscrollPolicy void setVscrollPolicy(GtkScrollablePolicy policy): Sets the #GtkScrollablePolicy to determine whether vertical scrolling should start below the minimum height or below the natural height.