Struct gtk::ToolPalette

#[repr(transparent)]
pub struct ToolPalette { /* private fields */ }

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

A ToolPalette is created with a call to new().

GtkToolItems cannot be added directly to a ToolPalette - instead they are added to a ToolItemGroup which can than be added to a ToolPalette. To add a ToolItemGroup to a ToolPalette, use ContainerExt::add().

⚠️ The following code is in C ⚠️

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 ToolPalette is to call ToolPaletteExt::add_drag_dest() with the desired drag source palette and the desired drag target widget. Then ToolPaletteExt::drag_item() can be used to get the dragged item in the signal::Widget::drag-data-received signal handler of the drag target.

⚠️ The following code is in C ⚠️

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.

Implements

ToolPaletteExt, ContainerExt, WidgetExt, glib::ObjectExt, BuildableExt, OrientableExt, ScrollableExt, ContainerExtManual, WidgetExtManual, BuildableExtManual

Implementations

impl ToolPalette

pub const NONE: Option<&'static ToolPalette> = None

pub fn new() -> ToolPalette

Creates a new tool palette.

Returns

a new ToolPalette

pub fn builder() -> ToolPaletteBuilder

Creates a new builder-pattern struct instance to construct ToolPalette objects.

This method returns an instance of ToolPaletteBuilder which can be used to create ToolPalette objects.

pub fn drag_target_group() -> Option<TargetEntry>

Get the target entry for a dragged ToolItemGroup.

Returns

the TargetEntry for a dragged group

pub fn drag_target_item() -> Option<TargetEntry>

Gets the target entry for a dragged ToolItem.

Returns

the TargetEntry for a dragged item.

Trait Implementations

impl Clone for ToolPalette

fn clone(&self) -> Self

Returns a copy of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ToolPalette

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ToolPalette

fn default() -> Self

Returns the “default value” for a type.

impl Display for ToolPalette

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for ToolPalette

fn hash<H>(&self, state: &mut H)where
    H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl Ord for ToolPalette

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

const fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

const fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for ToolPalette

type Parent = Container

impl<OT: ObjectType> PartialEq<OT> for ToolPalette

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for ToolPalette

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

const fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

const fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

const fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

const fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for ToolPalette

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ToolPalette

impl IsA<Buildable> for ToolPalette

impl IsA<Container> for ToolPalette

impl IsA<Orientable> for ToolPalette

impl IsA<Scrollable> for ToolPalette

impl IsA<Widget> for ToolPalette