3 * Copyright (C) 2002 Anders Carlsson <andersca@codefactory.se>
4 * Copyright (C) 2002 James Henstridge <james@daa.com.au>
5 * Copyright (C) 2003 Soeren Sandmann <sandmann@daimi.au.dk>
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
23 #include "gtktoolitem.h"
24 #include "gtkmarshalers.h"
25 #include "gtktoolbar.h"
26 #include "gtkseparatormenuitem.h"
32 #define MENU_ID "gtk-tool-item-menu-id"
43 PROP_VISIBLE_HORIZONTAL,
44 PROP_VISIBLE_VERTICAL,
47 struct _GtkToolItemPrivate
52 guint visible_horizontal : 1;
53 guint visible_vertical : 1;
54 guint homogeneous : 1;
57 guint use_drag_window : 1;
58 guint overflow_item : 1;
60 GdkWindow *drag_window;
66 static void gtk_tool_item_init (GtkToolItem *toolitem);
67 static void gtk_tool_item_class_init (GtkToolItemClass *class);
68 static void gtk_tool_item_finalize (GObject *object);
69 static void gtk_tool_item_parent_set (GtkWidget *toolitem,
71 static void gtk_tool_item_set_property (GObject *object,
75 static void gtk_tool_item_get_property (GObject *object,
79 static void gtk_tool_item_realize (GtkWidget *widget);
80 static void gtk_tool_item_unrealize (GtkWidget *widget);
81 static void gtk_tool_item_map (GtkWidget *widget);
82 static void gtk_tool_item_unmap (GtkWidget *widget);
83 static void gtk_tool_item_size_request (GtkWidget *widget,
84 GtkRequisition *requisition);
85 static void gtk_tool_item_size_allocate (GtkWidget *widget,
86 GtkAllocation *allocation);
87 static gboolean gtk_tool_item_real_set_tooltip (GtkToolItem *tool_item,
88 GtkTooltips *tooltips,
89 const gchar *tip_text,
90 const gchar *tip_private);
92 static gboolean gtk_tool_item_create_menu_proxy (GtkToolItem *item);
95 static GObjectClass *parent_class = NULL;
96 static guint toolitem_signals[LAST_SIGNAL] = { 0 };
99 gtk_tool_item_get_type (void)
101 static GtkType type = 0;
105 static const GTypeInfo type_info =
107 sizeof (GtkToolItemClass),
108 (GBaseInitFunc) NULL,
109 (GBaseFinalizeFunc) NULL,
110 (GClassInitFunc) gtk_tool_item_class_init,
111 (GClassFinalizeFunc) NULL,
114 sizeof (GtkToolItem),
116 (GInstanceInitFunc) gtk_tool_item_init,
119 type = g_type_register_static (GTK_TYPE_BIN,
127 gtk_tool_item_class_init (GtkToolItemClass *klass)
129 GObjectClass *object_class;
130 GtkWidgetClass *widget_class;
132 parent_class = g_type_class_peek_parent (klass);
133 object_class = (GObjectClass *)klass;
134 widget_class = (GtkWidgetClass *)klass;
136 object_class->set_property = gtk_tool_item_set_property;
137 object_class->get_property = gtk_tool_item_get_property;
138 object_class->finalize = gtk_tool_item_finalize;
140 widget_class->realize = gtk_tool_item_realize;
141 widget_class->unrealize = gtk_tool_item_unrealize;
142 widget_class->map = gtk_tool_item_map;
143 widget_class->unmap = gtk_tool_item_unmap;
144 widget_class->size_request = gtk_tool_item_size_request;
145 widget_class->size_allocate = gtk_tool_item_size_allocate;
146 widget_class->parent_set = gtk_tool_item_parent_set;
148 klass->create_menu_proxy = gtk_tool_item_create_menu_proxy;
149 klass->set_tooltip = gtk_tool_item_real_set_tooltip;
151 g_object_class_install_property (object_class,
152 PROP_VISIBLE_HORIZONTAL,
153 g_param_spec_boolean ("visible_horizontal",
154 _("Visible when horizontal"),
155 _("Whether the toolbar item is visible when the toolbar is in a horizontal orientation."),
158 g_object_class_install_property (object_class,
159 PROP_VISIBLE_VERTICAL,
160 g_param_spec_boolean ("visible_vertical",
161 _("Visible when vertical"),
162 _("Whether the toolbar item is visible when the toolbar is in a vertical orientation."),
165 toolitem_signals[CREATE_MENU_PROXY] =
166 g_signal_new ("create_menu_proxy",
167 G_OBJECT_CLASS_TYPE (klass),
169 G_STRUCT_OFFSET (GtkToolItemClass, create_menu_proxy),
170 _gtk_boolean_handled_accumulator, NULL,
171 _gtk_marshal_BOOLEAN__VOID,
173 toolitem_signals[TOOLBAR_RECONFIGURED] =
174 g_signal_new ("toolbar_reconfigured",
175 G_OBJECT_CLASS_TYPE (klass),
177 G_STRUCT_OFFSET (GtkToolItemClass, toolbar_reconfigured),
179 _gtk_marshal_VOID__VOID,
181 toolitem_signals[SET_TOOLTIP] =
182 g_signal_new ("set_tooltip",
183 G_OBJECT_CLASS_TYPE (klass),
185 G_STRUCT_OFFSET (GtkToolItemClass, set_tooltip),
186 _gtk_boolean_handled_accumulator, NULL,
187 _gtk_marshal_BOOLEAN__OBJECT_STRING_STRING,
193 g_type_class_add_private (object_class, sizeof (GtkToolItemPrivate));
197 gtk_tool_item_init (GtkToolItem *toolitem)
199 GTK_WIDGET_UNSET_FLAGS (toolitem, GTK_CAN_FOCUS);
201 toolitem->priv = GTK_TOOL_ITEM_GET_PRIVATE (toolitem);
203 toolitem->priv->visible_horizontal = TRUE;
204 toolitem->priv->visible_vertical = TRUE;
205 toolitem->priv->homogeneous = FALSE;
206 toolitem->priv->expand = FALSE;
210 gtk_tool_item_finalize (GObject *object)
212 GtkToolItem *item = GTK_TOOL_ITEM (object);
214 if (item->priv->menu_item)
215 g_object_unref (item->priv->menu_item);
217 if (G_OBJECT_CLASS (parent_class)->finalize)
218 G_OBJECT_CLASS (parent_class)->finalize (object);
222 gtk_tool_item_parent_set (GtkWidget *toolitem,
223 GtkWidget *prev_parent)
225 _gtk_tool_item_toolbar_reconfigured (GTK_TOOL_ITEM (toolitem));
229 gtk_tool_item_set_property (GObject *object,
234 GtkToolItem *toolitem = GTK_TOOL_ITEM (object);
238 case PROP_VISIBLE_HORIZONTAL:
239 gtk_tool_item_set_visible_horizontal (toolitem, g_value_get_boolean (value));
241 case PROP_VISIBLE_VERTICAL:
242 gtk_tool_item_set_visible_horizontal (toolitem, g_value_get_boolean (value));
245 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
250 gtk_tool_item_get_property (GObject *object,
255 GtkToolItem *toolitem = GTK_TOOL_ITEM (object);
259 case PROP_VISIBLE_HORIZONTAL:
260 g_value_set_boolean (value, toolitem->priv->visible_horizontal);
262 case PROP_VISIBLE_VERTICAL:
263 g_value_set_boolean (value, toolitem->priv->visible_vertical);
266 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
271 create_drag_window (GtkToolItem *toolitem)
274 GdkWindowAttr attributes;
275 gint attributes_mask, border_width;
277 g_return_if_fail (toolitem->priv->use_drag_window == TRUE);
279 widget = GTK_WIDGET (toolitem);
280 border_width = GTK_CONTAINER (toolitem)->border_width;
282 attributes.window_type = GDK_WINDOW_CHILD;
283 attributes.x = widget->allocation.x + border_width;
284 attributes.y = widget->allocation.y + border_width;
285 attributes.width = widget->allocation.width - border_width * 2;
286 attributes.height = widget->allocation.height - border_width * 2;
287 attributes.wclass = GDK_INPUT_ONLY;
288 attributes.event_mask = gtk_widget_get_events (widget);
289 attributes.event_mask |= (GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK);
291 attributes_mask = GDK_WA_X | GDK_WA_Y;
293 toolitem->priv->drag_window = gdk_window_new (gtk_widget_get_parent_window (widget),
294 &attributes, attributes_mask);
295 gdk_window_set_user_data (toolitem->priv->drag_window, toolitem);
299 gtk_tool_item_realize (GtkWidget *widget)
301 GtkToolItem *toolitem;
303 toolitem = GTK_TOOL_ITEM (widget);
304 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
306 widget->window = gtk_widget_get_parent_window (widget);
307 g_object_ref (widget->window);
309 if (toolitem->priv->use_drag_window)
310 create_drag_window(toolitem);
312 widget->style = gtk_style_attach (widget->style, widget->window);
316 destroy_drag_window (GtkToolItem *toolitem)
318 if (toolitem->priv->drag_window)
320 gdk_window_set_user_data (toolitem->priv->drag_window, NULL);
321 gdk_window_destroy (toolitem->priv->drag_window);
322 toolitem->priv->drag_window = NULL;
327 gtk_tool_item_unrealize (GtkWidget *widget)
329 GtkToolItem *toolitem;
331 toolitem = GTK_TOOL_ITEM (widget);
333 destroy_drag_window (toolitem);
335 GTK_WIDGET_CLASS (parent_class)->unrealize (widget);
339 gtk_tool_item_map (GtkWidget *widget)
341 GtkToolItem *toolitem;
343 toolitem = GTK_TOOL_ITEM (widget);
344 GTK_WIDGET_CLASS (parent_class)->map (widget);
345 if (toolitem->priv->drag_window)
346 gdk_window_show (toolitem->priv->drag_window);
350 gtk_tool_item_unmap (GtkWidget *widget)
352 GtkToolItem *toolitem;
354 toolitem = GTK_TOOL_ITEM (widget);
355 if (toolitem->priv->drag_window)
356 gdk_window_hide (toolitem->priv->drag_window);
357 GTK_WIDGET_CLASS (parent_class)->unmap (widget);
361 gtk_tool_item_size_request (GtkWidget *widget,
362 GtkRequisition *requisition)
364 GtkWidget *child = GTK_BIN (widget)->child;
366 if (child && GTK_WIDGET_VISIBLE (child))
368 gtk_widget_size_request (child, requisition);
372 requisition->height = 0;
373 requisition->width = 0;
376 requisition->width += (GTK_CONTAINER (widget)->border_width) * 2;
377 requisition->height += (GTK_CONTAINER (widget)->border_width) * 2;
381 gtk_tool_item_size_allocate (GtkWidget *widget,
382 GtkAllocation *allocation)
384 GtkToolItem *toolitem = GTK_TOOL_ITEM (widget);
385 GtkAllocation child_allocation;
387 GtkWidget *child = GTK_BIN (widget)->child;
389 widget->allocation = *allocation;
390 border_width = GTK_CONTAINER (widget)->border_width;
392 if (toolitem->priv->drag_window)
393 gdk_window_move_resize (toolitem->priv->drag_window,
394 widget->allocation.x + border_width,
395 widget->allocation.y + border_width,
396 widget->allocation.width - border_width * 2,
397 widget->allocation.height - border_width * 2);
399 if (child && GTK_WIDGET_VISIBLE (child))
401 child_allocation.x = allocation->x + border_width;
402 child_allocation.y = allocation->y + border_width;
403 child_allocation.width = allocation->width - 2 * border_width;
404 child_allocation.height = allocation->height - 2 * border_width;
406 gtk_widget_size_allocate (child, &child_allocation);
411 gtk_tool_item_create_menu_proxy (GtkToolItem *item)
413 if (!GTK_BIN (item)->child)
415 GtkWidget *menu_item = NULL;
417 menu_item = gtk_separator_menu_item_new();
419 gtk_tool_item_set_proxy_menu_item (item, MENU_ID, menu_item);
428 gtk_tool_item_new (void)
432 item = g_object_new (GTK_TYPE_TOOL_ITEM, NULL);
438 gtk_tool_item_get_icon_size (GtkToolItem *tool_item)
442 g_return_val_if_fail (GTK_IS_TOOL_ITEM (tool_item), GTK_ICON_SIZE_LARGE_TOOLBAR);
444 parent = GTK_WIDGET (tool_item)->parent;
445 if (!parent || !GTK_IS_TOOLBAR (parent))
446 return GTK_ICON_SIZE_LARGE_TOOLBAR;
448 return gtk_toolbar_get_icon_size (GTK_TOOLBAR (parent));
452 gtk_tool_item_get_orientation (GtkToolItem *tool_item)
456 g_return_val_if_fail (GTK_IS_TOOL_ITEM (tool_item), GTK_ORIENTATION_HORIZONTAL);
458 parent = GTK_WIDGET (tool_item)->parent;
459 if (!parent || !GTK_IS_TOOLBAR (parent))
460 return GTK_ORIENTATION_HORIZONTAL;
462 return gtk_toolbar_get_orientation (GTK_TOOLBAR (parent));
466 gtk_tool_item_get_toolbar_style (GtkToolItem *tool_item)
470 g_return_val_if_fail (GTK_IS_TOOL_ITEM (tool_item), GTK_TOOLBAR_ICONS);
472 parent = GTK_WIDGET (tool_item)->parent;
473 if (!parent || !GTK_IS_TOOLBAR (parent))
474 return GTK_TOOLBAR_ICONS;
476 return gtk_toolbar_get_style (GTK_TOOLBAR (parent));
480 gtk_tool_item_get_relief_style (GtkToolItem *tool_item)
484 g_return_val_if_fail (GTK_IS_TOOL_ITEM (tool_item), GTK_RELIEF_NONE);
486 parent = GTK_WIDGET (tool_item)->parent;
487 if (!parent || !GTK_IS_TOOLBAR (parent))
488 return GTK_RELIEF_NONE;
490 return gtk_toolbar_get_relief_style (GTK_TOOLBAR (parent));
494 gtk_tool_item_set_expand (GtkToolItem *tool_item,
497 g_return_if_fail (GTK_IS_TOOL_ITEM (tool_item));
499 expand = expand != FALSE;
501 if (tool_item->priv->expand != expand)
503 tool_item->priv->expand = expand;
504 gtk_widget_child_notify (GTK_WIDGET (tool_item), "expand");
505 gtk_widget_queue_resize (GTK_WIDGET (tool_item));
510 gtk_tool_item_get_expand (GtkToolItem *tool_item)
512 g_return_val_if_fail (GTK_IS_TOOL_ITEM (tool_item), FALSE);
514 return tool_item->priv->expand;
518 gtk_tool_item_set_pack_end (GtkToolItem *tool_item,
521 g_return_if_fail (GTK_IS_TOOL_ITEM (tool_item));
523 pack_end = pack_end != FALSE;
525 if (tool_item->priv->pack_end != pack_end)
527 tool_item->priv->pack_end = pack_end;
528 gtk_widget_child_notify (GTK_WIDGET (tool_item), "pack_end");
529 gtk_widget_queue_resize (GTK_WIDGET (tool_item));
534 gtk_tool_item_get_pack_end (GtkToolItem *tool_item)
536 g_return_val_if_fail (GTK_IS_TOOL_ITEM (tool_item), FALSE);
538 return tool_item->priv->pack_end;
542 gtk_tool_item_set_homogeneous (GtkToolItem *tool_item,
543 gboolean homogeneous)
545 g_return_if_fail (GTK_IS_TOOL_ITEM (tool_item));
547 homogeneous = homogeneous != FALSE;
549 if (tool_item->priv->homogeneous != homogeneous)
551 tool_item->priv->homogeneous = homogeneous;
552 gtk_widget_child_notify (GTK_WIDGET (tool_item), "homogeneous");
553 gtk_widget_queue_resize (GTK_WIDGET (tool_item));
558 gtk_tool_item_get_homogeneous (GtkToolItem *tool_item)
560 g_return_val_if_fail (GTK_IS_TOOL_ITEM (tool_item), FALSE);
562 return tool_item->priv->homogeneous;
566 gtk_tool_item_real_set_tooltip (GtkToolItem *tool_item,
567 GtkTooltips *tooltips,
568 const gchar *tip_text,
569 const gchar *tip_private)
571 GtkWidget *child = GTK_BIN (tool_item)->child;
576 gtk_tooltips_set_tip (tooltips, child, tip_text, tip_private);
582 gtk_tool_item_set_tooltip (GtkToolItem *tool_item,
583 GtkTooltips *tooltips,
584 const gchar *tip_text,
585 const gchar *tip_private)
589 g_return_if_fail (GTK_IS_TOOL_ITEM (tool_item));
591 g_signal_emit (tool_item, toolitem_signals[SET_TOOLTIP], 0,
592 tooltips, tip_text, tip_private, &retval);
596 gtk_tool_item_set_use_drag_window (GtkToolItem *toolitem,
597 gboolean use_drag_window)
599 g_return_if_fail (GTK_IS_TOOL_ITEM (toolitem));
601 use_drag_window = use_drag_window != FALSE;
603 if (toolitem->priv->use_drag_window != use_drag_window)
605 toolitem->priv->use_drag_window = use_drag_window;
609 if (!toolitem->priv->drag_window && GTK_WIDGET_REALIZED (toolitem))
611 create_drag_window(toolitem);
612 if (GTK_WIDGET_MAPPED (toolitem))
613 gdk_window_show (toolitem->priv->drag_window);
618 destroy_drag_window (toolitem);
624 gtk_tool_item_get_use_drag_window (GtkToolItem *toolitem)
626 g_return_val_if_fail (GTK_IS_TOOL_ITEM (toolitem), FALSE);
628 return toolitem->priv->use_drag_window;
632 gtk_tool_item_set_visible_horizontal (GtkToolItem *toolitem,
633 gboolean visible_horizontal)
635 g_return_if_fail (GTK_IS_TOOL_ITEM (toolitem));
637 visible_horizontal = visible_horizontal != FALSE;
639 if (toolitem->priv->visible_horizontal != visible_horizontal)
641 toolitem->priv->visible_horizontal = visible_horizontal;
643 g_object_notify (G_OBJECT (toolitem), "visible_horizontal");
645 gtk_widget_queue_resize (GTK_WIDGET (toolitem));
650 gtk_tool_item_get_visible_horizontal (GtkToolItem *toolitem)
652 g_return_val_if_fail (GTK_IS_TOOL_ITEM (toolitem), FALSE);
654 return toolitem->priv->visible_horizontal;
658 gtk_tool_item_set_visible_vertical (GtkToolItem *toolitem,
659 gboolean visible_vertical)
661 g_return_if_fail (GTK_IS_TOOL_ITEM (toolitem));
663 visible_vertical = visible_vertical != FALSE;
665 if (toolitem->priv->visible_vertical != visible_vertical)
667 toolitem->priv->visible_vertical = visible_vertical;
669 g_object_notify (G_OBJECT (toolitem), "visible_vertical");
671 gtk_widget_queue_resize (GTK_WIDGET (toolitem));
676 gtk_tool_item_get_visible_vertical (GtkToolItem *toolitem)
678 g_return_val_if_fail (GTK_IS_TOOL_ITEM (toolitem), FALSE);
680 return toolitem->priv->visible_vertical;
684 gtk_tool_item_retrieve_proxy_menu_item (GtkToolItem *tool_item)
688 g_return_val_if_fail (GTK_IS_TOOL_ITEM (tool_item), NULL);
690 g_signal_emit (tool_item, toolitem_signals[CREATE_MENU_PROXY], 0, &retval);
692 return tool_item->priv->menu_item;
696 gtk_tool_item_get_proxy_menu_item (GtkToolItem *tool_item,
697 const gchar *menu_item_id)
699 g_return_val_if_fail (GTK_IS_TOOL_ITEM (tool_item), NULL);
700 g_return_val_if_fail (menu_item_id != NULL, NULL);
702 if (tool_item->priv->menu_item_id && strcmp (tool_item->priv->menu_item_id, menu_item_id) == 0)
703 return tool_item->priv->menu_item;
709 gtk_tool_item_set_proxy_menu_item (GtkToolItem *tool_item,
710 const gchar *menu_item_id,
711 GtkWidget *menu_item)
713 g_return_if_fail (GTK_IS_TOOL_ITEM (tool_item));
714 g_return_if_fail (menu_item == NULL || GTK_IS_MENU_ITEM (menu_item));
715 g_return_if_fail (menu_item_id != NULL);
717 if (tool_item->priv->menu_item_id)
718 g_free (tool_item->priv->menu_item_id);
720 tool_item->priv->menu_item_id = g_strdup (menu_item_id);
722 if (tool_item->priv->menu_item != menu_item)
724 if (tool_item->priv->menu_item)
725 g_object_unref (G_OBJECT (tool_item->priv->menu_item));
729 g_object_ref (menu_item);
730 gtk_object_sink (GTK_OBJECT (menu_item));
733 tool_item->priv->menu_item = menu_item;
738 _gtk_tool_item_toolbar_reconfigured (GtkToolItem *tool_item)
740 g_return_if_fail (GTK_IS_TOOL_ITEM (tool_item));
742 g_signal_emit (tool_item, toolitem_signals[TOOLBAR_RECONFIGURED], 0);
744 gtk_widget_queue_resize (GTK_WIDGET (tool_item));