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 /* FIXME: enable this when bug 116921 is fixed */
195 g_type_class_add_private (object_class, sizeof (GtkToolItemPrivate));
200 gtk_tool_item_init (GtkToolItem *toolitem)
202 GTK_WIDGET_UNSET_FLAGS (toolitem, GTK_CAN_FOCUS);
204 /* FIXME: enable this when bug 116921 is fixed */
206 toolitem->priv = GTK_TOOL_ITEM_GET_PRIVATE (toolitem);
208 toolitem->priv = g_new0 (GtkToolItemPrivate, 1);
210 toolitem->priv->visible_horizontal = TRUE;
211 toolitem->priv->visible_vertical = TRUE;
212 toolitem->priv->homogeneous = FALSE;
213 toolitem->priv->expand = FALSE;
217 gtk_tool_item_finalize (GObject *object)
219 GtkToolItem *item = GTK_TOOL_ITEM (object);
221 if (item->priv->menu_item)
222 g_object_unref (item->priv->menu_item);
224 if (G_OBJECT_CLASS (parent_class)->finalize)
225 G_OBJECT_CLASS (parent_class)->finalize (object);
229 gtk_tool_item_parent_set (GtkWidget *toolitem,
230 GtkWidget *prev_parent)
232 gtk_tool_item_toolbar_reconfigured (GTK_TOOL_ITEM (toolitem));
236 gtk_tool_item_set_property (GObject *object,
241 GtkToolItem *toolitem = GTK_TOOL_ITEM (object);
245 case PROP_VISIBLE_HORIZONTAL:
246 gtk_tool_item_set_visible_horizontal (toolitem, g_value_get_boolean (value));
248 case PROP_VISIBLE_VERTICAL:
249 gtk_tool_item_set_visible_horizontal (toolitem, g_value_get_boolean (value));
252 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
257 gtk_tool_item_get_property (GObject *object,
262 GtkToolItem *toolitem = GTK_TOOL_ITEM (object);
266 case PROP_VISIBLE_HORIZONTAL:
267 g_value_set_boolean (value, toolitem->priv->visible_horizontal);
269 case PROP_VISIBLE_VERTICAL:
270 g_value_set_boolean (value, toolitem->priv->visible_vertical);
273 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
278 create_drag_window (GtkToolItem *toolitem)
281 GdkWindowAttr attributes;
282 gint attributes_mask, border_width;
284 g_return_if_fail (toolitem->priv->use_drag_window == TRUE);
286 widget = GTK_WIDGET (toolitem);
287 border_width = GTK_CONTAINER (toolitem)->border_width;
289 attributes.window_type = GDK_WINDOW_CHILD;
290 attributes.x = widget->allocation.x + border_width;
291 attributes.y = widget->allocation.y + border_width;
292 attributes.width = widget->allocation.width - border_width * 2;
293 attributes.height = widget->allocation.height - border_width * 2;
294 attributes.wclass = GDK_INPUT_ONLY;
295 attributes.event_mask = gtk_widget_get_events (widget);
296 attributes.event_mask |= (GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK);
298 attributes_mask = GDK_WA_X | GDK_WA_Y;
300 toolitem->priv->drag_window = gdk_window_new (gtk_widget_get_parent_window (widget),
301 &attributes, attributes_mask);
302 gdk_window_set_user_data (toolitem->priv->drag_window, toolitem);
306 gtk_tool_item_realize (GtkWidget *widget)
308 GtkToolItem *toolitem;
310 toolitem = GTK_TOOL_ITEM (widget);
311 GTK_WIDGET_SET_FLAGS (widget, GTK_REALIZED);
313 widget->window = gtk_widget_get_parent_window (widget);
314 g_object_ref (widget->window);
316 if (toolitem->priv->use_drag_window)
317 create_drag_window(toolitem);
319 widget->style = gtk_style_attach (widget->style, widget->window);
323 destroy_drag_window (GtkToolItem *toolitem)
325 if (toolitem->priv->drag_window)
327 gdk_window_set_user_data (toolitem->priv->drag_window, NULL);
328 gdk_window_destroy (toolitem->priv->drag_window);
329 toolitem->priv->drag_window = NULL;
334 gtk_tool_item_unrealize (GtkWidget *widget)
336 GtkToolItem *toolitem;
338 toolitem = GTK_TOOL_ITEM (widget);
340 destroy_drag_window (toolitem);
342 GTK_WIDGET_CLASS (parent_class)->unrealize (widget);
346 gtk_tool_item_map (GtkWidget *widget)
348 GtkToolItem *toolitem;
350 toolitem = GTK_TOOL_ITEM (widget);
351 GTK_WIDGET_CLASS (parent_class)->map (widget);
352 if (toolitem->priv->drag_window)
353 gdk_window_show (toolitem->priv->drag_window);
357 gtk_tool_item_unmap (GtkWidget *widget)
359 GtkToolItem *toolitem;
361 toolitem = GTK_TOOL_ITEM (widget);
362 if (toolitem->priv->drag_window)
363 gdk_window_hide (toolitem->priv->drag_window);
364 GTK_WIDGET_CLASS (parent_class)->unmap (widget);
368 gtk_tool_item_size_request (GtkWidget *widget,
369 GtkRequisition *requisition)
371 GtkWidget *child = GTK_BIN (widget)->child;
372 gint xthickness = widget->style->xthickness;
373 gint ythickness = widget->style->ythickness;
375 if (child && GTK_WIDGET_VISIBLE (child))
377 gtk_widget_size_request (child, requisition);
381 requisition->height = 0;
382 requisition->width = 0;
385 requisition->width += (xthickness + GTK_CONTAINER (widget)->border_width) * 2;
386 requisition->height += (ythickness + GTK_CONTAINER (widget)->border_width) * 2;
390 gtk_tool_item_size_allocate (GtkWidget *widget,
391 GtkAllocation *allocation)
393 GtkToolItem *toolitem = GTK_TOOL_ITEM (widget);
394 GtkAllocation child_allocation;
396 GtkWidget *child = GTK_BIN (widget)->child;
398 widget->allocation = *allocation;
399 border_width = GTK_CONTAINER (widget)->border_width;
401 if (toolitem->priv->drag_window)
402 gdk_window_move_resize (toolitem->priv->drag_window,
403 widget->allocation.x + border_width,
404 widget->allocation.y + border_width,
405 widget->allocation.width - border_width * 2,
406 widget->allocation.height - border_width * 2);
408 if (child && GTK_WIDGET_VISIBLE (child))
410 gint xthickness = widget->style->xthickness;
411 gint ythickness = widget->style->ythickness;
413 child_allocation.x = allocation->x + border_width + xthickness;
414 child_allocation.y = allocation->y + border_width + ythickness;
415 child_allocation.width = allocation->width - 2 * (xthickness + border_width);
416 child_allocation.height = allocation->height - 2 * (ythickness + border_width);
418 gtk_widget_size_allocate (child, &child_allocation);
423 gtk_tool_item_create_menu_proxy (GtkToolItem *item)
425 if (!GTK_BIN (item)->child)
427 GtkWidget *menu_item = NULL;
429 menu_item = gtk_separator_menu_item_new();
431 gtk_tool_item_set_proxy_menu_item (item, MENU_ID, menu_item);
440 gtk_tool_item_new (void)
444 item = g_object_new (GTK_TYPE_TOOL_ITEM, NULL);
450 gtk_tool_item_get_icon_size (GtkToolItem *tool_item)
454 g_return_val_if_fail (GTK_IS_TOOL_ITEM (tool_item), GTK_ICON_SIZE_LARGE_TOOLBAR);
456 parent = GTK_WIDGET (tool_item)->parent;
457 if (!parent || !GTK_IS_TOOLBAR (parent))
458 return GTK_ICON_SIZE_LARGE_TOOLBAR;
460 return gtk_toolbar_get_icon_size (GTK_TOOLBAR (parent));
464 gtk_tool_item_get_orientation (GtkToolItem *tool_item)
468 g_return_val_if_fail (GTK_IS_TOOL_ITEM (tool_item), GTK_ORIENTATION_HORIZONTAL);
470 parent = GTK_WIDGET (tool_item)->parent;
471 if (!parent || !GTK_IS_TOOLBAR (parent))
472 return GTK_ORIENTATION_HORIZONTAL;
474 return gtk_toolbar_get_orientation (GTK_TOOLBAR (parent));
478 gtk_tool_item_get_toolbar_style (GtkToolItem *tool_item)
482 g_return_val_if_fail (GTK_IS_TOOL_ITEM (tool_item), GTK_TOOLBAR_ICONS);
484 parent = GTK_WIDGET (tool_item)->parent;
485 if (!parent || !GTK_IS_TOOLBAR (parent))
486 return GTK_TOOLBAR_ICONS;
488 return gtk_toolbar_get_style (GTK_TOOLBAR (parent));
492 gtk_tool_item_get_relief_style (GtkToolItem *tool_item)
496 g_return_val_if_fail (GTK_IS_TOOL_ITEM (tool_item), GTK_RELIEF_NONE);
498 parent = GTK_WIDGET (tool_item)->parent;
499 if (!parent || !GTK_IS_TOOLBAR (parent))
500 return GTK_RELIEF_NONE;
502 return gtk_toolbar_get_relief_style (GTK_TOOLBAR (parent));
506 gtk_tool_item_toolbar_reconfigured (GtkToolItem *tool_item)
508 g_return_if_fail (GTK_IS_TOOL_ITEM (tool_item));
510 g_signal_emit (tool_item, toolitem_signals[TOOLBAR_RECONFIGURED], 0);
512 gtk_widget_queue_resize (GTK_WIDGET (tool_item));
516 gtk_tool_item_set_expand (GtkToolItem *tool_item,
519 g_return_if_fail (GTK_IS_TOOL_ITEM (tool_item));
521 expand = expand != FALSE;
523 if (tool_item->priv->expand != expand)
525 tool_item->priv->expand = expand;
526 gtk_widget_child_notify (GTK_WIDGET (tool_item), "expand");
527 gtk_widget_queue_resize (GTK_WIDGET (tool_item));
532 gtk_tool_item_get_expand (GtkToolItem *tool_item)
534 g_return_val_if_fail (GTK_IS_TOOL_ITEM (tool_item), FALSE);
536 return tool_item->priv->expand;
540 gtk_tool_item_set_pack_end (GtkToolItem *tool_item,
543 g_return_if_fail (GTK_IS_TOOL_ITEM (tool_item));
545 pack_end = pack_end != FALSE;
547 if (tool_item->priv->pack_end != pack_end)
549 tool_item->priv->pack_end = pack_end;
550 gtk_widget_child_notify (GTK_WIDGET (tool_item), "pack_end");
551 gtk_widget_queue_resize (GTK_WIDGET (tool_item));
556 gtk_tool_item_get_pack_end (GtkToolItem *tool_item)
558 g_return_val_if_fail (GTK_IS_TOOL_ITEM (tool_item), FALSE);
560 return tool_item->priv->pack_end;
564 gtk_tool_item_set_homogeneous (GtkToolItem *tool_item,
565 gboolean homogeneous)
567 g_return_if_fail (GTK_IS_TOOL_ITEM (tool_item));
569 homogeneous = homogeneous != FALSE;
571 if (tool_item->priv->homogeneous != homogeneous)
573 tool_item->priv->homogeneous = homogeneous;
574 gtk_widget_child_notify (GTK_WIDGET (tool_item), "homogeneous");
575 gtk_widget_queue_resize (GTK_WIDGET (tool_item));
580 gtk_tool_item_get_homogeneous (GtkToolItem *tool_item)
582 g_return_val_if_fail (GTK_IS_TOOL_ITEM (tool_item), FALSE);
584 return tool_item->priv->homogeneous;
588 gtk_tool_item_real_set_tooltip (GtkToolItem *tool_item,
589 GtkTooltips *tooltips,
590 const gchar *tip_text,
591 const gchar *tip_private)
593 GtkWidget *child = GTK_BIN (tool_item)->child;
598 gtk_tooltips_set_tip (tooltips, child, tip_text, tip_private);
604 gtk_tool_item_set_tooltip (GtkToolItem *tool_item,
605 GtkTooltips *tooltips,
606 const gchar *tip_text,
607 const gchar *tip_private)
611 g_return_if_fail (GTK_IS_TOOL_ITEM (tool_item));
613 g_signal_emit (tool_item, toolitem_signals[SET_TOOLTIP], 0,
614 tooltips, tip_text, tip_private, &retval);
618 gtk_tool_item_set_use_drag_window (GtkToolItem *toolitem,
619 gboolean use_drag_window)
621 g_return_if_fail (GTK_IS_TOOL_ITEM (toolitem));
623 use_drag_window = use_drag_window != FALSE;
625 if (toolitem->priv->use_drag_window != use_drag_window)
627 toolitem->priv->use_drag_window = use_drag_window;
631 if (!toolitem->priv->drag_window && GTK_WIDGET_REALIZED (toolitem))
633 create_drag_window(toolitem);
634 if (GTK_WIDGET_MAPPED (toolitem))
635 gdk_window_show (toolitem->priv->drag_window);
640 destroy_drag_window (toolitem);
646 gtk_tool_item_get_use_drag_window (GtkToolItem *toolitem)
648 g_return_val_if_fail (GTK_IS_TOOL_ITEM (toolitem), FALSE);
650 return toolitem->priv->use_drag_window;
654 gtk_tool_item_set_visible_horizontal (GtkToolItem *toolitem,
655 gboolean visible_horizontal)
657 g_return_if_fail (GTK_IS_TOOL_ITEM (toolitem));
659 visible_horizontal = visible_horizontal != FALSE;
661 if (toolitem->priv->visible_horizontal != visible_horizontal)
663 toolitem->priv->visible_horizontal = visible_horizontal;
665 g_object_notify (G_OBJECT (toolitem), "visible_horizontal");
667 gtk_widget_queue_resize (GTK_WIDGET (toolitem));
672 gtk_tool_item_get_visible_horizontal (GtkToolItem *toolitem)
674 g_return_val_if_fail (GTK_IS_TOOL_ITEM (toolitem), FALSE);
676 return toolitem->priv->visible_horizontal;
680 gtk_tool_item_set_visible_vertical (GtkToolItem *toolitem,
681 gboolean visible_vertical)
683 g_return_if_fail (GTK_IS_TOOL_ITEM (toolitem));
685 visible_vertical = visible_vertical != FALSE;
687 if (toolitem->priv->visible_vertical != visible_vertical)
689 toolitem->priv->visible_vertical = visible_vertical;
691 g_object_notify (G_OBJECT (toolitem), "visible_vertical");
693 gtk_widget_queue_resize (GTK_WIDGET (toolitem));
698 gtk_tool_item_get_visible_vertical (GtkToolItem *toolitem)
700 g_return_val_if_fail (GTK_IS_TOOL_ITEM (toolitem), FALSE);
702 return toolitem->priv->visible_vertical;
706 gtk_tool_item_retrieve_proxy_menu_item (GtkToolItem *tool_item)
710 g_return_val_if_fail (GTK_IS_TOOL_ITEM (tool_item), NULL);
712 g_signal_emit (tool_item, toolitem_signals[CREATE_MENU_PROXY], 0, &retval);
714 return tool_item->priv->menu_item;
718 gtk_tool_item_get_proxy_menu_item (GtkToolItem *tool_item,
719 const gchar *menu_item_id)
721 g_return_val_if_fail (GTK_IS_TOOL_ITEM (tool_item), NULL);
722 g_return_val_if_fail (menu_item_id != NULL, NULL);
724 if (tool_item->priv->menu_item_id && strcmp (tool_item->priv->menu_item_id, menu_item_id) == 0)
725 return tool_item->priv->menu_item;
731 gtk_tool_item_set_proxy_menu_item (GtkToolItem *tool_item,
732 const gchar *menu_item_id,
733 GtkWidget *menu_item)
735 g_return_if_fail (GTK_IS_TOOL_ITEM (tool_item));
736 g_return_if_fail (menu_item == NULL || GTK_IS_MENU_ITEM (menu_item));
737 g_return_if_fail (menu_item_id != NULL);
739 if (tool_item->priv->menu_item_id)
740 g_free (tool_item->priv->menu_item_id);
742 tool_item->priv->menu_item_id = g_strdup (menu_item_id);
744 if (tool_item->priv->menu_item != menu_item)
746 if (tool_item->priv->menu_item)
747 g_object_unref (G_OBJECT (tool_item->priv->menu_item));
751 g_object_ref (menu_item);
752 gtk_object_sink (GTK_OBJECT (menu_item));
755 tool_item->priv->menu_item = menu_item;
760 _gtk_tool_item_get_drag_window (GtkToolItem *tool_item)
762 return tool_item->priv->drag_window;