Pileus Git - ~andy/gtk/blob - gtk/gtkmenubutton.c

   1 /* GTK - The GIMP Toolkit
   2  *
   3  * Copyright (C) 2003 Ricardo Fernandez Pascual
   4  * Copyright (C) 2004 Paolo Borelli
   5  * Copyright (C) 2012 Bastien Nocera
   6  *
   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.
  11  *
  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.
  16  *
  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/>.
  19  */
  20
  21 /**
  22  * SECTION:gtkmenubutton
  23  * @short_description: A widget that shows a menu when clicked on
  24  * @title: GtkMenuButton
  25  *
  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.
  28  *
  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.
  32  *
  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,
  41  * it is 'pushed in'.
  42  *
  43  * <informaltable>
  44  *   <tgroup cols="4">
  45  *     <tbody>
  46  *       <row>
  47  *         <entry></entry>
  48  *         <entry>halign = start</entry>
  49  *         <entry>halign = center</entry>
  50  *         <entry>halign = end</entry>
  51  *       </row>
  52  *     <row>
  53  *       <entry>direction = down</entry>
  54  *       <entry>
  55  *         <inlinemediaobject>
  56  *           <imageobject><imagedata fileref="down-start.png" format="PNG"/></imageobject>
  57  *         </inlinemediaobject>
  58  *       </entry>
  59  *       <entry>
  60  *         <inlinemediaobject>
  61  *           <imageobject><imagedata fileref="down-center.png" format="PNG"/></imageobject>
  62  *         </inlinemediaobject>
  63  *       </entry>
  64  *       <entry>
  65  *         <inlinemediaobject>
  66  *           <imageobject><imagedata fileref="down-end.png" format="PNG"/></imageobject>
  67  *         </inlinemediaobject>
  68  *       </entry>
  69  *     </row>
  70  *     <row>
  71  *       <entry>direction = up</entry>
  72  *       <entry>
  73  *         <inlinemediaobject>
  74  *           <imageobject><imagedata fileref="up-start.png" format="PNG"/></imageobject>
  75  *         </inlinemediaobject>
  76  *       </entry>
  77  *       <entry>
  78  *         <inlinemediaobject>
  79  *           <imageobject><imagedata fileref="up-center.png" format="PNG"/></imageobject>
  80  *         </inlinemediaobject>
  81  *       </entry>
  82  *       <entry>
  83  *         <inlinemediaobject>
  84  *           <imageobject><imagedata fileref="up-end.png" format="PNG"/></imageobject>
  85  *         </inlinemediaobject>
  86  *       </entry>
  87  *      </row>
  88  *     </tbody>
  89  *   </tgroup>
  90  * </informaltable>
  91  * <informaltable>
  92  *   <tgroup cols="3">
  93  *     <tbody>
  94  *       <row>
  95  *         <entry></entry>
  96  *         <entry>direction = left</entry>
  97  *         <entry>direction = right</entry>
  98  *       </row>
  99  *     <row>
 100  *       <entry>valign = start</entry>
 101  *       <entry>
 102  *         <inlinemediaobject>
 103  *           <imageobject><imagedata fileref="left-start.png" format="PNG"/></imageobject>
 104  *         </inlinemediaobject>
 105  *       </entry>
 106  *       <entry>
 107  *         <inlinemediaobject>
 108  *           <imageobject><imagedata fileref="right-start.png" format="PNG"/></imageobject>
 109  *         </inlinemediaobject>
 110  *       </entry>
 111  *     </row>
 112  *     <row>
 113  *       <entry>valign = center</entry>
 114  *       <entry>
 115  *         <inlinemediaobject>
 116  *           <imageobject><imagedata fileref="left-center.png" format="PNG"/></imageobject>
 117  *         </inlinemediaobject>
 118  *       </entry>
 119  *       <entry>
 120  *         <inlinemediaobject>
 121  *           <imageobject><imagedata fileref="right-center.png" format="PNG"/></imageobject>
 122  *         </inlinemediaobject>
 123  *       </entry>
 124  *     </row>
 125  *     <row>
 126  *       <entry>valign = end</entry>
 127  *       <entry>
 128  *         <inlinemediaobject>
 129  *           <imageobject><imagedata fileref="left-end.png" format="PNG"/></imageobject>
 130  *         </inlinemediaobject>
 131  *       </entry>
 132  *       <entry>
 133  *         <inlinemediaobject>
 134  *           <imageobject><imagedata fileref="right-end.png" format="PNG"/></imageobject>
 135  *         </inlinemediaobject>
 136  *       </entry>
 137  *      </row>
 138  *     </tbody>
 139  *   </tgroup>
 140  * </informaltable>
 141  */
 142
 143 #include "config.h"
 144
 145 #include "gtkmenubutton.h"
 146 #include "gtkmenubuttonprivate.h"
 147 #include "gtkarrow.h"
 148
 149 #include "gtkprivate.h"
 150 #include "gtkintl.h"
 151
 152 struct _GtkMenuButtonPrivate
 153 {
 154   GtkWidget *popup;
 155   GMenuModel *model;
 156
 157   GtkMenuButtonShowMenuCallback func;
 158   gpointer user_data;
 159
 160   GtkArrowType arrow_type;
 161   GtkWidget *align_widget;
 162   gpointer arrow_widget;
 163 };
 164
 165 enum
 166 {
 167   PROP_0,
 168   PROP_POPUP,
 169   PROP_MODEL,
 170   PROP_ALIGN_WIDGET,
 171   PROP_DIRECTION
 172 };
 173
 174 G_DEFINE_TYPE(GtkMenuButton, gtk_menu_button, GTK_TYPE_TOGGLE_BUTTON)
 175
 176 static void gtk_menu_button_dispose (GObject *object);
 177
 178 static void
 179 gtk_menu_button_set_property (GObject      *object,
 180                               guint         property_id,
 181                               const GValue *value,
 182                               GParamSpec   *pspec)
 183 {
 184   GtkMenuButton *self = GTK_MENU_BUTTON (object);
 185
 186   switch (property_id)
 187     {
 188       case PROP_POPUP:
 189         gtk_menu_button_set_popup (self, g_value_get_object (value));
 190         break;
 191       case PROP_MODEL:
 192         gtk_menu_button_set_menu_model (self, g_value_get_object (value));
 193         break;
 194       case PROP_ALIGN_WIDGET:
 195         gtk_menu_button_set_align_widget (self, g_value_get_object (value));
 196         break;
 197       case PROP_DIRECTION:
 198         gtk_menu_button_set_direction (self, g_value_get_enum (value));
 199         break;
 200       default:
 201         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
 202     }
 203 }
 204
 205 static void
 206 gtk_menu_button_get_property (GObject    *object,
 207                               guint       property_id,
 208                               GValue     *value,
 209                               GParamSpec *pspec)
 210 {
 211   GtkMenuButtonPrivate *priv = GTK_MENU_BUTTON (object)->priv;
 212
 213   switch (property_id)
 214     {
 215       case PROP_POPUP:
 216         g_value_set_object (value, priv->popup);
 217         break;
 218       case PROP_MODEL:
 219         g_value_set_object (value, priv->model);
 220         break;
 221       case PROP_ALIGN_WIDGET:
 222         g_value_set_object (value, priv->align_widget);
 223         break;
 224       case PROP_DIRECTION:
 225         g_value_set_enum (value, priv->arrow_type);
 226         break;
 227       default:
 228         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
 229     }
 230 }
 231
 232 static void
 233 gtk_menu_button_state_flags_changed (GtkWidget    *widget,
 234                                      GtkStateFlags previous_state_flags)
 235 {
 236   GtkMenuButton *button = GTK_MENU_BUTTON (widget);
 237   GtkMenuButtonPrivate *priv = button->priv;
 238
 239   if (!gtk_widget_is_sensitive (widget) && priv->popup)
 240     gtk_menu_shell_deactivate (GTK_MENU_SHELL (priv->popup));
 241 }
 242
 243 static void
 244 menu_position_up_down_func (GtkMenu       *menu,
 245                             gint          *x,
 246                             gint          *y,
 247                             gboolean      *push_in,
 248                             GtkMenuButton *menu_button)
 249 {
 250   GtkMenuButtonPrivate *priv = menu_button->priv;
 251   GtkWidget *widget = GTK_WIDGET (menu_button);
 252   GtkWidget *toplevel;
 253   GtkRequisition menu_req;
 254   GtkTextDirection direction;
 255   GdkRectangle monitor;
 256   gint monitor_num;
 257   GdkScreen *screen;
 258   GdkWindow *window;
 259   GtkAllocation allocation, arrow_allocation;
 260   GtkAlign align;
 261
 262   /* In the common case the menu button is showing a dropdown menu, set the
 263    * corresponding type hint on the toplevel, so the WM can omit the top side
 264    * of the shadows.
 265    */
 266   if (priv->arrow_type == GTK_ARROW_DOWN)
 267     {
 268       toplevel = gtk_widget_get_toplevel (GTK_WIDGET (priv->popup));
 269       gtk_window_set_type_hint (GTK_WINDOW (toplevel), GDK_WINDOW_TYPE_HINT_DROPDOWN_MENU);
 270     }
 271
 272   gtk_widget_get_preferred_size (GTK_WIDGET (priv->popup),
 273                                  &menu_req, NULL);
 274
 275   align = gtk_widget_get_halign (GTK_WIDGET (priv->popup));
 276   direction = gtk_widget_get_direction (widget);
 277   window = gtk_widget_get_window (priv->align_widget ? priv->align_widget : widget);
 278
 279   screen = gtk_widget_get_screen (GTK_WIDGET (menu));
 280   monitor_num = gdk_screen_get_monitor_at_window (screen, window);
 281   if (monitor_num < 0)
 282     monitor_num = 0;
 283   gdk_screen_get_monitor_workarea (screen, monitor_num, &monitor);
 284
 285   gtk_widget_get_allocation (priv->align_widget ? priv->align_widget : widget, &allocation);
 286   gtk_widget_get_allocation (widget, &arrow_allocation);
 287
 288   gdk_window_get_origin (window, x, y);
 289   *x += allocation.x;
 290   *y += allocation.y;
 291
 292   /* treat the default align value like START */
 293   if (align == GTK_ALIGN_FILL)
 294     align = GTK_ALIGN_START;
 295
 296   if (align == GTK_ALIGN_CENTER)
 297     *x -= (menu_req.width - allocation.width) / 2;
 298   else if ((align == GTK_ALIGN_START && direction == GTK_TEXT_DIR_LTR) ||
 299            (align == GTK_ALIGN_END && direction == GTK_TEXT_DIR_RTL))
 300     *x += MAX (allocation.width - menu_req.width, 0);
 301   else if (menu_req.width > allocation.width)
 302     *x -= menu_req.width - allocation.width;
 303
 304   if (priv->arrow_type == GTK_ARROW_UP && *y - menu_req.height >= monitor.y)
 305     {
 306       *y -= menu_req.height;
 307     }
 308   else
 309     {
 310       if ((*y + arrow_allocation.height + menu_req.height) <= monitor.y + monitor.height)
 311         *y += arrow_allocation.height;
 312       else if ((*y - menu_req.height) >= monitor.y)
 313         *y -= menu_req.height;
 314       else if (monitor.y + monitor.height - (*y + arrow_allocation.height) > *y)
 315         *y += arrow_allocation.height;
 316       else
 317         *y -= menu_req.height;
 318     }
 319
 320   *push_in = FALSE;
 321 }
 322
 323 static void
 324 menu_position_side_func (GtkMenu       *menu,
 325                          gint          *x,
 326                          gint          *y,
 327                          gboolean      *push_in,
 328                          GtkMenuButton *menu_button)
 329 {
 330   GtkMenuButtonPrivate *priv = menu_button->priv;
 331   GtkAllocation allocation;
 332   GtkWidget *widget = GTK_WIDGET (menu_button);
 333   GtkRequisition menu_req;
 334   GdkRectangle monitor;
 335   gint monitor_num;
 336   GdkScreen *screen;
 337   GdkWindow *window;
 338   GtkAlign align;
 339
 340   gtk_widget_get_preferred_size (GTK_WIDGET (priv->popup),
 341                                  &menu_req, NULL);
 342
 343   window = gtk_widget_get_window (widget);
 344
 345   align = gtk_widget_get_valign (GTK_WIDGET (menu));
 346   screen = gtk_widget_get_screen (GTK_WIDGET (menu));
 347   monitor_num = gdk_screen_get_monitor_at_window (screen, window);
 348   if (monitor_num < 0)
 349     monitor_num = 0;
 350   gdk_screen_get_monitor_workarea (screen, monitor_num, &monitor);
 351
 352   gdk_window_get_origin (gtk_button_get_event_window (GTK_BUTTON (menu_button)), x, y);
 353
 354   gtk_widget_get_allocation (widget, &allocation);
 355
 356   if (priv->arrow_type == GTK_ARROW_RIGHT)
 357     {
 358       if (*x + allocation.width + menu_req.width <= monitor.x + monitor.width)
 359         *x += allocation.width;
 360       else
 361         *x -= menu_req.width;
 362     }
 363   else
 364     {
 365       if (*x - menu_req.width >= monitor.x)
 366         *x -= menu_req.width;
 367       else
 368         *x += allocation.width;
 369     }
 370
 371   /* treat the default align value like START */
 372   if (align == GTK_ALIGN_FILL)
 373     align = GTK_ALIGN_START;
 374
 375   if (align == GTK_ALIGN_CENTER)
 376     *y -= (menu_req.height - allocation.height) / 2;
 377   else if (align == GTK_ALIGN_END)
 378     *y -= menu_req.height - allocation.height;
 379
 380   *push_in = FALSE;
 381 }
 382
 383 static void
 384 popup_menu (GtkMenuButton  *menu_button,
 385             GdkEventButton *event)
 386 {
 387   GtkMenuButtonPrivate *priv = menu_button->priv;
 388   GtkMenuPositionFunc func;
 389
 390   if (priv->func)
 391     priv->func (priv->user_data);
 392
 393   if (!priv->popup)
 394     return;
 395
 396   switch (priv->arrow_type)
 397     {
 398       case GTK_ARROW_LEFT:
 399       case GTK_ARROW_RIGHT:
 400         func = (GtkMenuPositionFunc) menu_position_side_func;
 401         break;
 402       default:
 403         func = (GtkMenuPositionFunc) menu_position_up_down_func;
 404         break;
 405   }
 406
 407   gtk_menu_popup_for_device (GTK_MENU (priv->popup),
 408                              event ? event->device : NULL,
 409                              NULL, NULL,
 410                              func,
 411                              GTK_WIDGET (menu_button),
 412                              NULL,
 413                              event ? event->button : 0,
 414                              event ? event->time : gtk_get_current_event_time ());
 415 }
 416
 417 static void
 418 gtk_menu_button_toggled (GtkToggleButton *button)
 419 {
 420   GtkMenuButton *menu_button = GTK_MENU_BUTTON (button);
 421   GtkMenuButtonPrivate *priv = menu_button->priv;
 422
 423   if (!priv->popup)
 424     return;
 425
 426   if (gtk_toggle_button_get_active (button) &&
 427       !gtk_widget_get_visible (GTK_WIDGET (priv->popup)))
 428     {
 429       /* we get here only when the menu is activated by a key
 430        * press, so that we can select the first menu item
 431        */
 432       popup_menu (menu_button, NULL);
 433       gtk_menu_shell_select_first (GTK_MENU_SHELL (priv->popup), FALSE);
 434     }
 435 }
 436
 437 static gboolean
 438 gtk_menu_button_button_press_event (GtkWidget      *widget,
 439                                     GdkEventButton *event)
 440 {
 441   if (event->button == GDK_BUTTON_PRIMARY)
 442     {
 443       popup_menu (GTK_MENU_BUTTON (widget), event);
 444       gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (widget), TRUE);
 445
 446       return TRUE;
 447     }
 448
 449   return GTK_WIDGET_CLASS (gtk_menu_button_parent_class)->button_press_event (widget, event);
 450 }
 451
 452 static void
 453 gtk_menu_button_add (GtkContainer *container,
 454                      GtkWidget    *child)
 455 {
 456   GtkMenuButton *button = GTK_MENU_BUTTON (container);
 457
 458   if (button->priv->arrow_widget)
 459     gtk_container_remove (container, button->priv->arrow_widget);
 460
 461   GTK_CONTAINER_CLASS (gtk_menu_button_parent_class)->add (container, child);
 462 }
 463
 464 static void
 465 gtk_menu_button_remove (GtkContainer *container,
 466                         GtkWidget    *child)
 467 {
 468   GtkMenuButton *button = GTK_MENU_BUTTON (container);
 469
 470   if (child == button->priv->arrow_widget)
 471     button->priv->arrow_widget = NULL;
 472
 473   GTK_CONTAINER_CLASS (gtk_menu_button_parent_class)->remove (container, child);
 474 }
 475
 476 static void
 477 gtk_menu_button_class_init (GtkMenuButtonClass *klass)
 478 {
 479   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 480   GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
 481   GtkContainerClass *container_class = GTK_CONTAINER_CLASS (klass);
 482   GtkToggleButtonClass *toggle_button_class = GTK_TOGGLE_BUTTON_CLASS (klass);
 483
 484   g_type_class_add_private (klass, sizeof (GtkMenuButtonPrivate));
 485
 486   gobject_class->set_property = gtk_menu_button_set_property;
 487   gobject_class->get_property = gtk_menu_button_get_property;
 488   gobject_class->dispose = gtk_menu_button_dispose;
 489
 490   widget_class->state_flags_changed = gtk_menu_button_state_flags_changed;
 491   widget_class->button_press_event = gtk_menu_button_button_press_event;
 492
 493   container_class->add = gtk_menu_button_add;
 494   container_class->remove = gtk_menu_button_remove;
 495
 496   toggle_button_class->toggled = gtk_menu_button_toggled;
 497
 498   /**
 499    * GtkMenuButton:popup:
 500    *
 501    * The #GtkMenu that will be popped up when the button is clicked.
 502    *
 503    * Since: 3.6
 504    */
 505   g_object_class_install_property (gobject_class,
 506                                    PROP_POPUP,
 507                                    g_param_spec_object ("popup",
 508                                                         P_("popup"),
 509                                                         P_("The dropdown menu."),
 510                                                         GTK_TYPE_MENU,
 511                                                         G_PARAM_READWRITE));
 512    /**
 513    * GtkMenuButton:menu:
 514    *
 515    * The #GtkMenu that will be popped up when the button is clicked.
 516    * This property has been renamed to "popup".  "menu" will be
 517    * removed before 3.6.0.
 518    *
 519    * Since: 3.6
 520    */
 521   g_object_class_install_property (gobject_class,
 522                                    PROP_POPUP, /* [sic] */
 523                                    g_param_spec_object ("menu",
 524                                                         P_("menu"),
 525                                                         P_("The dropdown menu."),
 526                                                         GTK_TYPE_MENU,
 527                                                         G_PARAM_DEPRECATED | G_PARAM_READWRITE));
 528   /**
 529    * GtkMenuButton:menu-model:
 530    *
 531    * The #GMenuModel from which the menu to pop up will be created.
 532    * See gtk_menu_button_set_menu_model() for the interaction with the
 533    * #GtkMenuButton:menu property.
 534    *
 535    * Since: 3.6
 536    */
 537   g_object_class_install_property (gobject_class,
 538                                    PROP_MODEL,
 539                                    g_param_spec_object ("menu-model",
 540                                                         P_("menu-model"),
 541                                                         P_("The dropdown menu's model."),
 542                                                         G_TYPE_MENU_MODEL,
 543                                                         G_PARAM_READWRITE));
 544   /**
 545    * GtkMenuButton:align-widget:
 546    *
 547    * The #GtkWidget to use to align the popup menu with.
 548    *
 549    * Since: 3.6
 550    */
 551   g_object_class_install_property (gobject_class,
 552                                    PROP_ALIGN_WIDGET,
 553                                    g_param_spec_object ("align-widget",
 554                                                         P_("align-widget"),
 555                                                         P_("The parent widget which the menu should align with."),
 556                                                         GTK_TYPE_CONTAINER,
 557                                                         G_PARAM_READWRITE));
 558   /**
 559    * GtkMenuButton:direction:
 560    *
 561    * The #GtkArrowType representing the direction in which the
 562    * menu will be popped out.
 563    *
 564    * Since: 3.6
 565    */
 566   g_object_class_install_property (gobject_class,
 567                                    PROP_DIRECTION,
 568                                    g_param_spec_enum ("direction",
 569                                                       P_("direction"),
 570                                                       P_("The direction the arrow should point."),
 571                                                       GTK_TYPE_ARROW_TYPE,
 572                                                       GTK_ARROW_DOWN,
 573                                                       G_PARAM_READWRITE));
 574 }
 575
 576 static void
 577 add_arrow (GtkMenuButton *menu_button)
 578 {
 579   GtkWidget *arrow;
 580
 581   arrow = gtk_arrow_new (menu_button->priv->arrow_type, GTK_SHADOW_NONE);
 582   gtk_container_add (GTK_CONTAINER (menu_button), arrow);
 583   gtk_widget_show (arrow);
 584   menu_button->priv->arrow_widget = arrow;
 585 }
 586
 587 static void
 588 gtk_menu_button_init (GtkMenuButton *menu_button)
 589 {
 590   GtkMenuButtonPrivate *priv;
 591
 592   priv = G_TYPE_INSTANCE_GET_PRIVATE (menu_button, GTK_TYPE_MENU_BUTTON, GtkMenuButtonPrivate);
 593   menu_button->priv = priv;
 594   priv->arrow_type = GTK_ARROW_DOWN;
 595
 596   add_arrow (menu_button);
 597
 598   gtk_widget_set_sensitive (GTK_WIDGET (menu_button), FALSE);
 599 }
 600
 601 /**
 602  * gtk_menu_button_new:
 603  *
 604  * Creates a new #GtkMenuButton widget with downwards-pointing
 605  * arrow as the only child. You can replace the child widget
 606  * with another #GtkWidget should you wish to.
 607  *
 608  * Returns: The newly created #GtkMenuButton widget.
 609  *
 610  * Since: 3.6
 611  */
 612 GtkWidget *
 613 gtk_menu_button_new (void)
 614 {
 615   return g_object_new (GTK_TYPE_MENU_BUTTON, NULL);
 616 }
 617
 618 /* Callback for the "deactivate" signal on the pop-up menu.
 619  * This is used so that we unset the state of the toggle button
 620  * when the pop-up menu disappears.
 621  */
 622 static int
 623 menu_deactivate_cb (GtkMenuShell  *menu_shell,
 624                     GtkMenuButton *menu_button)
 625 {
 626   gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (menu_button), FALSE);
 627
 628   return TRUE;
 629 }
 630
 631 static void
 632 menu_detacher (GtkWidget *widget,
 633                GtkMenu   *menu)
 634 {
 635   GtkMenuButtonPrivate *priv = GTK_MENU_BUTTON (widget)->priv;
 636
 637   g_return_if_fail (priv->popup == (GtkWidget *) menu);
 638
 639   priv->popup = NULL;
 640 }
 641
 642 /* This function is used in GtkMenuToolButton, the call back will
 643  * be called when GtkMenuToolButton would have emitted the "show-menu"
 644  * signal.
 645  */
 646 void
 647 _gtk_menu_button_set_popup_with_func (GtkMenuButton                 *menu_button,
 648                                       GtkWidget                     *menu,
 649                                       GtkMenuButtonShowMenuCallback  func,
 650                                       gpointer                       user_data)
 651 {
 652   GtkMenuButtonPrivate *priv;
 653
 654   g_return_if_fail (GTK_IS_MENU_BUTTON (menu_button));
 655   g_return_if_fail (GTK_IS_MENU (menu) || menu == NULL);
 656
 657   priv = menu_button->priv;
 658   priv->func = func;
 659   priv->user_data = user_data;
 660
 661   if (priv->popup == GTK_WIDGET (menu))
 662     return;
 663
 664   if (priv->popup)
 665     {
 666       if (gtk_widget_get_visible (GTK_WIDGET (priv->popup)))
 667         gtk_menu_shell_deactivate (GTK_MENU_SHELL (priv->popup));
 668     }
 669
 670   if (priv->popup)
 671     {
 672       g_signal_handlers_disconnect_by_func (priv->popup,
 673                                             menu_deactivate_cb,
 674                                             menu_button);
 675       gtk_menu_detach (GTK_MENU (priv->popup));
 676     }
 677
 678   priv->popup = menu;
 679
 680   if (priv->popup)
 681     {
 682       gtk_menu_attach_to_widget (GTK_MENU (priv->popup), GTK_WIDGET (menu_button),
 683                                  menu_detacher);
 684
 685       gtk_widget_set_sensitive (GTK_WIDGET (menu_button), TRUE);
 686
 687       g_signal_connect (priv->popup, "deactivate",
 688                         G_CALLBACK (menu_deactivate_cb), menu_button);
 689     }
 690   else
 691     {
 692       gtk_widget_set_sensitive (GTK_WIDGET (menu_button), FALSE);
 693     }
 694
 695   g_object_notify (G_OBJECT (menu_button), "menu");
 696   g_object_notify (G_OBJECT (menu_button), "menu-model");
 697 }
 698
 699 /**
 700  * gtk_menu_button_set_popup:
 701  * @menu_button: a #GtkMenuButton
 702  * @popup: (allow-none): a #GtkMenu
 703  *
 704  * Sets the #GtkMenu that will be popped up when the button is clicked,
 705  * or %NULL to disable the button. If #GtkMenuButton:menu-model is set,
 706  * it will be set to %NULL.
 707  *
 708  * Since: 3.6
 709  */
 710 void
 711 gtk_menu_button_set_popup (GtkMenuButton *menu_button,
 712                            GtkWidget     *popup)
 713 {
 714   GtkMenuButtonPrivate *priv;
 715
 716   g_return_if_fail (GTK_IS_MENU_BUTTON (menu_button));
 717   g_return_if_fail (GTK_IS_MENU (popup) || popup == NULL);
 718
 719   priv = menu_button->priv;
 720   g_clear_object (&priv->model);
 721
 722   _gtk_menu_button_set_popup_with_func (menu_button, popup, NULL, NULL);
 723 }
 724
 725 /**
 726  * gtk_menu_button_get_popup:
 727  * @menu_button: a #GtkMenuButton
 728  *
 729  * Returns the #GtkMenu that pops out of the button.
 730  *
 731  * Returns: (transfer none): a #GtkMenu or %NULL.
 732  *
 733  * Since: 3.6
 734  */
 735 GtkMenu *
 736 gtk_menu_button_get_popup (GtkMenuButton *menu_button)
 737 {
 738   g_return_val_if_fail (GTK_IS_MENU_BUTTON (menu_button), NULL);
 739
 740   return GTK_MENU (menu_button->priv->popup);
 741 }
 742
 743 void
 744 gtk_menu_button_set_menu (GtkMenuButton *menu_button,
 745                           GtkWidget     *menu)
 746 {
 747   gtk_menu_button_set_popup (menu_button, menu);
 748 }
 749
 750 GtkMenu *
 751 gtk_menu_button_get_menu (GtkMenuButton *menu_button)
 752 {
 753   return gtk_menu_button_get_popup (menu_button);
 754 }
 755
 756 /**
 757  * gtk_menu_button_set_menu_model:
 758  * @menu_button: a #GtkMenuButton
 759  * @menu_model: (allow-none): a #GMenuModel
 760  *
 761  * Sets the #GMenuModel from which the #GtkMenuButton:menu property will be
 762  * filled in, or %NULL to disable the button.
 763  *
 764  * The #GtkMenu will be created with gtk_menu_new_from_model(), so actions
 765  * will be connected as documented there.
 766  *
 767  * If you #GtkMenuButton:menu * is already set, then its content will be lost
 768  * and replaced by our newly created #GtkMenu.
 769  *
 770  * Since: 3.6
 771  */
 772 void
 773 gtk_menu_button_set_menu_model (GtkMenuButton *menu_button,
 774                                 GMenuModel    *menu_model)
 775 {
 776   GtkMenuButtonPrivate *priv;
 777   GtkWidget *menu;
 778
 779   g_return_if_fail (GTK_IS_MENU_BUTTON (menu_button));
 780   g_return_if_fail (G_IS_MENU_MODEL (menu_model) || menu_model == NULL);
 781
 782   priv = menu_button->priv;
 783   g_clear_object (&priv->model);
 784
 785   if (menu_model == NULL)
 786     {
 787       gtk_menu_button_set_popup (menu_button, NULL);
 788       return;
 789     }
 790
 791   priv->model = g_object_ref (menu_model);
 792   menu = gtk_menu_new_from_model (menu_model);
 793   gtk_widget_show_all (menu);
 794   gtk_menu_button_set_popup (menu_button, menu);
 795 }
 796
 797 /**
 798  * gtk_menu_button_get_menu_model:
 799  * @menu_button: a #GtkMenuButton
 800  *
 801  * Returns the #GMenuModel used to generate the menu.
 802  *
 803  * Returns: (transfer none): a #GMenuModel or %NULL.
 804  *
 805  * Since: 3.6
 806  */
 807 GMenuModel *
 808 gtk_menu_button_get_menu_model (GtkMenuButton *menu_button)
 809 {
 810   g_return_val_if_fail (GTK_IS_MENU_BUTTON (menu_button), NULL);
 811
 812   return menu_button->priv->model;
 813 }
 814
 815 /**
 816  * gtk_menu_button_set_align_widget:
 817  * @menu_button: a #GtkMenuButton
 818  * @align_widget: (allow-none): a #GtkWidget
 819  *
 820  * Sets the #GtkWidget to use to line the menu with when popped up. Note that
 821  * the @align_widget must contain the #GtkMenuButton itself.
 822  *
 823  * Setting it to %NULL means that the popup menu will be aligned with the
 824  * button itself.
 825  *
 826  * Since: 3.6
 827  */
 828 void
 829 gtk_menu_button_set_align_widget (GtkMenuButton *menu_button,
 830                                   GtkWidget     *align_widget)
 831 {
 832   GtkMenuButtonPrivate *priv;
 833
 834   g_return_if_fail (GTK_IS_MENU_BUTTON (menu_button));
 835   g_return_if_fail (align_widget == NULL || gtk_widget_is_ancestor (GTK_WIDGET (menu_button), align_widget));
 836
 837   priv = menu_button->priv;
 838   if (priv->align_widget == align_widget)
 839     return;
 840
 841   priv->align_widget = align_widget;
 842
 843   if (priv->align_widget)
 844     g_object_add_weak_pointer (G_OBJECT (priv->align_widget), (gpointer *) &priv->align_widget);
 845
 846   g_object_notify (G_OBJECT (menu_button), "align-widget");
 847 }
 848
 849 /**
 850  * gtk_menu_button_get_align_widget:
 851  * @menu_button: a #GtkMenuButton
 852  *
 853  * Returns the parent #GtkWidget to use to line up with menu.
 854  *
 855  * Returns: (transfer none): a #GtkWidget value or %NULL.
 856  *
 857  * Since: 3.6
 858  */
 859 GtkWidget *
 860 gtk_menu_button_get_align_widget (GtkMenuButton *menu_button)
 861 {
 862   g_return_val_if_fail (GTK_IS_MENU_BUTTON (menu_button), NULL);
 863
 864   return menu_button->priv->align_widget;
 865 }
 866
 867 /**
 868  * gtk_menu_button_set_direction:
 869  * @menu_button: a #GtkMenuButton
 870  * @direction: a #GtkArrowType
 871  *
 872  * Sets the direction in which the menu will be popped up, as
 873  * well as changing the arrow's direction. The child will not
 874  * be changed to an arrow if it was customized.
 875  *
 876  * If the menu when popped out would have collided with screen edges,
 877  * we will do our best to keep it inside the screen and fully visible.
 878  *
 879  * If you pass GTK_ARROW_NONE for a @direction, the menu will behave
 880  * as if you passed GTK_ARROW_DOWN (although you won't see any arrows).
 881  *
 882  * Since: 3.6
 883  */
 884 void
 885 gtk_menu_button_set_direction (GtkMenuButton *menu_button,
 886                                GtkArrowType   direction)
 887 {
 888   GtkMenuButtonPrivate *priv = menu_button->priv;
 889   GtkWidget *child;
 890
 891   g_return_if_fail (GTK_IS_MENU_BUTTON (menu_button));
 892
 893   if (priv->arrow_type == direction)
 894     return;
 895
 896   priv->arrow_type = direction;
 897
 898   /* Is it custom content? We don't change that */
 899   child = gtk_bin_get_child (GTK_BIN (menu_button));
 900   if (priv->arrow_widget != child)
 901     return;
 902
 903   gtk_arrow_set (GTK_ARROW (child), priv->arrow_type, GTK_SHADOW_NONE);
 904 }
 905
 906 /**
 907  * gtk_menu_button_get_direction:
 908  * @menu_button: a #GtkMenuButton
 909  *
 910  * Returns the direction the menu will be pointing at when popped up.
 911  *
 912  * Returns: a #GtkArrowType value.
 913  *
 914  * Since: 3.6
 915  */
 916 GtkArrowType
 917 gtk_menu_button_get_direction (GtkMenuButton *menu_button)
 918 {
 919   g_return_val_if_fail (GTK_IS_MENU_BUTTON (menu_button), GTK_ARROW_DOWN);
 920
 921   return menu_button->priv->arrow_type;
 922 }
 923
 924 static void
 925 gtk_menu_button_dispose (GObject *object)
 926 {
 927   GtkMenuButtonPrivate *priv = GTK_MENU_BUTTON (object)->priv;
 928
 929   if (priv->popup)
 930     {
 931       g_signal_handlers_disconnect_by_func (priv->popup,
 932                                             menu_deactivate_cb,
 933                                             object);
 934       gtk_menu_detach (GTK_MENU (priv->popup));
 935     }
 936
 937   g_clear_object (&priv->model);
 938
 939   G_OBJECT_CLASS (gtk_menu_button_parent_class)->dispose (object);
 940 }