1 /* GTK - The GIMP Toolkit
3 * Copyright (C) 2003 Ricardo Fernandez Pascual
4 * Copyright (C) 2004 Paolo Borelli
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
23 #include "gtkmenutoolbutton.h"
25 #include "gtktogglebutton.h"
31 #include "gtkprivate.h"
35 #define GTK_MENU_TOOL_BUTTON_GET_PRIVATE(object)(G_TYPE_INSTANCE_GET_PRIVATE ((object), GTK_TYPE_MENU_TOOL_BUTTON, GtkMenuToolButtonPrivate))
37 struct _GtkMenuToolButtonPrivate
41 GtkWidget *arrow_button;
46 static void gtk_menu_tool_button_destroy (GtkObject *object);
48 static int menu_deactivate_cb (GtkMenuShell *menu_shell,
49 GtkMenuToolButton *button);
64 static gint signals[LAST_SIGNAL];
66 G_DEFINE_TYPE (GtkMenuToolButton, gtk_menu_tool_button, GTK_TYPE_TOOL_BUTTON)
69 gtk_menu_tool_button_set_tooltip (GtkToolItem *tool_item,
70 GtkTooltips *tooltips,
72 const char *tip_private)
74 GtkMenuToolButton *button;
76 g_return_val_if_fail (GTK_IS_MENU_TOOL_BUTTON (tool_item), FALSE);
78 button = GTK_MENU_TOOL_BUTTON (tool_item);
79 gtk_tooltips_set_tip (tooltips, button->priv->button, tip_text, tip_private);
85 gtk_menu_tool_button_construct_contents (GtkMenuToolButton *button)
87 GtkMenuToolButtonPrivate *priv = button->priv;
89 GtkOrientation orientation;
91 orientation = gtk_tool_item_get_orientation (GTK_TOOL_ITEM (button));
93 if (orientation == GTK_ORIENTATION_HORIZONTAL)
95 box = gtk_hbox_new (FALSE, 0);
96 gtk_arrow_set (GTK_ARROW (priv->arrow), GTK_ARROW_DOWN, GTK_SHADOW_NONE);
100 box = gtk_vbox_new (FALSE, 0);
101 gtk_arrow_set (GTK_ARROW (priv->arrow), GTK_ARROW_RIGHT, GTK_SHADOW_NONE);
104 if (priv->button && priv->button->parent)
106 g_object_ref (priv->button);
107 gtk_container_remove (GTK_CONTAINER (priv->button->parent),
109 gtk_container_add (GTK_CONTAINER (box), priv->button);
110 g_object_unref (priv->button);
113 if (priv->arrow_button && priv->arrow_button->parent)
115 g_object_ref (priv->arrow_button);
116 gtk_container_remove (GTK_CONTAINER (priv->arrow_button->parent),
118 gtk_box_pack_end (GTK_BOX (box), priv->arrow_button,
120 g_object_unref (priv->arrow_button);
125 /* Note: we are not destroying the button and the arrow_button
126 * here because they were removed from their container above
128 gtk_widget_destroy (priv->box);
133 gtk_container_add (GTK_CONTAINER (button), priv->box);
134 gtk_widget_show_all (priv->box);
136 gtk_button_set_relief (GTK_BUTTON (priv->arrow_button),
137 gtk_tool_item_get_relief_style (GTK_TOOL_ITEM (button)));
139 gtk_widget_queue_resize (GTK_WIDGET (button));
143 gtk_menu_tool_button_toolbar_reconfigured (GtkToolItem *toolitem)
145 gtk_menu_tool_button_construct_contents (GTK_MENU_TOOL_BUTTON (toolitem));
148 GTK_TOOL_ITEM_CLASS (gtk_menu_tool_button_parent_class)->toolbar_reconfigured (toolitem);
152 gtk_menu_tool_button_state_changed (GtkWidget *widget,
153 GtkStateType previous_state)
155 GtkMenuToolButton *button = GTK_MENU_TOOL_BUTTON (widget);
156 GtkMenuToolButtonPrivate *priv = button->priv;
158 if (!GTK_WIDGET_IS_SENSITIVE (widget) && priv->menu)
160 gtk_menu_shell_deactivate (GTK_MENU_SHELL (priv->menu));
165 gtk_menu_tool_button_set_property (GObject *object,
170 GtkMenuToolButton *button = GTK_MENU_TOOL_BUTTON (object);
175 gtk_menu_tool_button_set_menu (button, g_value_get_object (value));
179 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
185 gtk_menu_tool_button_get_property (GObject *object,
190 GtkMenuToolButton *button = GTK_MENU_TOOL_BUTTON (object);
195 g_value_set_object (value, button->priv->menu);
199 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
205 gtk_menu_tool_button_class_init (GtkMenuToolButtonClass *klass)
207 GObjectClass *object_class;
208 GtkObjectClass *gtk_object_class;
209 GtkWidgetClass *widget_class;
210 GtkToolItemClass *toolitem_class;
212 object_class = (GObjectClass *)klass;
213 gtk_object_class = (GtkObjectClass *)klass;
214 widget_class = (GtkWidgetClass *)klass;
215 toolitem_class = (GtkToolItemClass *)klass;
217 object_class->set_property = gtk_menu_tool_button_set_property;
218 object_class->get_property = gtk_menu_tool_button_get_property;
219 gtk_object_class->destroy = gtk_menu_tool_button_destroy;
220 widget_class->state_changed = gtk_menu_tool_button_state_changed;
221 toolitem_class->set_tooltip = gtk_menu_tool_button_set_tooltip;
222 toolitem_class->toolbar_reconfigured = gtk_menu_tool_button_toolbar_reconfigured;
225 g_signal_new (I_("show-menu"),
226 G_OBJECT_CLASS_TYPE (klass),
228 G_STRUCT_OFFSET (GtkMenuToolButtonClass, show_menu),
230 g_cclosure_marshal_VOID__VOID,
233 g_object_class_install_property (object_class,
235 g_param_spec_object ("menu",
237 P_("The dropdown menu"),
239 GTK_PARAM_READWRITE));
241 g_type_class_add_private (object_class, sizeof (GtkMenuToolButtonPrivate));
245 menu_position_func (GtkMenu *menu,
249 GtkMenuToolButton *button)
251 GtkMenuToolButtonPrivate *priv = button->priv;
252 GtkWidget *widget = GTK_WIDGET (button);
254 GtkRequisition menu_req;
255 GtkOrientation orientation;
256 GtkTextDirection direction;
257 GdkRectangle monitor;
261 gtk_widget_size_request (GTK_WIDGET (priv->menu), &menu_req);
263 orientation = gtk_tool_item_get_orientation (GTK_TOOL_ITEM (button));
264 direction = gtk_widget_get_direction (widget);
266 screen = gtk_widget_get_screen (GTK_WIDGET (menu));
267 monitor_num = gdk_screen_get_monitor_at_window (screen, widget->window);
270 gdk_screen_get_monitor_geometry (screen, monitor_num, &monitor);
272 if (orientation == GTK_ORIENTATION_HORIZONTAL)
274 gdk_window_get_origin (widget->window, x, y);
275 *x += widget->allocation.x;
276 *y += widget->allocation.y;
278 if (direction == GTK_TEXT_DIR_LTR)
279 *x += MAX (widget->allocation.width - menu_req.width, 0);
280 else if (menu_req.width > widget->allocation.width)
281 *x -= menu_req.width - widget->allocation.width;
283 if ((*y + priv->arrow_button->allocation.height + menu_req.height) <= monitor.y + monitor.height)
284 *y += priv->arrow_button->allocation.height;
285 else if ((*y - menu_req.height) >= monitor.y)
286 *y -= menu_req.height;
287 else if (monitor.y + monitor.height - (*y + priv->arrow_button->allocation.height) > *y)
288 *y += priv->arrow_button->allocation.height;
290 *y -= menu_req.height;
294 gdk_window_get_origin (GTK_BUTTON (priv->arrow_button)->event_window, x, y);
295 gtk_widget_size_request (priv->arrow_button, &req);
297 if (direction == GTK_TEXT_DIR_LTR)
298 *x += priv->arrow_button->allocation.width;
300 *x -= menu_req.width;
302 if (*y + menu_req.height > monitor.y + monitor.height &&
303 *y + priv->arrow_button->allocation.height - monitor.y > monitor.y + monitor.height - *y)
304 *y += priv->arrow_button->allocation.height - menu_req.height;
311 popup_menu_under_arrow (GtkMenuToolButton *button,
312 GdkEventButton *event)
314 GtkMenuToolButtonPrivate *priv = button->priv;
316 g_signal_emit (button, signals[SHOW_MENU], 0);
321 gtk_menu_popup (priv->menu, NULL, NULL,
322 (GtkMenuPositionFunc) menu_position_func,
324 event ? event->button : 0,
325 event ? event->time : gtk_get_current_event_time ());
329 arrow_button_toggled_cb (GtkToggleButton *togglebutton,
330 GtkMenuToolButton *button)
332 GtkMenuToolButtonPrivate *priv = button->priv;
337 if (gtk_toggle_button_get_active (togglebutton) &&
338 !GTK_WIDGET_VISIBLE (priv->menu))
340 /* we get here only when the menu is activated by a key
341 * press, so that we can select the first menu item */
342 popup_menu_under_arrow (button, NULL);
343 gtk_menu_shell_select_first (GTK_MENU_SHELL (priv->menu), FALSE);
348 arrow_button_button_press_event_cb (GtkWidget *widget,
349 GdkEventButton *event,
350 GtkMenuToolButton *button)
352 if (event->button == 1)
354 popup_menu_under_arrow (button, event);
355 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (widget), TRUE);
366 gtk_menu_tool_button_init (GtkMenuToolButton *button)
370 GtkWidget *arrow_button;
371 GtkWidget *real_button;
373 button->priv = GTK_MENU_TOOL_BUTTON_GET_PRIVATE (button);
375 gtk_tool_item_set_homogeneous (GTK_TOOL_ITEM (button), FALSE);
377 box = gtk_hbox_new (FALSE, 0);
379 real_button = GTK_BIN (button)->child;
380 g_object_ref (real_button);
381 gtk_container_remove (GTK_CONTAINER (button), real_button);
382 gtk_container_add (GTK_CONTAINER (box), real_button);
383 g_object_unref (real_button);
385 arrow_button = gtk_toggle_button_new ();
386 arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_NONE);
387 gtk_container_add (GTK_CONTAINER (arrow_button), arrow);
388 gtk_box_pack_end (GTK_BOX (box), arrow_button,
391 /* the arrow button is insentive until we set a menu */
392 gtk_widget_set_sensitive (arrow_button, FALSE);
394 gtk_widget_show_all (box);
396 gtk_container_add (GTK_CONTAINER (button), box);
398 button->priv->button = real_button;
399 button->priv->arrow = arrow;
400 button->priv->arrow_button = arrow_button;
401 button->priv->box = box;
403 g_signal_connect (arrow_button, "toggled",
404 G_CALLBACK (arrow_button_toggled_cb), button);
405 g_signal_connect (arrow_button, "button_press_event",
406 G_CALLBACK (arrow_button_button_press_event_cb), button);
410 gtk_menu_tool_button_destroy (GtkObject *object)
412 GtkMenuToolButton *button;
414 button = GTK_MENU_TOOL_BUTTON (object);
416 if (button->priv->menu)
418 g_signal_handlers_disconnect_by_func (button->priv->menu,
421 gtk_menu_detach (button->priv->menu);
423 g_signal_handlers_disconnect_by_func (button->priv->arrow_button,
424 arrow_button_toggled_cb,
426 g_signal_handlers_disconnect_by_func (button->priv->arrow_button,
427 arrow_button_button_press_event_cb,
431 if (GTK_OBJECT_CLASS (gtk_menu_tool_button_parent_class)->destroy)
432 (*GTK_OBJECT_CLASS (gtk_menu_tool_button_parent_class)->destroy) (object);
436 * gtk_menu_tool_button_new:
437 * @icon_widget: a widget that will be used as icon widget, or %NULL
438 * @label: a string that will be used as label, or %NULL
440 * Creates a new #GtkMenuToolButton using @icon_widget as icon and
443 * Return value: the new #GtkMenuToolButton
448 gtk_menu_tool_button_new (GtkWidget *icon_widget,
451 GtkMenuToolButton *button;
453 button = g_object_new (GTK_TYPE_MENU_TOOL_BUTTON, NULL);
456 gtk_tool_button_set_label (GTK_TOOL_BUTTON (button), label);
459 gtk_tool_button_set_icon_widget (GTK_TOOL_BUTTON (button), icon_widget);
461 return GTK_TOOL_ITEM (button);
465 * gtk_menu_tool_button_new_from_stock:
466 * @stock_id: the name of a stock item
468 * Creates a new #GtkMenuToolButton.
469 * The new #GtkMenuToolButton will contain an icon and label from
470 * the stock item indicated by @stock_id.
472 * Return value: the new #GtkMenuToolButton
477 gtk_menu_tool_button_new_from_stock (const gchar *stock_id)
479 GtkMenuToolButton *button;
481 g_return_val_if_fail (stock_id != NULL, NULL);
483 button = g_object_new (GTK_TYPE_MENU_TOOL_BUTTON,
484 "stock-id", stock_id,
487 return GTK_TOOL_ITEM (button);
490 /* Callback for the "deactivate" signal on the pop-up menu.
491 * This is used so that we unset the state of the toggle button
492 * when the pop-up menu disappears.
495 menu_deactivate_cb (GtkMenuShell *menu_shell,
496 GtkMenuToolButton *button)
498 GtkMenuToolButtonPrivate *priv = button->priv;
500 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (priv->arrow_button), FALSE);
506 menu_detacher (GtkWidget *widget,
509 GtkMenuToolButtonPrivate *priv = GTK_MENU_TOOL_BUTTON (widget)->priv;
511 g_return_if_fail (priv->menu == menu);
517 * gtk_menu_tool_button_set_menu:
518 * @button: a #GtkMenuToolButton
519 * @menu: the #GtkMenu associated with #GtkMenuToolButton
521 * Sets the #GtkMenu that is popped up when the user clicks on the arrow.
522 * If @menu is NULL, the arrow button becomes insensitive.
527 gtk_menu_tool_button_set_menu (GtkMenuToolButton *button,
530 GtkMenuToolButtonPrivate *priv;
532 g_return_if_fail (GTK_IS_MENU_TOOL_BUTTON (button));
533 g_return_if_fail (GTK_IS_MENU (menu) || menu == NULL);
537 if (priv->menu != GTK_MENU (menu))
539 if (priv->menu && GTK_WIDGET_VISIBLE (priv->menu))
540 gtk_menu_shell_deactivate (GTK_MENU_SHELL (priv->menu));
544 g_signal_handlers_disconnect_by_func (priv->menu,
547 gtk_menu_detach (priv->menu);
550 priv->menu = GTK_MENU (menu);
554 gtk_menu_attach_to_widget (priv->menu, GTK_WIDGET (button),
557 gtk_widget_set_sensitive (priv->arrow_button, TRUE);
559 g_signal_connect (priv->menu, "deactivate",
560 G_CALLBACK (menu_deactivate_cb), button);
563 gtk_widget_set_sensitive (priv->arrow_button, FALSE);
566 g_object_notify (G_OBJECT (button), "menu");
570 * gtk_menu_tool_button_get_menu:
571 * @button: a #GtkMenuToolButton
573 * Gets the #GtkMenu associated with #GtkMenuToolButton.
575 * Return value: the #GtkMenu associated with #GtkMenuToolButton
580 gtk_menu_tool_button_get_menu (GtkMenuToolButton *button)
582 g_return_val_if_fail (GTK_IS_MENU_TOOL_BUTTON (button), NULL);
584 return GTK_WIDGET (button->priv->menu);
588 * gtk_menu_tool_button_set_arrow_tooltip:
589 * @button: a #GtkMenuToolButton
590 * @tooltips: the #GtkTooltips object to be used
591 * @tip_text: text to be used as tooltip text for tool_item
592 * @tip_private: text to be used as private tooltip text
594 * Sets the #GtkTooltips object to be used for arrow button which
595 * pops up the menu. See gtk_tool_item_set_tooltip() for setting
596 * a tooltip on the whole #GtkMenuToolButton.
601 gtk_menu_tool_button_set_arrow_tooltip (GtkMenuToolButton *button,
602 GtkTooltips *tooltips,
603 const gchar *tip_text,
604 const gchar *tip_private)
606 g_return_if_fail (GTK_IS_MENU_TOOL_BUTTON (button));
608 gtk_tooltips_set_tip (tooltips, button->priv->arrow_button, tip_text, tip_private);
611 #define __GTK_MENU_TOOL_BUTTON_C__
612 #include "gtkaliasdef.c"