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_construct_contents (GtkMenuToolButton *button)
71 GtkMenuToolButtonPrivate *priv = button->priv;
73 GtkOrientation orientation;
75 orientation = gtk_tool_item_get_orientation (GTK_TOOL_ITEM (button));
77 if (orientation == GTK_ORIENTATION_HORIZONTAL)
79 box = gtk_hbox_new (FALSE, 0);
80 gtk_arrow_set (GTK_ARROW (priv->arrow), GTK_ARROW_DOWN, GTK_SHADOW_NONE);
84 box = gtk_vbox_new (FALSE, 0);
85 gtk_arrow_set (GTK_ARROW (priv->arrow), GTK_ARROW_RIGHT, GTK_SHADOW_NONE);
88 if (priv->button && priv->button->parent)
90 g_object_ref (priv->button);
91 gtk_container_remove (GTK_CONTAINER (priv->button->parent),
93 gtk_container_add (GTK_CONTAINER (box), priv->button);
94 g_object_unref (priv->button);
97 if (priv->arrow_button && priv->arrow_button->parent)
99 g_object_ref (priv->arrow_button);
100 gtk_container_remove (GTK_CONTAINER (priv->arrow_button->parent),
102 gtk_box_pack_end (GTK_BOX (box), priv->arrow_button,
104 g_object_unref (priv->arrow_button);
109 /* Note: we are not destroying the button and the arrow_button
110 * here because they were removed from their container above
112 gtk_widget_destroy (priv->box);
117 gtk_container_add (GTK_CONTAINER (button), priv->box);
118 gtk_widget_show_all (priv->box);
120 gtk_button_set_relief (GTK_BUTTON (priv->arrow_button),
121 gtk_tool_item_get_relief_style (GTK_TOOL_ITEM (button)));
123 gtk_widget_queue_resize (GTK_WIDGET (button));
127 gtk_menu_tool_button_toolbar_reconfigured (GtkToolItem *toolitem)
129 gtk_menu_tool_button_construct_contents (GTK_MENU_TOOL_BUTTON (toolitem));
132 GTK_TOOL_ITEM_CLASS (gtk_menu_tool_button_parent_class)->toolbar_reconfigured (toolitem);
136 gtk_menu_tool_button_state_changed (GtkWidget *widget,
137 GtkStateType previous_state)
139 GtkMenuToolButton *button = GTK_MENU_TOOL_BUTTON (widget);
140 GtkMenuToolButtonPrivate *priv = button->priv;
142 if (!GTK_WIDGET_IS_SENSITIVE (widget) && priv->menu)
144 gtk_menu_shell_deactivate (GTK_MENU_SHELL (priv->menu));
149 gtk_menu_tool_button_set_property (GObject *object,
154 GtkMenuToolButton *button = GTK_MENU_TOOL_BUTTON (object);
159 gtk_menu_tool_button_set_menu (button, g_value_get_object (value));
163 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
169 gtk_menu_tool_button_get_property (GObject *object,
174 GtkMenuToolButton *button = GTK_MENU_TOOL_BUTTON (object);
179 g_value_set_object (value, button->priv->menu);
183 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
189 gtk_menu_tool_button_class_init (GtkMenuToolButtonClass *klass)
191 GObjectClass *object_class;
192 GtkObjectClass *gtk_object_class;
193 GtkWidgetClass *widget_class;
194 GtkToolItemClass *toolitem_class;
196 object_class = (GObjectClass *)klass;
197 gtk_object_class = (GtkObjectClass *)klass;
198 widget_class = (GtkWidgetClass *)klass;
199 toolitem_class = (GtkToolItemClass *)klass;
201 object_class->set_property = gtk_menu_tool_button_set_property;
202 object_class->get_property = gtk_menu_tool_button_get_property;
203 gtk_object_class->destroy = gtk_menu_tool_button_destroy;
204 widget_class->state_changed = gtk_menu_tool_button_state_changed;
205 toolitem_class->toolbar_reconfigured = gtk_menu_tool_button_toolbar_reconfigured;
208 g_signal_new (I_("show-menu"),
209 G_OBJECT_CLASS_TYPE (klass),
211 G_STRUCT_OFFSET (GtkMenuToolButtonClass, show_menu),
213 g_cclosure_marshal_VOID__VOID,
216 g_object_class_install_property (object_class,
218 g_param_spec_object ("menu",
220 P_("The dropdown menu"),
222 GTK_PARAM_READWRITE));
224 g_type_class_add_private (object_class, sizeof (GtkMenuToolButtonPrivate));
228 menu_position_func (GtkMenu *menu,
232 GtkMenuToolButton *button)
234 GtkMenuToolButtonPrivate *priv = button->priv;
235 GtkWidget *widget = GTK_WIDGET (button);
237 GtkRequisition menu_req;
238 GtkOrientation orientation;
239 GtkTextDirection direction;
240 GdkRectangle monitor;
244 gtk_widget_size_request (GTK_WIDGET (priv->menu), &menu_req);
246 orientation = gtk_tool_item_get_orientation (GTK_TOOL_ITEM (button));
247 direction = gtk_widget_get_direction (widget);
249 screen = gtk_widget_get_screen (GTK_WIDGET (menu));
250 monitor_num = gdk_screen_get_monitor_at_window (screen, widget->window);
253 gdk_screen_get_monitor_geometry (screen, monitor_num, &monitor);
255 if (orientation == GTK_ORIENTATION_HORIZONTAL)
257 gdk_window_get_origin (widget->window, x, y);
258 *x += widget->allocation.x;
259 *y += widget->allocation.y;
261 if (direction == GTK_TEXT_DIR_LTR)
262 *x += MAX (widget->allocation.width - menu_req.width, 0);
263 else if (menu_req.width > widget->allocation.width)
264 *x -= menu_req.width - widget->allocation.width;
266 if ((*y + priv->arrow_button->allocation.height + menu_req.height) <= monitor.y + monitor.height)
267 *y += priv->arrow_button->allocation.height;
268 else if ((*y - menu_req.height) >= monitor.y)
269 *y -= menu_req.height;
270 else if (monitor.y + monitor.height - (*y + priv->arrow_button->allocation.height) > *y)
271 *y += priv->arrow_button->allocation.height;
273 *y -= menu_req.height;
277 gdk_window_get_origin (GTK_BUTTON (priv->arrow_button)->event_window, x, y);
278 gtk_widget_size_request (priv->arrow_button, &req);
280 if (direction == GTK_TEXT_DIR_LTR)
281 *x += priv->arrow_button->allocation.width;
283 *x -= menu_req.width;
285 if (*y + menu_req.height > monitor.y + monitor.height &&
286 *y + priv->arrow_button->allocation.height - monitor.y > monitor.y + monitor.height - *y)
287 *y += priv->arrow_button->allocation.height - menu_req.height;
294 popup_menu_under_arrow (GtkMenuToolButton *button,
295 GdkEventButton *event)
297 GtkMenuToolButtonPrivate *priv = button->priv;
299 g_signal_emit (button, signals[SHOW_MENU], 0);
304 gtk_menu_popup (priv->menu, NULL, NULL,
305 (GtkMenuPositionFunc) menu_position_func,
307 event ? event->button : 0,
308 event ? event->time : gtk_get_current_event_time ());
312 arrow_button_toggled_cb (GtkToggleButton *togglebutton,
313 GtkMenuToolButton *button)
315 GtkMenuToolButtonPrivate *priv = button->priv;
320 if (gtk_toggle_button_get_active (togglebutton) &&
321 !GTK_WIDGET_VISIBLE (priv->menu))
323 /* we get here only when the menu is activated by a key
324 * press, so that we can select the first menu item */
325 popup_menu_under_arrow (button, NULL);
326 gtk_menu_shell_select_first (GTK_MENU_SHELL (priv->menu), FALSE);
331 arrow_button_button_press_event_cb (GtkWidget *widget,
332 GdkEventButton *event,
333 GtkMenuToolButton *button)
335 if (event->button == 1)
337 popup_menu_under_arrow (button, event);
338 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (widget), TRUE);
349 gtk_menu_tool_button_init (GtkMenuToolButton *button)
353 GtkWidget *arrow_button;
354 GtkWidget *real_button;
356 button->priv = GTK_MENU_TOOL_BUTTON_GET_PRIVATE (button);
358 gtk_tool_item_set_homogeneous (GTK_TOOL_ITEM (button), FALSE);
360 box = gtk_hbox_new (FALSE, 0);
362 real_button = GTK_BIN (button)->child;
363 g_object_ref (real_button);
364 gtk_container_remove (GTK_CONTAINER (button), real_button);
365 gtk_container_add (GTK_CONTAINER (box), real_button);
366 g_object_unref (real_button);
368 arrow_button = gtk_toggle_button_new ();
369 arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_NONE);
370 gtk_container_add (GTK_CONTAINER (arrow_button), arrow);
371 gtk_box_pack_end (GTK_BOX (box), arrow_button,
374 /* the arrow button is insentive until we set a menu */
375 gtk_widget_set_sensitive (arrow_button, FALSE);
377 gtk_widget_show_all (box);
379 gtk_container_add (GTK_CONTAINER (button), box);
381 button->priv->button = real_button;
382 button->priv->arrow = arrow;
383 button->priv->arrow_button = arrow_button;
384 button->priv->box = box;
386 g_signal_connect (arrow_button, "toggled",
387 G_CALLBACK (arrow_button_toggled_cb), button);
388 g_signal_connect (arrow_button, "button_press_event",
389 G_CALLBACK (arrow_button_button_press_event_cb), button);
393 gtk_menu_tool_button_destroy (GtkObject *object)
395 GtkMenuToolButton *button;
397 button = GTK_MENU_TOOL_BUTTON (object);
399 if (button->priv->menu)
401 g_signal_handlers_disconnect_by_func (button->priv->menu,
404 gtk_menu_detach (button->priv->menu);
406 g_signal_handlers_disconnect_by_func (button->priv->arrow_button,
407 arrow_button_toggled_cb,
409 g_signal_handlers_disconnect_by_func (button->priv->arrow_button,
410 arrow_button_button_press_event_cb,
414 if (GTK_OBJECT_CLASS (gtk_menu_tool_button_parent_class)->destroy)
415 (*GTK_OBJECT_CLASS (gtk_menu_tool_button_parent_class)->destroy) (object);
419 * gtk_menu_tool_button_new:
420 * @icon_widget: a widget that will be used as icon widget, or %NULL
421 * @label: a string that will be used as label, or %NULL
423 * Creates a new #GtkMenuToolButton using @icon_widget as icon and
426 * Return value: the new #GtkMenuToolButton
431 gtk_menu_tool_button_new (GtkWidget *icon_widget,
434 GtkMenuToolButton *button;
436 button = g_object_new (GTK_TYPE_MENU_TOOL_BUTTON, NULL);
439 gtk_tool_button_set_label (GTK_TOOL_BUTTON (button), label);
442 gtk_tool_button_set_icon_widget (GTK_TOOL_BUTTON (button), icon_widget);
444 return GTK_TOOL_ITEM (button);
448 * gtk_menu_tool_button_new_from_stock:
449 * @stock_id: the name of a stock item
451 * Creates a new #GtkMenuToolButton.
452 * The new #GtkMenuToolButton will contain an icon and label from
453 * the stock item indicated by @stock_id.
455 * Return value: the new #GtkMenuToolButton
460 gtk_menu_tool_button_new_from_stock (const gchar *stock_id)
462 GtkMenuToolButton *button;
464 g_return_val_if_fail (stock_id != NULL, NULL);
466 button = g_object_new (GTK_TYPE_MENU_TOOL_BUTTON,
467 "stock-id", stock_id,
470 return GTK_TOOL_ITEM (button);
473 /* Callback for the "deactivate" signal on the pop-up menu.
474 * This is used so that we unset the state of the toggle button
475 * when the pop-up menu disappears.
478 menu_deactivate_cb (GtkMenuShell *menu_shell,
479 GtkMenuToolButton *button)
481 GtkMenuToolButtonPrivate *priv = button->priv;
483 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (priv->arrow_button), FALSE);
489 menu_detacher (GtkWidget *widget,
492 GtkMenuToolButtonPrivate *priv = GTK_MENU_TOOL_BUTTON (widget)->priv;
494 g_return_if_fail (priv->menu == menu);
500 * gtk_menu_tool_button_set_menu:
501 * @button: a #GtkMenuToolButton
502 * @menu: the #GtkMenu associated with #GtkMenuToolButton
504 * Sets the #GtkMenu that is popped up when the user clicks on the arrow.
505 * If @menu is NULL, the arrow button becomes insensitive.
510 gtk_menu_tool_button_set_menu (GtkMenuToolButton *button,
513 GtkMenuToolButtonPrivate *priv;
515 g_return_if_fail (GTK_IS_MENU_TOOL_BUTTON (button));
516 g_return_if_fail (GTK_IS_MENU (menu) || menu == NULL);
520 if (priv->menu != GTK_MENU (menu))
522 if (priv->menu && GTK_WIDGET_VISIBLE (priv->menu))
523 gtk_menu_shell_deactivate (GTK_MENU_SHELL (priv->menu));
527 g_signal_handlers_disconnect_by_func (priv->menu,
530 gtk_menu_detach (priv->menu);
533 priv->menu = GTK_MENU (menu);
537 gtk_menu_attach_to_widget (priv->menu, GTK_WIDGET (button),
540 gtk_widget_set_sensitive (priv->arrow_button, TRUE);
542 g_signal_connect (priv->menu, "deactivate",
543 G_CALLBACK (menu_deactivate_cb), button);
546 gtk_widget_set_sensitive (priv->arrow_button, FALSE);
549 g_object_notify (G_OBJECT (button), "menu");
553 * gtk_menu_tool_button_get_menu:
554 * @button: a #GtkMenuToolButton
556 * Gets the #GtkMenu associated with #GtkMenuToolButton.
558 * Return value: the #GtkMenu associated with #GtkMenuToolButton
563 gtk_menu_tool_button_get_menu (GtkMenuToolButton *button)
565 g_return_val_if_fail (GTK_IS_MENU_TOOL_BUTTON (button), NULL);
567 return GTK_WIDGET (button->priv->menu);
571 * gtk_menu_tool_button_set_arrow_tooltip:
572 * @button: a #GtkMenuToolButton
573 * @tooltips: the #GtkTooltips object to be used
574 * @tip_text: text to be used as tooltip text for tool_item
575 * @tip_private: text to be used as private tooltip text
577 * Sets the #GtkTooltips object to be used for arrow button which
578 * pops up the menu. See gtk_tool_item_set_tooltip() for setting
579 * a tooltip on the whole #GtkMenuToolButton.
583 * Deprecated: 2.12: Use gtk_menu_tool_button_set_arrow_tooltip_text()
587 gtk_menu_tool_button_set_arrow_tooltip (GtkMenuToolButton *button,
588 GtkTooltips *tooltips,
589 const gchar *tip_text,
590 const gchar *tip_private)
592 g_return_if_fail (GTK_IS_MENU_TOOL_BUTTON (button));
594 gtk_tooltips_set_tip (tooltips, button->priv->arrow_button, tip_text, tip_private);
598 * gtk_menu_tool_button_set_arrow_tooltip_text:
599 * @button: a #GtkMenuToolButton
600 * @text: text to be used as tooltip text for button's arrow button
602 * Sets the tooltip text to be used as tooltip for the arrow button which
603 * pops up the menu. See gtk_tool_item_set_tooltip() for setting a tooltip
604 * on the whole #GtkMenuToolButton.
609 gtk_menu_tool_button_set_arrow_tooltip_text (GtkMenuToolButton *button,
612 g_return_if_fail (GTK_IS_MENU_TOOL_BUTTON (button));
614 gtk_widget_set_tooltip_text (button->priv->arrow_button, text);
618 * gtk_menu_tool_button_set_arrow_tooltip_markup:
619 * @button: a #GtkMenuToolButton
620 * @markup: markup text to be used as tooltip text for button's arrow button
622 * Sets the tooltip markup text to be used as tooltip for the arrow button
623 * which pops up the menu. See gtk_tool_item_set_tooltip() for setting a
624 * tooltip on the whole #GtkMenuToolButton.
629 gtk_menu_tool_button_set_arrow_tooltip_markup (GtkMenuToolButton *button,
632 g_return_if_fail (GTK_IS_MENU_TOOL_BUTTON (button));
634 gtk_widget_set_tooltip_markup (button->priv->arrow_button, markup);
637 #define __GTK_MENU_TOOL_BUTTON_C__
638 #include "gtkaliasdef.c"