/* GTK - The GIMP Toolkit * * Copyright (C) 2003 Ricardo Fernandez Pascual * Copyright (C) 2004 Paolo Borelli * Copyright (C) 2012 Bastien Nocera * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library. If not, see . */ /** * SECTION:gtkmenubutton * @short_description: A widget that shows a popup when clicked on * @title: GtkMenuButton * * The #GtkMenuButton widget is used to display a popup when clicked on. * This popup can be provided either as a #GtkMenu, a #GtkPopover or an * abstract #GMenuModel. * * The #GtkMenuButton widget can show either an icon (set with the * #GtkMenuButton:icon-name property) or a label (set with the * #GtkMenuButton:label property). If neither is explicitly set, * a #GtkImage is automatically created, using an arrow image oriented * according to #GtkMenuButton:direction or the generic “open-menu-symbolic” * icon if the direction is not set. * * The positioning of the popup is determined by the #GtkMenuButton:direction * property of the menu button. * * For menus, the #GtkWidget:halign and #GtkWidget:valign properties of the * menu are also taken into account. For example, when the direction is * %GTK_ARROW_DOWN and the horizontal alignment is %GTK_ALIGN_START, the * menu will be positioned below the button, with the starting edge * (depending on the text direction) of the menu aligned with the starting * edge of the button. If there is not enough space below the button, the * menu is popped up above the button instead. If the alignment would move * part of the menu offscreen, it is “pushed in”. * * ## Direction = Down * * - halign = start * * ![](down-start.png) * * - halign = center * * ![](down-center.png) * * - halign = end * * ![](down-end.png) * * ## Direction = Up * * - halign = start * * ![](up-start.png) * * - halign = center * * ![](up-center.png) * * - halign = end * * ![](up-end.png) * * ## Direction = Left * * - valign = start * * ![](left-start.png) * * - valign = center * * ![](left-center.png) * * - valign = end * * ![](left-end.png) * * ## Direction = Right * * - valign = start * * ![](right-start.png) * * - valign = center * * ![](right-center.png) * * - valign = end * * ![](right-end.png) * * # CSS nodes * * GtkMenuButton has a single CSS node with name button. To differentiate * it from a plain #GtkButton, it gets the .popup style class. */ #include "config.h" #include "gtkaccessible.h" #include "gtkactionable.h" #include "gtkimage.h" #include "gtkintl.h" #include "gtkmain.h" #include "gtkmenubutton.h" #include "gtkmenubuttonprivate.h" #include "gtkpopover.h" #include "gtkpopovermenu.h" #include "gtkprivate.h" #include "gtkstylecontext.h" #include "gtktypebuiltins.h" #include "gtklabel.h" #include "gtkbox.h" #include "gtkwidgetprivate.h" #include "gtkbuttonprivate.h" #include "gtknative.h" #include "a11y/gtkmenubuttonaccessible.h" typedef struct _GtkMenuButtonClass GtkMenuButtonClass; typedef struct _GtkMenuButtonPrivate GtkMenuButtonPrivate; struct _GtkMenuButton { GtkWidget parent_instance; }; struct _GtkMenuButtonClass { GtkWidgetClass parent_class; }; struct _GtkMenuButtonPrivate { GtkWidget *button; GtkWidget *menu; /* The menu and the popover are mutually exclusive */ GtkWidget *popover; /* Only one at a time can be set */ GMenuModel *model; GtkMenuButtonCreatePopupFunc create_popup_func; gpointer create_popup_user_data; GDestroyNotify create_popup_destroy_notify; GtkWidget *align_widget; GtkWidget *arrow_widget; GtkArrowType arrow_type; guint use_popover : 1; }; enum { PROP_0, PROP_POPUP, PROP_MENU_MODEL, PROP_ALIGN_WIDGET, PROP_DIRECTION, PROP_USE_POPOVER, PROP_POPOVER, PROP_ICON_NAME, PROP_LABEL, PROP_RELIEF, LAST_PROP }; static GParamSpec *menu_button_props[LAST_PROP]; G_DEFINE_TYPE_WITH_PRIVATE (GtkMenuButton, gtk_menu_button, GTK_TYPE_WIDGET) static void gtk_menu_button_dispose (GObject *object); static void gtk_menu_button_set_property (GObject *object, guint property_id, const GValue *value, GParamSpec *pspec) { GtkMenuButton *self = GTK_MENU_BUTTON (object); switch (property_id) { case PROP_POPUP: gtk_menu_button_set_popup (self, g_value_get_object (value)); break; case PROP_MENU_MODEL: gtk_menu_button_set_menu_model (self, g_value_get_object (value)); break; case PROP_ALIGN_WIDGET: gtk_menu_button_set_align_widget (self, g_value_get_object (value)); break; case PROP_DIRECTION: gtk_menu_button_set_direction (self, g_value_get_enum (value)); break; case PROP_USE_POPOVER: gtk_menu_button_set_use_popover (self, g_value_get_boolean (value)); break; case PROP_POPOVER: gtk_menu_button_set_popover (self, g_value_get_object (value)); break; case PROP_ICON_NAME: gtk_menu_button_set_icon_name (self, g_value_get_string (value)); break; case PROP_LABEL: gtk_menu_button_set_label (self, g_value_get_string (value)); break; case PROP_RELIEF: gtk_menu_button_set_relief (self, g_value_get_enum (value)); break; default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec); } } static void gtk_menu_button_get_property (GObject *object, guint property_id, GValue *value, GParamSpec *pspec) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (GTK_MENU_BUTTON (object)); switch (property_id) { case PROP_POPUP: g_value_set_object (value, priv->menu); break; case PROP_MENU_MODEL: g_value_set_object (value, priv->model); break; case PROP_ALIGN_WIDGET: g_value_set_object (value, priv->align_widget); break; case PROP_DIRECTION: g_value_set_enum (value, priv->arrow_type); break; case PROP_USE_POPOVER: g_value_set_boolean (value, priv->use_popover); break; case PROP_POPOVER: g_value_set_object (value, priv->popover); break; case PROP_ICON_NAME: g_value_set_string (value, gtk_menu_button_get_icon_name (GTK_MENU_BUTTON (object))); break; case PROP_LABEL: g_value_set_string (value, gtk_menu_button_get_label (GTK_MENU_BUTTON (object))); break; case PROP_RELIEF: g_value_set_enum (value, gtk_menu_button_get_relief (GTK_MENU_BUTTON (object))); break; default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec); } } static void gtk_menu_button_state_flags_changed (GtkWidget *widget, GtkStateFlags previous_state_flags) { GtkMenuButton *button = GTK_MENU_BUTTON (widget); GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (button); if (!gtk_widget_is_sensitive (widget)) { if (priv->menu) gtk_menu_shell_deactivate (GTK_MENU_SHELL (priv->menu)); else if (priv->popover) gtk_widget_hide (priv->popover); } } static void popup_menu (GtkMenuButton *menu_button, GdkEvent *event) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); GdkGravity widget_anchor = GDK_GRAVITY_SOUTH_WEST; GdkGravity menu_anchor = GDK_GRAVITY_NORTH_WEST; if (!priv->menu) return; switch (priv->arrow_type) { case GTK_ARROW_UP: g_object_set (priv->menu, "anchor-hints", (GDK_ANCHOR_FLIP_Y | GDK_ANCHOR_SLIDE | GDK_ANCHOR_RESIZE), NULL); switch (gtk_widget_get_halign (priv->menu)) { default: case GTK_ALIGN_FILL: case GTK_ALIGN_START: case GTK_ALIGN_BASELINE: widget_anchor = GDK_GRAVITY_NORTH_WEST; menu_anchor = GDK_GRAVITY_SOUTH_WEST; break; case GTK_ALIGN_END: widget_anchor = GDK_GRAVITY_NORTH_EAST; menu_anchor = GDK_GRAVITY_SOUTH_EAST; break; case GTK_ALIGN_CENTER: widget_anchor = GDK_GRAVITY_NORTH; menu_anchor = GDK_GRAVITY_SOUTH; break; } break; case GTK_ARROW_DOWN: /* In the common case the menu button is showing a dropdown menu, set the * corresponding type hint on the toplevel, so the WM can omit the top side * of the shadows. */ g_object_set (priv->menu, "anchor-hints", (GDK_ANCHOR_FLIP_Y | GDK_ANCHOR_SLIDE | GDK_ANCHOR_RESIZE), "menu-type-hint", GDK_SURFACE_TYPE_HINT_DROPDOWN_MENU, NULL); switch (gtk_widget_get_halign (priv->menu)) { default: case GTK_ALIGN_FILL: case GTK_ALIGN_START: case GTK_ALIGN_BASELINE: widget_anchor = GDK_GRAVITY_SOUTH_WEST; menu_anchor = GDK_GRAVITY_NORTH_WEST; break; case GTK_ALIGN_END: widget_anchor = GDK_GRAVITY_SOUTH_EAST; menu_anchor = GDK_GRAVITY_NORTH_EAST; break; case GTK_ALIGN_CENTER: widget_anchor = GDK_GRAVITY_SOUTH; menu_anchor = GDK_GRAVITY_NORTH; break; } break; case GTK_ARROW_LEFT: g_object_set (priv->menu, "anchor-hints", (GDK_ANCHOR_FLIP_X | GDK_ANCHOR_SLIDE | GDK_ANCHOR_RESIZE), NULL); switch (gtk_widget_get_valign (priv->menu)) { default: case GTK_ALIGN_FILL: case GTK_ALIGN_START: case GTK_ALIGN_BASELINE: widget_anchor = GDK_GRAVITY_NORTH_WEST; menu_anchor = GDK_GRAVITY_NORTH_EAST; break; case GTK_ALIGN_END: widget_anchor = GDK_GRAVITY_SOUTH_WEST; menu_anchor = GDK_GRAVITY_SOUTH_EAST; break; case GTK_ALIGN_CENTER: widget_anchor = GDK_GRAVITY_WEST; menu_anchor = GDK_GRAVITY_EAST; break; } break; case GTK_ARROW_RIGHT: g_object_set (priv->menu, "anchor-hints", (GDK_ANCHOR_FLIP_X | GDK_ANCHOR_SLIDE | GDK_ANCHOR_RESIZE), NULL); switch (gtk_widget_get_valign (priv->menu)) { default: case GTK_ALIGN_FILL: case GTK_ALIGN_START: case GTK_ALIGN_BASELINE: widget_anchor = GDK_GRAVITY_NORTH_EAST; menu_anchor = GDK_GRAVITY_NORTH_WEST; break; case GTK_ALIGN_END: widget_anchor = GDK_GRAVITY_SOUTH_EAST; menu_anchor = GDK_GRAVITY_SOUTH_WEST; break; case GTK_ALIGN_CENTER: widget_anchor = GDK_GRAVITY_EAST; menu_anchor = GDK_GRAVITY_WEST; break; } break; case GTK_ARROW_NONE: g_object_set (priv->menu, "anchor-hints", (GDK_ANCHOR_FLIP_Y | GDK_ANCHOR_SLIDE | GDK_ANCHOR_RESIZE), NULL); break; default: break; } gtk_menu_popup_at_widget (GTK_MENU (priv->menu), GTK_WIDGET (menu_button), widget_anchor, menu_anchor, event); } static void gtk_menu_button_toggled (GtkMenuButton *menu_button) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); const gboolean active = gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (priv->button)); /* Might set a new menu/popover */ if (active && priv->create_popup_func) { priv->create_popup_func (menu_button, priv->create_popup_user_data); } if (priv->menu) { if (active && !gtk_widget_get_visible (priv->menu)) { GdkEvent *event; event = gtk_get_current_event (); popup_menu (menu_button, event); if (!event || gdk_event_get_event_type (event) == GDK_KEY_PRESS || gdk_event_get_event_type (event) == GDK_KEY_RELEASE) gtk_menu_shell_select_first (GTK_MENU_SHELL (priv->menu), FALSE); if (event) g_object_unref (event); } } else if (priv->popover) { if (active) gtk_popover_popup (GTK_POPOVER (priv->popover)); else gtk_popover_popdown (GTK_POPOVER (priv->popover)); } } static void gtk_menu_button_measure (GtkWidget *widget, GtkOrientation orientation, int for_size, int *minimum, int *natural, int *minimum_baseline, int *natural_baseline) { GtkMenuButton *menu_button = GTK_MENU_BUTTON (widget); GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); gtk_widget_measure (priv->button, orientation, for_size, minimum, natural, minimum_baseline, natural_baseline); } static void gtk_menu_button_size_allocate (GtkWidget *widget, int width, int height, int baseline) { GtkMenuButton *button = GTK_MENU_BUTTON (widget); GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (button); gtk_widget_size_allocate (priv->button, &(GtkAllocation) { 0, 0, width, height }, baseline); if (priv->popover) gtk_native_check_resize (GTK_NATIVE (priv->popover)); } static gboolean gtk_menu_button_focus (GtkWidget *widget, GtkDirectionType direction) { GtkMenuButton *button = GTK_MENU_BUTTON (widget); GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (button); if (priv->menu && gtk_widget_get_visible (priv->menu)) return gtk_widget_child_focus (priv->menu, direction); else if (priv->popover && gtk_widget_get_visible (priv->popover)) return gtk_widget_child_focus (priv->popover, direction); else return GTK_WIDGET_CLASS (gtk_menu_button_parent_class)->focus (widget, direction); } static void gtk_menu_button_class_init (GtkMenuButtonClass *klass) { GObjectClass *gobject_class = G_OBJECT_CLASS (klass); GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass); gobject_class->set_property = gtk_menu_button_set_property; gobject_class->get_property = gtk_menu_button_get_property; gobject_class->dispose = gtk_menu_button_dispose; widget_class->measure = gtk_menu_button_measure; widget_class->size_allocate = gtk_menu_button_size_allocate; widget_class->state_flags_changed = gtk_menu_button_state_flags_changed; widget_class->focus = gtk_menu_button_focus; /** * GtkMenuButton:popup: * * The #GtkMenu that will be popped up when the button is clicked. */ menu_button_props[PROP_POPUP] = g_param_spec_object ("popup", P_("Popup"), P_("The dropdown menu."), GTK_TYPE_MENU, GTK_PARAM_READWRITE); /** * GtkMenuButton:menu-model: * * The #GMenuModel from which the popup will be created. * Depending on the #GtkMenuButton:use-popover property, that may * be a menu or a popover. * * See gtk_menu_button_set_menu_model() for the interaction with the * #GtkMenuButton:popup property. */ menu_button_props[PROP_MENU_MODEL] = g_param_spec_object ("menu-model", P_("Menu model"), P_("The model from which the popup is made."), G_TYPE_MENU_MODEL, GTK_PARAM_READWRITE); /** * GtkMenuButton:align-widget: * * The #GtkWidget to use to align the menu with. */ menu_button_props[PROP_ALIGN_WIDGET] = g_param_spec_object ("align-widget", P_("Align with"), P_("The parent widget which the menu should align with."), GTK_TYPE_CONTAINER, GTK_PARAM_READWRITE); /** * GtkMenuButton:direction: * * The #GtkArrowType representing the direction in which the * menu or popover will be popped out. */ menu_button_props[PROP_DIRECTION] = g_param_spec_enum ("direction", P_("Direction"), P_("The direction the arrow should point."), GTK_TYPE_ARROW_TYPE, GTK_ARROW_DOWN, GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY); /** * GtkMenuButton:use-popover: * * Whether to construct a #GtkPopover from the menu model, * or a #GtkMenu. */ menu_button_props[PROP_USE_POPOVER] = g_param_spec_boolean ("use-popover", P_("Use a popover"), P_("Use a popover instead of a menu"), TRUE, GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY); /** * GtkMenuButton:popover: * * The #GtkPopover that will be popped up when the button is clicked. */ menu_button_props[PROP_POPOVER] = g_param_spec_object ("popover", P_("Popover"), P_("The popover"), GTK_TYPE_POPOVER, G_PARAM_READWRITE); menu_button_props[PROP_ICON_NAME] = g_param_spec_string ("icon-name", P_("Icon Name"), P_("The name of the icon used to automatically populate the button"), NULL, GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY); menu_button_props[PROP_LABEL] = g_param_spec_string ("label", P_("Label"), P_("The label for the button"), NULL, GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY); menu_button_props[PROP_RELIEF] = g_param_spec_enum ("relief", P_("Border relief"), P_("The border relief style"), GTK_TYPE_RELIEF_STYLE, GTK_RELIEF_NORMAL, GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY); g_object_class_install_properties (gobject_class, LAST_PROP, menu_button_props); gtk_widget_class_set_accessible_type (widget_class, GTK_TYPE_MENU_BUTTON_ACCESSIBLE); gtk_widget_class_set_css_name (widget_class, I_("menubutton")); } static void set_arrow_type (GtkImage *image, GtkArrowType arrow_type) { switch (arrow_type) { case GTK_ARROW_NONE: gtk_image_set_from_icon_name (image, "open-menu-symbolic"); break; case GTK_ARROW_DOWN: gtk_image_set_from_icon_name (image, "pan-down-symbolic"); break; case GTK_ARROW_UP: gtk_image_set_from_icon_name (image, "pan-up-symbolic"); break; case GTK_ARROW_LEFT: gtk_image_set_from_icon_name (image, "pan-start-symbolic"); break; case GTK_ARROW_RIGHT: gtk_image_set_from_icon_name (image, "pan-end-symbolic"); break; default: break; } } static void add_arrow (GtkMenuButton *menu_button) { GtkWidget *arrow; GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); arrow = gtk_image_new (); set_arrow_type (GTK_IMAGE (arrow), priv->arrow_type); gtk_container_add (GTK_CONTAINER (priv->button), arrow); priv->arrow_widget = arrow; } static void gtk_menu_button_init (GtkMenuButton *menu_button) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); GtkStyleContext *context; priv->arrow_type = GTK_ARROW_DOWN; priv->use_popover = TRUE; priv->button = gtk_toggle_button_new (); gtk_widget_set_parent (priv->button, GTK_WIDGET (menu_button)); g_signal_connect_swapped (priv->button, "toggled", G_CALLBACK (gtk_menu_button_toggled), menu_button); add_arrow (menu_button); gtk_widget_set_sensitive (priv->button, FALSE); context = gtk_widget_get_style_context (GTK_WIDGET (menu_button)); gtk_style_context_add_class (context, "popup"); } /** * gtk_menu_button_new: * * Creates a new #GtkMenuButton widget with downwards-pointing * arrow as the only child. You can replace the child widget * with another #GtkWidget should you wish to. * * Returns: The newly created #GtkMenuButton widget */ GtkWidget * gtk_menu_button_new (void) { return g_object_new (GTK_TYPE_MENU_BUTTON, NULL); } /* Callback for the "deactivate" signal on the pop-up menu. * This is used so that we unset the state of the toggle button * when the pop-up menu disappears. * Also used for the "close" signal on the popover. */ static gboolean menu_deactivate_cb (GtkMenuButton *menu_button) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (priv->button), FALSE); return TRUE; } static void menu_detacher (GtkWidget *widget, GtkMenu *menu) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (GTK_MENU_BUTTON (widget)); g_return_if_fail (priv->menu == (GtkWidget *) menu); priv->menu = NULL; } static void update_sensitivity (GtkMenuButton *menu_button) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); gtk_widget_set_sensitive (priv->button, priv->menu != NULL || priv->popover != NULL || priv->create_popup_func != NULL); } /** * gtk_menu_button_set_popup: * @menu_button: a #GtkMenuButton * @menu: (nullable): a #GtkMenu, or %NULL to unset and disable the button * * Sets the #GtkMenu that will be popped up when the @menu_button is clicked, or * %NULL to dissociate any existing menu and disable the button. * * If #GtkMenuButton:menu-model or #GtkMenuButton:popover are set, those objects * are dissociated from the @menu_button, and those properties are set to %NULL. */ void gtk_menu_button_set_popup (GtkMenuButton *menu_button, GtkWidget *menu) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); g_return_if_fail (GTK_IS_MENU_BUTTON (menu_button)); g_return_if_fail (GTK_IS_MENU (menu) || menu == NULL); g_object_freeze_notify (G_OBJECT (menu_button)); g_clear_object (&priv->model); if (priv->menu == GTK_WIDGET (menu)) return; if (priv->menu) { if (gtk_widget_get_visible (priv->menu)) gtk_menu_shell_deactivate (GTK_MENU_SHELL (priv->menu)); g_signal_handlers_disconnect_by_func (priv->menu, menu_deactivate_cb, menu_button); gtk_menu_detach (GTK_MENU (priv->menu)); } priv->menu = menu; if (priv->menu) { gtk_menu_attach_to_widget (GTK_MENU (priv->menu), GTK_WIDGET (menu_button), menu_detacher); gtk_widget_set_visible (priv->menu, FALSE); g_signal_connect_swapped (priv->menu, "deactivate", G_CALLBACK (menu_deactivate_cb), menu_button); } g_object_notify_by_pspec (G_OBJECT (menu_button), menu_button_props[PROP_POPUP]); g_object_notify_by_pspec (G_OBJECT (menu_button), menu_button_props[PROP_MENU_MODEL]); if (menu && priv->popover) gtk_menu_button_set_popover (menu_button, NULL); update_sensitivity (menu_button); g_object_thaw_notify (G_OBJECT (menu_button)); } /** * gtk_menu_button_get_popup: * @menu_button: a #GtkMenuButton * * Returns the #GtkMenu that pops out of the button. * If the button does not use a #GtkMenu, this function * returns %NULL. * * Returns: (nullable) (transfer none): a #GtkMenu or %NULL */ GtkMenu * gtk_menu_button_get_popup (GtkMenuButton *menu_button) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); g_return_val_if_fail (GTK_IS_MENU_BUTTON (menu_button), NULL); return GTK_MENU (priv->menu); } /** * gtk_menu_button_set_menu_model: * @menu_button: a #GtkMenuButton * @menu_model: (nullable): a #GMenuModel, or %NULL to unset and disable the * button * * Sets the #GMenuModel from which the popup will be constructed, * or %NULL to dissociate any existing menu model and disable the button. * * Depending on the value of #GtkMenuButton:use-popover, either a * #GtkMenu will be created with gtk_menu_new_from_model(), or a * #GtkPopover with gtk_popover_new_from_model(). In either case, * actions will be connected as documented for these functions. * * If #GtkMenuButton:popup or #GtkMenuButton:popover are already set, those * widgets are dissociated from the @menu_button, and those properties are set * to %NULL. */ void gtk_menu_button_set_menu_model (GtkMenuButton *menu_button, GMenuModel *menu_model) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); g_return_if_fail (GTK_IS_MENU_BUTTON (menu_button)); g_return_if_fail (G_IS_MENU_MODEL (menu_model) || menu_model == NULL); g_object_freeze_notify (G_OBJECT (menu_button)); if (menu_model) g_object_ref (menu_model); if (menu_model) { if (priv->use_popover) { GtkWidget *popover; popover = gtk_popover_menu_new_from_model (GTK_WIDGET (menu_button), menu_model); gtk_menu_button_set_popover (menu_button, popover); } else { GtkWidget *menu; menu = gtk_menu_new_from_model (menu_model); gtk_widget_show (menu); gtk_menu_button_set_popup (menu_button, menu); } } else { gtk_menu_button_set_popup (menu_button, NULL); gtk_menu_button_set_popover (menu_button, NULL); } priv->model = menu_model; g_object_notify_by_pspec (G_OBJECT (menu_button), menu_button_props[PROP_MENU_MODEL]); g_object_thaw_notify (G_OBJECT (menu_button)); } /** * gtk_menu_button_get_menu_model: * @menu_button: a #GtkMenuButton * * Returns the #GMenuModel used to generate the popup. * * Returns: (nullable) (transfer none): a #GMenuModel or %NULL */ GMenuModel * gtk_menu_button_get_menu_model (GtkMenuButton *menu_button) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); g_return_val_if_fail (GTK_IS_MENU_BUTTON (menu_button), NULL); return priv->model; } static void set_align_widget_pointer (GtkMenuButton *menu_button, GtkWidget *align_widget) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); if (priv->align_widget) g_object_remove_weak_pointer (G_OBJECT (priv->align_widget), (gpointer *) &priv->align_widget); priv->align_widget = align_widget; if (priv->align_widget) g_object_add_weak_pointer (G_OBJECT (priv->align_widget), (gpointer *) &priv->align_widget); } /** * gtk_menu_button_set_align_widget: * @menu_button: a #GtkMenuButton * @align_widget: (allow-none): a #GtkWidget * * Sets the #GtkWidget to use to line the menu with when popped up. * Note that the @align_widget must contain the #GtkMenuButton itself. * * Setting it to %NULL means that the menu will be aligned with the * button itself. * * Note that this property is only used with menus currently, * and not for popovers. */ void gtk_menu_button_set_align_widget (GtkMenuButton *menu_button, GtkWidget *align_widget) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); g_return_if_fail (GTK_IS_MENU_BUTTON (menu_button)); g_return_if_fail (align_widget == NULL || gtk_widget_is_ancestor (GTK_WIDGET (menu_button), align_widget)); if (priv->align_widget == align_widget) return; set_align_widget_pointer (menu_button, align_widget); g_object_notify_by_pspec (G_OBJECT (menu_button), menu_button_props[PROP_ALIGN_WIDGET]); } /** * gtk_menu_button_get_align_widget: * @menu_button: a #GtkMenuButton * * Returns the parent #GtkWidget to use to line up with menu. * * Returns: (nullable) (transfer none): a #GtkWidget value or %NULL */ GtkWidget * gtk_menu_button_get_align_widget (GtkMenuButton *menu_button) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); g_return_val_if_fail (GTK_IS_MENU_BUTTON (menu_button), NULL); return priv->align_widget; } static void update_popover_direction (GtkMenuButton *menu_button) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); if (!priv->popover) return; switch (priv->arrow_type) { case GTK_ARROW_UP: gtk_popover_set_position (GTK_POPOVER (priv->popover), GTK_POS_TOP); break; case GTK_ARROW_DOWN: case GTK_ARROW_NONE: gtk_popover_set_position (GTK_POPOVER (priv->popover), GTK_POS_BOTTOM); break; case GTK_ARROW_LEFT: gtk_popover_set_position (GTK_POPOVER (priv->popover), GTK_POS_LEFT); break; case GTK_ARROW_RIGHT: gtk_popover_set_position (GTK_POPOVER (priv->popover), GTK_POS_RIGHT); break; default: break; } } static void popover_destroy_cb (GtkMenuButton *menu_button) { gtk_menu_button_set_popover (menu_button, NULL); } /** * gtk_menu_button_set_direction: * @menu_button: a #GtkMenuButton * @direction: a #GtkArrowType * * Sets the direction in which the popup will be popped up, as * well as changing the arrow’s direction. The child will not * be changed to an arrow if it was customized. * * If the does not fit in the available space in the given direction, * GTK+ will its best to keep it inside the screen and fully visible. * * If you pass %GTK_ARROW_NONE for a @direction, the popup will behave * as if you passed %GTK_ARROW_DOWN (although you won’t see any arrows). */ void gtk_menu_button_set_direction (GtkMenuButton *menu_button, GtkArrowType direction) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); GtkWidget *child; g_return_if_fail (GTK_IS_MENU_BUTTON (menu_button)); if (priv->arrow_type == direction) return; priv->arrow_type = direction; g_object_notify_by_pspec (G_OBJECT (menu_button), menu_button_props[PROP_DIRECTION]); /* Is it custom content? We don't change that */ child = gtk_bin_get_child (GTK_BIN (priv->button)); if (priv->arrow_widget != child) return; set_arrow_type (GTK_IMAGE (child), priv->arrow_type); update_popover_direction (menu_button); } /** * gtk_menu_button_get_direction: * @menu_button: a #GtkMenuButton * * Returns the direction the popup will be pointing at when popped up. * * Returns: a #GtkArrowType value */ GtkArrowType gtk_menu_button_get_direction (GtkMenuButton *menu_button) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); g_return_val_if_fail (GTK_IS_MENU_BUTTON (menu_button), GTK_ARROW_DOWN); return priv->arrow_type; } static void gtk_menu_button_dispose (GObject *object) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (GTK_MENU_BUTTON (object)); if (priv->menu) { g_signal_handlers_disconnect_by_func (priv->menu, menu_deactivate_cb, object); gtk_menu_detach (GTK_MENU (priv->menu)); priv->menu = NULL; } if (priv->popover) { g_signal_handlers_disconnect_by_func (priv->popover, menu_deactivate_cb, object); g_signal_handlers_disconnect_by_func (priv->popover, popover_destroy_cb, object); gtk_popover_set_relative_to (GTK_POPOVER (priv->popover), NULL); priv->popover = NULL; } set_align_widget_pointer (GTK_MENU_BUTTON (object), NULL); g_clear_object (&priv->model); g_clear_pointer (&priv->button, gtk_widget_unparent); if (priv->create_popup_destroy_notify) priv->create_popup_destroy_notify (priv->create_popup_user_data); G_OBJECT_CLASS (gtk_menu_button_parent_class)->dispose (object); } /** * gtk_menu_button_set_use_popover: * @menu_button: a #GtkMenuButton * @use_popover: %TRUE to construct a popover from the menu model * * Sets whether to construct a #GtkPopover instead of #GtkMenu * when gtk_menu_button_set_menu_model() is called. Note that * this property is only consulted when a new menu model is set. */ void gtk_menu_button_set_use_popover (GtkMenuButton *menu_button, gboolean use_popover) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); g_return_if_fail (GTK_IS_MENU_BUTTON (menu_button)); use_popover = use_popover != FALSE; if (priv->use_popover == use_popover) return; priv->use_popover = use_popover; g_object_freeze_notify (G_OBJECT (menu_button)); if (priv->model) gtk_menu_button_set_menu_model (menu_button, priv->model); g_object_notify_by_pspec (G_OBJECT (menu_button), menu_button_props[PROP_USE_POPOVER]); g_object_thaw_notify (G_OBJECT (menu_button)); } /** * gtk_menu_button_get_use_popover: * @menu_button: a #GtkMenuButton * * Returns whether a #GtkPopover or a #GtkMenu will be constructed * from the menu model. * * Returns: %TRUE if using a #GtkPopover */ gboolean gtk_menu_button_get_use_popover (GtkMenuButton *menu_button) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); g_return_val_if_fail (GTK_IS_MENU_BUTTON (menu_button), FALSE); return priv->use_popover; } /** * gtk_menu_button_set_popover: * @menu_button: a #GtkMenuButton * @popover: (nullable): a #GtkPopover, or %NULL to unset and disable the button * * Sets the #GtkPopover that will be popped up when the @menu_button is clicked, * or %NULL to dissociate any existing popover and disable the button. * * If #GtkMenuButton:menu-model or #GtkMenuButton:popup are set, those objects * are dissociated from the @menu_button, and those properties are set to %NULL. */ void gtk_menu_button_set_popover (GtkMenuButton *menu_button, GtkWidget *popover) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); g_return_if_fail (GTK_IS_MENU_BUTTON (menu_button)); g_return_if_fail (GTK_IS_POPOVER (popover) || popover == NULL); g_object_freeze_notify (G_OBJECT (menu_button)); g_clear_object (&priv->model); if (priv->popover) { if (gtk_widget_get_visible (priv->popover)) gtk_widget_hide (priv->popover); g_signal_handlers_disconnect_by_func (priv->popover, menu_deactivate_cb, menu_button); g_signal_handlers_disconnect_by_func (priv->popover, popover_destroy_cb, menu_button); gtk_popover_set_relative_to (GTK_POPOVER (priv->popover), NULL); } priv->popover = popover; if (popover) { gtk_popover_set_relative_to (GTK_POPOVER (priv->popover), GTK_WIDGET (menu_button)); g_signal_connect_swapped (priv->popover, "closed", G_CALLBACK (menu_deactivate_cb), menu_button); g_signal_connect_swapped (priv->popover, "destroy", G_CALLBACK (popover_destroy_cb), menu_button); update_popover_direction (menu_button); } if (popover && priv->menu) gtk_menu_button_set_popup (menu_button, NULL); update_sensitivity (menu_button); g_object_notify_by_pspec (G_OBJECT (menu_button), menu_button_props[PROP_POPOVER]); g_object_notify_by_pspec (G_OBJECT (menu_button), menu_button_props[PROP_MENU_MODEL]); g_object_thaw_notify (G_OBJECT (menu_button)); } /** * gtk_menu_button_get_popover: * @menu_button: a #GtkMenuButton * * Returns the #GtkPopover that pops out of the button. * If the button is not using a #GtkPopover, this function * returns %NULL. * * Returns: (nullable) (transfer none): a #GtkPopover or %NULL */ GtkPopover * gtk_menu_button_get_popover (GtkMenuButton *menu_button) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); g_return_val_if_fail (GTK_IS_MENU_BUTTON (menu_button), NULL); return GTK_POPOVER (priv->popover); } /** * gtk_menu_button_set_icon_name: * @menu_button: a #GtkMenuButton * @icon_name: the icon name * * Sets the name of an icon to show inside the menu button. */ void gtk_menu_button_set_icon_name (GtkMenuButton *menu_button, const char *icon_name) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); g_return_if_fail (GTK_IS_MENU_BUTTON (menu_button)); gtk_button_set_icon_name (GTK_BUTTON (priv->button), icon_name); g_object_notify_by_pspec (G_OBJECT (menu_button), menu_button_props[PROP_ICON_NAME]); } /** * gtk_menu_button_get_icon_name: * @menu_button: a #GtkMenuButton * * Gets the name of the icon shown in the button. * * Returns: the name of the icon shown in the button */ const char * gtk_menu_button_get_icon_name (GtkMenuButton *menu_button) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); g_return_val_if_fail (GTK_IS_MENU_BUTTON (menu_button), NULL); return gtk_button_get_icon_name (GTK_BUTTON (priv->button)); } /** * gtk_menu_button_set_label: * @menu_button: a #GtkMenuButton * @label: the label * * Sets the label to show inside the menu button. */ void gtk_menu_button_set_label (GtkMenuButton *menu_button, const char *label) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); GtkWidget *child; GtkWidget *box; g_return_if_fail (GTK_IS_MENU_BUTTON (menu_button)); child = gtk_bin_get_child (GTK_BIN (priv->button)); if (child) gtk_container_remove (GTK_CONTAINER (priv->button), child); box = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 6); gtk_container_add (GTK_CONTAINER (box), gtk_label_new (label)); gtk_container_add (GTK_CONTAINER (box), gtk_image_new_from_icon_name ("pan-down-symbolic")); gtk_container_add (GTK_CONTAINER (priv->button), box); g_object_notify_by_pspec (G_OBJECT (menu_button), menu_button_props[PROP_LABEL]); } /** * gtk_menu_button_get_label: * @menu_button: a #GtkMenuButton * * Gets the label shown in the button * * Returns: the label shown in the button */ const char * gtk_menu_button_get_label (GtkMenuButton *menu_button) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); GtkWidget *child; g_return_val_if_fail (GTK_IS_MENU_BUTTON (menu_button), NULL); child = gtk_bin_get_child (GTK_BIN (priv->button)); if (GTK_IS_BOX (child)) { child = gtk_widget_get_first_child (child); return gtk_label_get_label (GTK_LABEL (child)); } return NULL; } /** * gtk_menu_button_set_relief: * @menu_button: The #GtkMenuButton you want to set relief styles of * @relief: The GtkReliefStyle as described above * * Sets the relief style of the edges of the given * #GtkMenuButton widget. * * Two styles exist, %GTK_RELIEF_NORMAL and %GTK_RELIEF_NONE. * The default style is, as one can guess, %GTK_RELIEF_NORMAL. */ void gtk_menu_button_set_relief (GtkMenuButton *menu_button, GtkReliefStyle relief) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); g_return_if_fail (GTK_IS_MENU_BUTTON (menu_button)); if (relief == gtk_button_get_relief (GTK_BUTTON (priv->button))) return; gtk_button_set_relief (GTK_BUTTON (priv->button), relief); g_object_notify_by_pspec (G_OBJECT (menu_button), menu_button_props[PROP_RELIEF]); } /** * gtk_menu_button_get_relief: * @menu_button: The #GtkMenuButton you want the #GtkReliefStyle from. * * Returns the current relief style of the given #GtkMenuButton. * * Returns: The current #GtkReliefStyle */ GtkReliefStyle gtk_menu_button_get_relief (GtkMenuButton *menu_button) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); g_return_val_if_fail (GTK_IS_MENU_BUTTON (menu_button), GTK_RELIEF_NORMAL); return gtk_button_get_relief (GTK_BUTTON (priv->button)); } /** * gtk_menu_button_popup: * @menu_button: a #GtkMenuButton * * Pop up the menu. */ void gtk_menu_button_popup (GtkMenuButton *menu_button) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); g_return_if_fail (GTK_IS_MENU_BUTTON (menu_button)); gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (priv->button), TRUE); } /** * gtk_menu_button_popdown: * @menu_button: a #GtkMenuButton * * Dismiss the menu. */ void gtk_menu_button_popdown (GtkMenuButton *menu_button) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); g_return_if_fail (GTK_IS_MENU_BUTTON (menu_button)); gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (priv->button), FALSE); } void gtk_menu_button_add_child (GtkMenuButton *menu_button, GtkWidget *new_child) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); GtkWidget *child; child = gtk_bin_get_child (GTK_BIN (priv->button)); if (child) gtk_container_remove (GTK_CONTAINER (priv->button), child); gtk_container_add (GTK_CONTAINER (priv->button), new_child); } /** * gtk_menu_button_set_create_popup_func: * @menu_button: a #GtkMenuButton * @func: (nullable): function to call when a popuop is about to * be shown, but none has been provided via other means, or %NULL * to reset to default behavior. * @user_data: (nullable): user data to pass to @callback * @destroy_notify: (nullable): destroy notify for @user_data * * Sets @func to be called when a popup is about to be shown. * @func should use one of * * - gtk_menu_button_set_popup() * - gtk_menu_button_set_popover() * - gtk_menu_button_set_menu_model() * * to set a popoup for @menu_button. * If @func is non-%NULL, @menu_button will always be sensitive. * * Using this function will NOT reset the menu widget attached to @menu_button. * Instead, this can be done manually in @func. */ void gtk_menu_button_set_create_popup_func (GtkMenuButton *menu_button, GtkMenuButtonCreatePopupFunc func, gpointer user_data, GDestroyNotify destroy_notify) { GtkMenuButtonPrivate *priv = gtk_menu_button_get_instance_private (menu_button); g_return_if_fail (GTK_IS_MENU_BUTTON (menu_button)); if (priv->create_popup_destroy_notify) priv->create_popup_destroy_notify (priv->create_popup_user_data); priv->create_popup_func = func; priv->create_popup_user_data = user_data; priv->create_popup_destroy_notify = destroy_notify; update_sensitivity (menu_button); }