1 /* GTK - The GIMP Toolkit
3 * Copyright (C) 2003 Ricardo Fernandez Pascual
4 * Copyright (C) 2004 Paolo Borelli
5 * Copyright (C) 2012 Bastien Nocera
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, see <http://www.gnu.org/licenses/>.
22 * SECTION:gtkmenubutton
23 * @short_description: A widget that shows a menu when clicked on
24 * @title: GtkMenuButton
26 * The #GtkMenuButton widget is used to display a menu when clicked on.
27 * This menu can be provided either as a #GtkMenu, or an abstract #GMenuModel.
29 * The #GtkMenuButton widget can hold any valid child widget. That is, it
30 * can hold almost any other standard #GtkWidget. The most commonly used
31 * child is the provided #GtkArrow.
33 * The positioning of the menu is determined by the #GtkMenuButton:direction
34 * property of the menu button and the #GtkWidget:halign or #GtkWidget:valign
35 * properties of the menu. For example, when the direction is %GTK_ARROW_DOWN
36 * and the horizontal alignment is %GTK_ALIGN_START, the menu will be
37 * positioned below the button, with the starting edge (depending on the
38 * text direction) of the menu aligned with the starting edge of the button.
39 * If there is not enough space below the button, the menu is popped up above
40 * the button instead. If the alignment would move part of the menu offscreen,
48 * <entry>halign = start</entry>
49 * <entry>halign = center</entry>
50 * <entry>halign = end</entry>
53 * <entry>direction = down</entry>
56 * <imageobject><imagedata fileref="down-start.png" format="PNG"/></imageobject>
57 * </inlinemediaobject>
61 * <imageobject><imagedata fileref="down-center.png" format="PNG"/></imageobject>
62 * </inlinemediaobject>
66 * <imageobject><imagedata fileref="down-end.png" format="PNG"/></imageobject>
67 * </inlinemediaobject>
71 * <entry>direction = up</entry>
74 * <imageobject><imagedata fileref="up-start.png" format="PNG"/></imageobject>
75 * </inlinemediaobject>
79 * <imageobject><imagedata fileref="up-center.png" format="PNG"/></imageobject>
80 * </inlinemediaobject>
84 * <imageobject><imagedata fileref="up-end.png" format="PNG"/></imageobject>
85 * </inlinemediaobject>
96 * <entry>direction = left</entry>
97 * <entry>direction = right</entry>
100 * <entry>valign = start</entry>
102 * <inlinemediaobject>
103 * <imageobject><imagedata fileref="left-start.png" format="PNG"/></imageobject>
104 * </inlinemediaobject>
107 * <inlinemediaobject>
108 * <imageobject><imagedata fileref="right-start.png" format="PNG"/></imageobject>
109 * </inlinemediaobject>
113 * <entry>valign = center</entry>
115 * <inlinemediaobject>
116 * <imageobject><imagedata fileref="left-center.png" format="PNG"/></imageobject>
117 * </inlinemediaobject>
120 * <inlinemediaobject>
121 * <imageobject><imagedata fileref="right-center.png" format="PNG"/></imageobject>
122 * </inlinemediaobject>
126 * <entry>valign = end</entry>
128 * <inlinemediaobject>
129 * <imageobject><imagedata fileref="left-end.png" format="PNG"/></imageobject>
130 * </inlinemediaobject>
133 * <inlinemediaobject>
134 * <imageobject><imagedata fileref="right-end.png" format="PNG"/></imageobject>
135 * </inlinemediaobject>
145 #include "gtkmenubutton.h"
146 #include "gtkmenubuttonprivate.h"
147 #include "gtkarrow.h"
149 #include "gtkprivate.h"
152 struct _GtkMenuButtonPrivate
157 GtkMenuButtonShowMenuCallback func;
160 GtkArrowType arrow_type;
161 GtkWidget *align_widget;
162 gpointer arrow_widget;
174 G_DEFINE_TYPE(GtkMenuButton, gtk_menu_button, GTK_TYPE_TOGGLE_BUTTON)
176 static void gtk_menu_button_dispose (GObject *object);
179 gtk_menu_button_set_property (GObject *object,
184 GtkMenuButton *self = GTK_MENU_BUTTON (object);
189 gtk_menu_button_set_popup (self, g_value_get_object (value));
192 gtk_menu_button_set_menu_model (self, g_value_get_object (value));
194 case PROP_ALIGN_WIDGET:
195 gtk_menu_button_set_align_widget (self, g_value_get_object (value));
198 gtk_menu_button_set_direction (self, g_value_get_enum (value));
201 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
206 gtk_menu_button_get_property (GObject *object,
211 GtkMenuButtonPrivate *priv = GTK_MENU_BUTTON (object)->priv;
216 g_value_set_object (value, priv->popup);
219 g_value_set_object (value, priv->model);
221 case PROP_ALIGN_WIDGET:
222 g_value_set_object (value, priv->align_widget);
225 g_value_set_enum (value, priv->arrow_type);
228 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
233 gtk_menu_button_state_flags_changed (GtkWidget *widget,
234 GtkStateFlags previous_state_flags)
236 GtkMenuButton *button = GTK_MENU_BUTTON (widget);
237 GtkMenuButtonPrivate *priv = button->priv;
239 if (!gtk_widget_is_sensitive (widget) && priv->popup)
240 gtk_menu_shell_deactivate (GTK_MENU_SHELL (priv->popup));
244 menu_position_up_down_func (GtkMenu *menu,
248 GtkMenuButton *menu_button)
250 GtkMenuButtonPrivate *priv = menu_button->priv;
251 GtkWidget *widget = GTK_WIDGET (menu_button);
252 GtkRequisition menu_req;
253 GtkTextDirection direction;
254 GdkRectangle monitor;
258 GtkAllocation allocation, arrow_allocation;
261 gtk_widget_get_preferred_size (GTK_WIDGET (priv->popup),
264 align = gtk_widget_get_halign (GTK_WIDGET (priv->popup));
265 direction = gtk_widget_get_direction (widget);
266 window = gtk_widget_get_window (priv->align_widget ? priv->align_widget : widget);
268 screen = gtk_widget_get_screen (GTK_WIDGET (menu));
269 monitor_num = gdk_screen_get_monitor_at_window (screen, window);
272 gdk_screen_get_monitor_workarea (screen, monitor_num, &monitor);
274 gtk_widget_get_allocation (priv->align_widget ? priv->align_widget : widget, &allocation);
275 gtk_widget_get_allocation (widget, &arrow_allocation);
277 gdk_window_get_origin (window, x, y);
281 /* treat the default align value like START */
282 if (align == GTK_ALIGN_FILL)
283 align = GTK_ALIGN_START;
285 if (align == GTK_ALIGN_CENTER)
286 *x -= (menu_req.width - allocation.width) / 2;
287 else if ((align == GTK_ALIGN_START && direction == GTK_TEXT_DIR_LTR) ||
288 (align == GTK_ALIGN_END && direction == GTK_TEXT_DIR_RTL))
289 *x += MAX (allocation.width - menu_req.width, 0);
290 else if (menu_req.width > allocation.width)
291 *x -= menu_req.width - allocation.width;
293 if (priv->arrow_type == GTK_ARROW_UP && *y - menu_req.height >= monitor.y)
295 *y -= menu_req.height;
299 if ((*y + arrow_allocation.height + menu_req.height) <= monitor.y + monitor.height)
300 *y += arrow_allocation.height;
301 else if ((*y - menu_req.height) >= monitor.y)
302 *y -= menu_req.height;
303 else if (monitor.y + monitor.height - (*y + arrow_allocation.height) > *y)
304 *y += arrow_allocation.height;
306 *y -= menu_req.height;
313 menu_position_side_func (GtkMenu *menu,
317 GtkMenuButton *menu_button)
319 GtkMenuButtonPrivate *priv = menu_button->priv;
320 GtkAllocation allocation;
321 GtkWidget *widget = GTK_WIDGET (menu_button);
322 GtkRequisition menu_req;
323 GdkRectangle monitor;
329 gtk_widget_get_preferred_size (GTK_WIDGET (priv->popup),
332 window = gtk_widget_get_window (widget);
334 align = gtk_widget_get_valign (GTK_WIDGET (menu));
335 screen = gtk_widget_get_screen (GTK_WIDGET (menu));
336 monitor_num = gdk_screen_get_monitor_at_window (screen, window);
339 gdk_screen_get_monitor_workarea (screen, monitor_num, &monitor);
341 gdk_window_get_origin (gtk_button_get_event_window (GTK_BUTTON (menu_button)), x, y);
343 gtk_widget_get_allocation (widget, &allocation);
345 if (priv->arrow_type == GTK_ARROW_RIGHT)
347 if (*x + allocation.width + menu_req.width <= monitor.x + monitor.width)
348 *x += allocation.width;
350 *x -= menu_req.width;
354 if (*x - menu_req.width >= monitor.x)
355 *x -= menu_req.width;
357 *x += allocation.width;
360 /* treat the default align value like START */
361 if (align == GTK_ALIGN_FILL)
362 align = GTK_ALIGN_START;
364 if (align == GTK_ALIGN_CENTER)
365 *y -= (menu_req.height - allocation.height) / 2;
366 else if (align == GTK_ALIGN_END)
367 *y -= menu_req.height - allocation.height;
373 popup_menu (GtkMenuButton *menu_button,
374 GdkEventButton *event)
376 GtkMenuButtonPrivate *priv = menu_button->priv;
377 GtkMenuPositionFunc func;
380 priv->func (priv->user_data);
385 switch (priv->arrow_type)
388 case GTK_ARROW_RIGHT:
389 func = (GtkMenuPositionFunc) menu_position_side_func;
392 func = (GtkMenuPositionFunc) menu_position_up_down_func;
396 gtk_menu_popup_for_device (GTK_MENU (priv->popup),
397 event ? event->device : NULL,
400 GTK_WIDGET (menu_button),
402 event ? event->button : 0,
403 event ? event->time : gtk_get_current_event_time ());
407 gtk_menu_button_toggled (GtkToggleButton *button)
409 GtkMenuButton *menu_button = GTK_MENU_BUTTON (button);
410 GtkMenuButtonPrivate *priv = menu_button->priv;
415 if (gtk_toggle_button_get_active (button) &&
416 !gtk_widget_get_visible (GTK_WIDGET (priv->popup)))
418 /* we get here only when the menu is activated by a key
419 * press, so that we can select the first menu item
421 popup_menu (menu_button, NULL);
422 gtk_menu_shell_select_first (GTK_MENU_SHELL (priv->popup), FALSE);
427 gtk_menu_button_button_press_event (GtkWidget *widget,
428 GdkEventButton *event)
430 if (event->button == GDK_BUTTON_PRIMARY)
432 popup_menu (GTK_MENU_BUTTON (widget), event);
433 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (widget), TRUE);
438 return GTK_WIDGET_CLASS (gtk_menu_button_parent_class)->button_press_event (widget, event);
442 gtk_menu_button_class_init (GtkMenuButtonClass *klass)
444 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
445 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
446 GtkToggleButtonClass *toggle_button_class = GTK_TOGGLE_BUTTON_CLASS (klass);
448 g_type_class_add_private (klass, sizeof (GtkMenuButtonPrivate));
450 gobject_class->set_property = gtk_menu_button_set_property;
451 gobject_class->get_property = gtk_menu_button_get_property;
452 gobject_class->dispose = gtk_menu_button_dispose;
454 widget_class->state_flags_changed = gtk_menu_button_state_flags_changed;
455 widget_class->button_press_event = gtk_menu_button_button_press_event;
457 toggle_button_class->toggled = gtk_menu_button_toggled;
460 * GtkMenuButton:popup:
462 * The #GtkMenu that will be popped up when the button is clicked.
466 g_object_class_install_property (gobject_class,
468 g_param_spec_object ("popup",
470 P_("The dropdown menu."),
474 * GtkMenuButton:menu:
476 * The #GtkMenu that will be popped up when the button is clicked.
477 * This property has been renamed to "popup". "menu" will be
478 * removed before 3.6.0.
482 g_object_class_install_property (gobject_class,
483 PROP_POPUP, /* [sic] */
484 g_param_spec_object ("menu",
486 P_("The dropdown menu."),
488 G_PARAM_DEPRECATED | G_PARAM_READWRITE));
490 * GtkMenuButton:menu-model:
492 * The #GMenuModel from which the menu to pop up will be created.
493 * See gtk_menu_button_set_menu_model() for the interaction with the
494 * #GtkMenuButton:menu property.
498 g_object_class_install_property (gobject_class,
500 g_param_spec_object ("menu-model",
502 P_("The dropdown menu's model."),
506 * GtkMenuButton:align-widget:
508 * The #GtkWidget to use to align the popup menu with.
512 g_object_class_install_property (gobject_class,
514 g_param_spec_object ("align-widget",
516 P_("The parent widget which the menu should align with."),
520 * GtkMenuButton:direction:
522 * The #GtkArrowType representing the direction in which the
523 * menu will be popped out.
527 g_object_class_install_property (gobject_class,
529 g_param_spec_enum ("direction",
531 P_("The direction the arrow should point."),
538 add_arrow (GtkMenuButton *menu_button)
542 arrow = gtk_arrow_new (menu_button->priv->arrow_type, GTK_SHADOW_NONE);
543 gtk_container_add (GTK_CONTAINER (menu_button), arrow);
544 gtk_widget_show (arrow);
545 menu_button->priv->arrow_widget = arrow;
549 gtk_menu_button_init (GtkMenuButton *menu_button)
551 GtkMenuButtonPrivate *priv;
553 priv = G_TYPE_INSTANCE_GET_PRIVATE (menu_button, GTK_TYPE_MENU_BUTTON, GtkMenuButtonPrivate);
554 menu_button->priv = priv;
555 priv->arrow_type = GTK_ARROW_DOWN;
557 add_arrow (menu_button);
559 gtk_widget_set_sensitive (GTK_WIDGET (menu_button), FALSE);
563 * gtk_menu_button_new:
565 * Creates a new #GtkMenuButton widget with downwards-pointing
566 * arrow as the only child. You can replace the child widget
567 * with another #GtkWidget should you wish to.
569 * Returns: The newly created #GtkMenuButton widget.
574 gtk_menu_button_new (void)
576 return g_object_new (GTK_TYPE_MENU_BUTTON, NULL);
579 /* Callback for the "deactivate" signal on the pop-up menu.
580 * This is used so that we unset the state of the toggle button
581 * when the pop-up menu disappears.
584 menu_deactivate_cb (GtkMenuShell *menu_shell,
585 GtkMenuButton *menu_button)
587 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (menu_button), FALSE);
593 menu_detacher (GtkWidget *widget,
596 GtkMenuButtonPrivate *priv = GTK_MENU_BUTTON (widget)->priv;
598 g_return_if_fail (priv->popup == (GtkWidget *) menu);
603 /* This function is used in GtkMenuToolButton, the call back will
604 * be called when GtkMenuToolButton would have emitted the "show-menu"
608 _gtk_menu_button_set_popup_with_func (GtkMenuButton *menu_button,
610 GtkMenuButtonShowMenuCallback func,
613 GtkMenuButtonPrivate *priv;
615 g_return_if_fail (GTK_IS_MENU_BUTTON (menu_button));
616 g_return_if_fail (GTK_IS_MENU (menu) || menu == NULL);
618 priv = menu_button->priv;
620 priv->user_data = user_data;
622 if (priv->popup == GTK_WIDGET (menu))
627 if (gtk_widget_get_visible (GTK_WIDGET (priv->popup)))
628 gtk_menu_shell_deactivate (GTK_MENU_SHELL (priv->popup));
633 g_signal_handlers_disconnect_by_func (priv->popup,
636 gtk_menu_detach (GTK_MENU (priv->popup));
643 gtk_menu_attach_to_widget (GTK_MENU (priv->popup), GTK_WIDGET (menu_button),
646 gtk_widget_set_sensitive (GTK_WIDGET (menu_button), TRUE);
648 g_signal_connect (priv->popup, "deactivate",
649 G_CALLBACK (menu_deactivate_cb), menu_button);
653 gtk_widget_set_sensitive (GTK_WIDGET (menu_button), FALSE);
656 g_object_notify (G_OBJECT (menu_button), "menu");
657 g_object_notify (G_OBJECT (menu_button), "menu-model");
661 * gtk_menu_button_set_popup:
662 * @menu_button: a #GtkMenuButton
663 * @popup: (allow-none): a #GtkMenu
665 * Sets the #GtkMenu that will be popped up when the button is clicked,
666 * or %NULL to disable the button. If #GtkMenuButton:menu-model is set,
667 * it will be set to %NULL.
672 gtk_menu_button_set_popup (GtkMenuButton *menu_button,
675 GtkMenuButtonPrivate *priv;
677 g_return_if_fail (GTK_IS_MENU_BUTTON (menu_button));
678 g_return_if_fail (GTK_IS_MENU (popup) || popup == NULL);
680 priv = menu_button->priv;
681 g_clear_object (&priv->model);
683 _gtk_menu_button_set_popup_with_func (menu_button, popup, NULL, NULL);
687 * gtk_menu_button_get_popup:
688 * @menu_button: a #GtkMenuButton
690 * Returns the #GtkMenu that pops out of the button.
692 * Returns: (transfer none): a #GtkMenu or %NULL.
697 gtk_menu_button_get_popup (GtkMenuButton *menu_button)
699 g_return_val_if_fail (GTK_IS_MENU_BUTTON (menu_button), NULL);
701 return GTK_MENU (menu_button->priv->popup);
705 gtk_menu_button_set_menu (GtkMenuButton *menu_button,
708 gtk_menu_button_set_popup (menu_button, menu);
712 gtk_menu_button_get_menu (GtkMenuButton *menu_button)
714 return gtk_menu_button_get_popup (menu_button);
718 * gtk_menu_button_set_menu_model:
719 * @menu_button: a #GtkMenuButton
720 * @menu_model: (allow-none): a #GMenuModel
722 * Sets the #GMenuModel from which the #GtkMenuButton:menu property will be
723 * filled in, or %NULL to disable the button.
725 * The #GtkMenu will be created with gtk_menu_new_from_model(), so actions
726 * will be connected as documented there.
728 * If you #GtkMenuButton:menu * is already set, then its content will be lost
729 * and replaced by our newly created #GtkMenu.
734 gtk_menu_button_set_menu_model (GtkMenuButton *menu_button,
735 GMenuModel *menu_model)
737 GtkMenuButtonPrivate *priv;
740 g_return_if_fail (GTK_IS_MENU_BUTTON (menu_button));
741 g_return_if_fail (G_IS_MENU_MODEL (menu_model) || menu_model == NULL);
743 priv = menu_button->priv;
744 g_clear_object (&priv->model);
746 if (menu_model == NULL)
748 gtk_menu_button_set_popup (menu_button, NULL);
752 priv->model = g_object_ref (menu_model);
753 menu = gtk_menu_new_from_model (menu_model);
754 gtk_widget_show_all (menu);
755 gtk_menu_button_set_popup (menu_button, menu);
759 * gtk_menu_button_get_menu_model:
760 * @menu_button: a #GtkMenuButton
762 * Returns the #GMenuModel used to generate the menu.
764 * Returns: (transfer none): a #GMenuModel or %NULL.
769 gtk_menu_button_get_menu_model (GtkMenuButton *menu_button)
771 g_return_val_if_fail (GTK_IS_MENU_BUTTON (menu_button), NULL);
773 return menu_button->priv->model;
777 * gtk_menu_button_set_align_widget:
778 * @menu_button: a #GtkMenuButton
779 * @align_widget: (allow-none): a #GtkWidget
781 * Sets the #GtkWidget to use to line the menu with when popped up. Note that
782 * the @align_widget must contain the #GtkMenuButton itself.
784 * Setting it to %NULL means that the popup menu will be aligned with the
790 gtk_menu_button_set_align_widget (GtkMenuButton *menu_button,
791 GtkWidget *align_widget)
793 GtkMenuButtonPrivate *priv;
795 g_return_if_fail (GTK_IS_MENU_BUTTON (menu_button));
796 g_return_if_fail (align_widget == NULL || gtk_widget_is_ancestor (GTK_WIDGET (menu_button), align_widget));
798 priv = menu_button->priv;
799 if (priv->align_widget == align_widget)
802 priv->align_widget = align_widget;
804 if (priv->align_widget)
805 g_object_add_weak_pointer (G_OBJECT (priv->align_widget), (gpointer *) &priv->align_widget);
807 g_object_notify (G_OBJECT (menu_button), "align-widget");
811 * gtk_menu_button_get_align_widget:
812 * @menu_button: a #GtkMenuButton
814 * Returns the parent #GtkWidget to use to line up with menu.
816 * Returns: (transfer none): a #GtkWidget value or %NULL.
821 gtk_menu_button_get_align_widget (GtkMenuButton *menu_button)
823 g_return_val_if_fail (GTK_IS_MENU_BUTTON (menu_button), NULL);
825 return menu_button->priv->align_widget;
829 * gtk_menu_button_set_direction:
830 * @menu_button: a #GtkMenuButton
831 * @direction: a #GtkArrowType
833 * Sets the direction in which the menu will be popped up, as
834 * well as changing the arrow's direction. The child will not
835 * be changed to an arrow if it was customized.
837 * If the menu when popped out would have collided with screen edges,
838 * we will do our best to keep it inside the screen and fully visible.
840 * If you pass GTK_ARROW_NONE for a @direction, the menu will behave
841 * as if you passed GTK_ARROW_DOWN (although you won't see any arrows).
846 gtk_menu_button_set_direction (GtkMenuButton *menu_button,
847 GtkArrowType direction)
849 GtkMenuButtonPrivate *priv = menu_button->priv;
852 g_return_if_fail (GTK_IS_MENU_BUTTON (menu_button));
854 if (priv->arrow_type == direction)
857 priv->arrow_type = direction;
859 /* Is it custom content? We don't change that */
860 child = gtk_bin_get_child (GTK_BIN (menu_button));
861 if (priv->arrow_widget != child)
864 gtk_arrow_set (GTK_ARROW (child), priv->arrow_type, GTK_SHADOW_NONE);
868 * gtk_menu_button_get_direction:
869 * @menu_button: a #GtkMenuButton
871 * Returns the direction the menu will be pointing at when popped up.
873 * Returns: a #GtkArrowType value.
878 gtk_menu_button_get_direction (GtkMenuButton *menu_button)
880 g_return_val_if_fail (GTK_IS_MENU_BUTTON (menu_button), GTK_ARROW_DOWN);
882 return menu_button->priv->arrow_type;
886 gtk_menu_button_dispose (GObject *object)
888 GtkMenuButtonPrivate *priv = GTK_MENU_BUTTON (object)->priv;
892 g_signal_handlers_disconnect_by_func (priv->popup,
895 gtk_menu_detach (GTK_MENU (priv->popup));
898 g_clear_object (&priv->model);
900 G_OBJECT_CLASS (gtk_menu_button_parent_class)->dispose (object);