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

   1 /* GTK - The GIMP Toolkit
   2  *
   3  * Copyright (C) 2003 Ricardo Fernandez Pascual
   4  * Copyright (C) 2004 Paolo Borelli
   5  *
   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.
  10  *
  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.
  15  *
  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.
  20  */
  21
  22 #include <config.h>
  23 #include "gtkalias.h"
  24 #include "gtkmenutoolbutton.h"
  25 #include "gtkintl.h"
  26 #include "gtktogglebutton.h"
  27 #include "gtkarrow.h"
  28 #include "gtkhbox.h"
  29 #include "gtkvbox.h"
  30 #include "gtkmenu.h"
  31 #include "gtkmain.h"
  32
  33
  34 #define GTK_MENU_TOOL_BUTTON_GET_PRIVATE(object)(G_TYPE_INSTANCE_GET_PRIVATE ((object), GTK_TYPE_MENU_TOOL_BUTTON, GtkMenuToolButtonPrivate))
  35
  36 struct _GtkMenuToolButtonPrivate
  37 {
  38   GtkWidget *button;
  39   GtkWidget *arrow;
  40   GtkWidget *arrow_button;
  41   GtkWidget *box;
  42   GtkMenu   *menu;
  43 };
  44
  45 static void gtk_menu_tool_button_init       (GtkMenuToolButton      *button);
  46 static void gtk_menu_tool_button_class_init (GtkMenuToolButtonClass *klass);
  47 static void gtk_menu_tool_button_finalize   (GObject                *object);
  48
  49 enum
  50 {
  51   MENU_ACTIVATED,
  52   LAST_SIGNAL
  53 };
  54
  55 enum
  56 {
  57   PROP_0,
  58   PROP_MENU,
  59   LAST_PROP
  60 };
  61
  62 static gint signals[LAST_SIGNAL];
  63
  64 static GObjectClass *parent_class = NULL;
  65
  66 GType
  67 gtk_menu_tool_button_get_type (void)
  68 {
  69   static GType type = 0;
  70
  71   if (type == 0)
  72     {
  73       static const GTypeInfo info =
  74         {
  75           sizeof (GtkMenuToolButtonClass),
  76           (GBaseInitFunc) 0,
  77           (GBaseFinalizeFunc) 0,
  78           (GClassInitFunc) gtk_menu_tool_button_class_init,
  79           (GClassFinalizeFunc) 0,
  80           NULL,
  81           sizeof (GtkMenuToolButton),
  82           0, /* n_preallocs */
  83           (GInstanceInitFunc) gtk_menu_tool_button_init
  84         };
  85
  86       type = g_type_register_static (GTK_TYPE_TOOL_BUTTON,
  87                                      "GtkMenuToolButton",
  88                                      &info, 0);
  89     }
  90
  91   return type;
  92 }
  93
  94 static gboolean
  95 gtk_menu_tool_button_set_tooltip (GtkToolItem *tool_item,
  96                                   GtkTooltips *tooltips,
  97                                   const char  *tip_text,
  98                                   const char  *tip_private)
  99 {
 100   GtkMenuToolButton *button;
 101
 102   g_return_val_if_fail (GTK_IS_MENU_TOOL_BUTTON (tool_item), FALSE);
 103
 104   button = GTK_MENU_TOOL_BUTTON (tool_item);
 105   gtk_tooltips_set_tip (tooltips, button->priv->button, tip_text, tip_private);
 106
 107   return TRUE;
 108 }
 109
 110 static void
 111 gtk_menu_tool_button_construct_contents (GtkMenuToolButton *button)
 112 {
 113   GtkMenuToolButtonPrivate *priv;
 114   GtkWidget *box;
 115   GtkOrientation orientation;
 116
 117   priv = GTK_MENU_TOOL_BUTTON_GET_PRIVATE (button);
 118
 119   orientation = gtk_tool_item_get_orientation (GTK_TOOL_ITEM (button));
 120
 121   if (orientation == GTK_ORIENTATION_HORIZONTAL)
 122     {
 123       box = gtk_hbox_new (FALSE, 0);
 124       gtk_arrow_set (GTK_ARROW (priv->arrow), GTK_ARROW_DOWN, GTK_SHADOW_NONE);
 125     }
 126   else
 127     {
 128       box = gtk_vbox_new (FALSE, 0);
 129       gtk_arrow_set (GTK_ARROW (priv->arrow), GTK_ARROW_RIGHT, GTK_SHADOW_NONE);
 130     }
 131
 132   if (priv->button && priv->button->parent)
 133     {
 134       g_object_ref (priv->button);
 135       gtk_container_remove (GTK_CONTAINER (priv->button->parent),
 136                             priv->button);
 137       gtk_container_add (GTK_CONTAINER (box), priv->button);
 138       g_object_unref (priv->button);
 139     }
 140
 141   if (priv->arrow_button && priv->arrow_button->parent)
 142     {
 143       g_object_ref (priv->arrow_button);
 144       gtk_container_remove (GTK_CONTAINER (priv->arrow_button->parent),
 145                             priv->arrow_button);
 146       gtk_box_pack_end (GTK_BOX (box), priv->arrow_button,
 147                         FALSE, FALSE, 0);
 148       g_object_unref (priv->arrow_button);
 149     }
 150
 151   if (priv->box)
 152     {
 153       /* Note: we are not destroying the button and the arrow_button
 154        * here because they were removed from their container above
 155        */
 156       gtk_widget_destroy (priv->box);
 157     }
 158
 159   priv->box = box;
 160
 161   gtk_container_add (GTK_CONTAINER (button), priv->box);
 162   gtk_widget_show_all (priv->box);
 163
 164   gtk_widget_queue_resize (GTK_WIDGET (button));
 165 }
 166
 167 static void
 168 gtk_menu_tool_button_toolbar_reconfigured (GtkToolItem *toolitem)
 169 {
 170   gtk_menu_tool_button_construct_contents (GTK_MENU_TOOL_BUTTON (toolitem));
 171
 172   /* chain up */
 173   GTK_TOOL_ITEM_CLASS (parent_class)->toolbar_reconfigured (toolitem);
 174 }
 175
 176 static void
 177 gtk_menu_tool_button_set_property (GObject      *object,
 178                                    guint         prop_id,
 179                                    const GValue *value,
 180                                    GParamSpec   *pspec)
 181 {
 182   GtkMenuToolButton *button = GTK_MENU_TOOL_BUTTON (object);
 183
 184   switch (prop_id)
 185     {
 186     case PROP_MENU:
 187       gtk_menu_tool_button_set_menu (button, g_value_get_object (value));
 188       break;
 189
 190     default:
 191       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 192       break;
 193     }
 194 }
 195
 196 static void
 197 gtk_menu_tool_button_get_property (GObject    *object,
 198                                    guint       prop_id,
 199                                    GValue     *value,
 200                                    GParamSpec *pspec)
 201 {
 202   GtkMenuToolButton *button = GTK_MENU_TOOL_BUTTON (object);
 203
 204   switch (prop_id)
 205     {
 206     case PROP_MENU:
 207       g_value_set_object (value, button->priv->menu);
 208       break;
 209
 210     default:
 211       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 212       break;
 213     }
 214 }
 215
 216 static void
 217 gtk_menu_tool_button_class_init (GtkMenuToolButtonClass *klass)
 218 {
 219   GObjectClass *object_class;
 220   GtkToolItemClass *toolitem_class;
 221   GtkToolButtonClass *toolbutton_class;
 222
 223   parent_class = g_type_class_peek_parent (klass);
 224
 225   object_class = (GObjectClass *)klass;
 226   toolitem_class = (GtkToolItemClass *)klass;
 227   toolbutton_class = (GtkToolButtonClass *)klass;
 228
 229   object_class->set_property = gtk_menu_tool_button_set_property;
 230   object_class->get_property = gtk_menu_tool_button_get_property;
 231   object_class->finalize = gtk_menu_tool_button_finalize;
 232   toolitem_class->set_tooltip = gtk_menu_tool_button_set_tooltip;
 233   toolitem_class->toolbar_reconfigured = gtk_menu_tool_button_toolbar_reconfigured;
 234
 235   signals[MENU_ACTIVATED] =
 236     g_signal_new ("menu-activated",
 237                   G_OBJECT_CLASS_TYPE (klass),
 238                   G_SIGNAL_RUN_FIRST,
 239                   G_STRUCT_OFFSET (GtkMenuToolButtonClass, menu_activated),
 240                   NULL, NULL,
 241                   g_cclosure_marshal_VOID__VOID,
 242                   G_TYPE_NONE, 0);
 243
 244   g_object_class_install_property (object_class,
 245                                    PROP_MENU,
 246                                    g_param_spec_object ("menu",
 247                                                         P_("Menu"),
 248                                                         P_("The dropdown menu"),
 249                                                         GTK_TYPE_MENU,
 250                                                         G_PARAM_READABLE | G_PARAM_WRITABLE));
 251
 252   g_type_class_add_private (object_class, sizeof (GtkMenuToolButtonPrivate));
 253 }
 254
 255 static void
 256 button_state_changed_cb (GtkWidget         *widget,
 257                          GtkStateType       previous_state,
 258                          GtkMenuToolButton *button)
 259 {
 260   GtkMenuToolButtonPrivate *priv;
 261   GtkWidget *b;
 262   GtkStateType state = GTK_WIDGET_STATE (widget);
 263
 264   priv = GTK_MENU_TOOL_BUTTON_GET_PRIVATE (button);
 265
 266   b = (widget == priv->arrow_button) ? priv->button : priv->arrow_button;
 267
 268   g_signal_handlers_block_by_func (G_OBJECT (b),
 269                                    G_CALLBACK (button_state_changed_cb),
 270                                    button);
 271
 272   if (state == GTK_STATE_PRELIGHT &&
 273       previous_state != GTK_STATE_ACTIVE)
 274     {
 275       gtk_widget_set_state (b, state);
 276     }
 277   else if (state == GTK_STATE_NORMAL)
 278     {
 279       gtk_widget_set_state (b, state);
 280     }
 281   else if (state == GTK_STATE_ACTIVE)
 282     {
 283       gtk_widget_set_state (b, GTK_STATE_NORMAL);
 284     }
 285
 286   g_signal_handlers_unblock_by_func (G_OBJECT (b),
 287                                      G_CALLBACK (button_state_changed_cb),
 288                                      button);
 289 }
 290
 291 static void
 292 menu_position_func (GtkMenu           *menu,
 293                     int               *x,
 294                     int               *y,
 295                     gboolean          *push_in,
 296                     GtkMenuToolButton *button)
 297 {
 298   GtkMenuToolButtonPrivate *priv;
 299   GtkRequisition req;
 300   GtkRequisition menu_req;
 301   GtkOrientation orientation;
 302   GtkTextDirection direction;
 303
 304   priv = GTK_MENU_TOOL_BUTTON_GET_PRIVATE (button);
 305
 306   gdk_window_get_origin (GTK_BUTTON (priv->arrow_button)->event_window, x, y);
 307   gtk_widget_size_request (priv->arrow_button, &req);
 308   gtk_widget_size_request (GTK_WIDGET (priv->menu), &menu_req);
 309
 310   orientation = gtk_tool_item_get_orientation (GTK_TOOL_ITEM (button));
 311   direction = gtk_widget_get_direction (GTK_WIDGET (priv->arrow_button));
 312
 313   if (orientation == GTK_ORIENTATION_HORIZONTAL)
 314     {
 315       if (direction == GTK_TEXT_DIR_LTR)
 316         *x += priv->arrow_button->allocation.width - req.width;
 317       else
 318         *x += req.width - menu_req.width;
 319       *y += priv->arrow_button->allocation.height;
 320     }
 321   else
 322     {
 323       if (direction == GTK_TEXT_DIR_LTR)
 324         *x += priv->arrow_button->allocation.width;
 325       else
 326         *x -= menu_req.width;
 327       *y += priv->arrow_button->allocation.height - req.height;
 328     }
 329
 330   *push_in = TRUE;
 331 }
 332
 333 static void
 334 popup_menu_under_arrow (GtkMenuToolButton *button,
 335                         GdkEventButton    *event)
 336 {
 337   GtkMenuToolButtonPrivate *priv;
 338
 339   priv = GTK_MENU_TOOL_BUTTON_GET_PRIVATE (button);
 340
 341   g_signal_emit (button, signals[MENU_ACTIVATED], 0);
 342
 343   if (!priv->menu)
 344     return;
 345
 346   gtk_menu_popup (priv->menu, NULL, NULL,
 347                   (GtkMenuPositionFunc) menu_position_func,
 348                   button,
 349                   event ? event->button : 0,
 350                   event ? event->time : gtk_get_current_event_time ());
 351 }
 352
 353 static void
 354 arrow_button_toggled_cb (GtkToggleButton   *togglebutton,
 355                          GtkMenuToolButton *button)
 356 {
 357   GtkMenuToolButtonPrivate *priv;
 358
 359   priv = GTK_MENU_TOOL_BUTTON_GET_PRIVATE (button);
 360
 361   if (!priv->menu)
 362     return;
 363
 364   if (gtk_toggle_button_get_active (togglebutton) &&
 365       !GTK_WIDGET_VISIBLE (priv->menu))
 366     {
 367       /* we get here only when the menu is activated by a key
 368        * press, so that we can select the first menu item */
 369       popup_menu_under_arrow (button, NULL);
 370       gtk_menu_shell_select_first (GTK_MENU_SHELL (priv->menu), FALSE);
 371     }
 372 }
 373
 374 static gboolean
 375 arrow_button_button_press_event_cb (GtkWidget         *widget,
 376                                     GdkEventButton    *event,
 377                                     GtkMenuToolButton *button)
 378 {
 379   popup_menu_under_arrow (button, event);
 380   gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (widget), TRUE);
 381
 382   return TRUE;
 383 }
 384
 385 static void
 386 gtk_menu_tool_button_init (GtkMenuToolButton *button)
 387 {
 388   GtkWidget *box;
 389   GtkWidget *arrow;
 390   GtkWidget *arrow_button;
 391   GtkWidget *real_button;
 392
 393   button->priv = GTK_MENU_TOOL_BUTTON_GET_PRIVATE (button);
 394
 395   gtk_tool_item_set_homogeneous (GTK_TOOL_ITEM (button), FALSE);
 396
 397   box = gtk_hbox_new (FALSE, 0);
 398
 399   real_button = GTK_BIN (button)->child;
 400   g_object_ref (real_button);
 401   gtk_container_remove (GTK_CONTAINER (button), real_button);
 402   gtk_container_add (GTK_CONTAINER (box), real_button);
 403   g_object_unref (real_button);
 404
 405   arrow_button = gtk_toggle_button_new ();
 406   arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_NONE);
 407   gtk_button_set_relief (GTK_BUTTON (arrow_button), GTK_RELIEF_NONE);
 408   gtk_container_add (GTK_CONTAINER (arrow_button), arrow);
 409   gtk_box_pack_end (GTK_BOX (box), arrow_button,
 410                     FALSE, FALSE, 0);
 411
 412   /* the arrow button is insentive until we set a menu */
 413   gtk_widget_set_sensitive (arrow_button, FALSE);
 414
 415   gtk_widget_show_all (box);
 416
 417   gtk_container_add (GTK_CONTAINER (button), box);
 418
 419   button->priv->button = real_button;
 420   button->priv->arrow = arrow;
 421   button->priv->arrow_button = arrow_button;
 422   button->priv->box = box;
 423
 424   g_signal_connect (real_button, "state_changed",
 425                     G_CALLBACK (button_state_changed_cb), button);
 426   g_signal_connect (arrow_button, "state_changed",
 427                     G_CALLBACK (button_state_changed_cb), button);
 428   g_signal_connect (arrow_button, "toggled",
 429                     G_CALLBACK (arrow_button_toggled_cb), button);
 430   g_signal_connect (arrow_button, "button_press_event",
 431                     G_CALLBACK (arrow_button_button_press_event_cb), button);
 432 }
 433
 434 static void
 435 gtk_menu_tool_button_finalize (GObject *object)
 436 {
 437   GtkMenuToolButton *button;
 438
 439   button = GTK_MENU_TOOL_BUTTON (object);
 440
 441   if (button->priv->menu)
 442     g_object_unref (button->priv->menu);
 443
 444   G_OBJECT_CLASS (parent_class)->finalize (object);
 445 }
 446
 447 /**
 448  * gtk_menu_tool_button_new:
 449  * @icon_widget: a widget that will be used as icon widget, or %NULL
 450  * @label: a string that will be used as label, or %NULL
 451  *
 452  * Creates a new #GtkMenuToolButton using @icon_widget as icon and
 453  * @label as label.
 454  *
 455  * Return value: the new #GtkMenuToolButton
 456  *
 457  * Since: 2.6
 458  **/
 459 GtkToolItem *
 460 gtk_menu_tool_button_new (GtkWidget   *icon_widget,
 461                           const gchar *label)
 462 {
 463   GtkMenuToolButton *button;
 464
 465   button = g_object_new (GTK_TYPE_MENU_TOOL_BUTTON, NULL);
 466
 467   if (label)
 468     gtk_tool_button_set_label (GTK_TOOL_BUTTON (button), label);
 469
 470   if (icon_widget)
 471     gtk_tool_button_set_icon_widget (GTK_TOOL_BUTTON (button), icon_widget);
 472
 473   return GTK_TOOL_ITEM (button);
 474 }
 475
 476 /**
 477  * gtk_menu_tool_button_new_from_stock:
 478  * @stock_id: the name of a stock item
 479  *
 480  * Creates a new #GtkMenuToolButton.
 481  * The new #GtkMenuToolButton will contain an icon and label from
 482  * the stock item indicated by @stock_id.
 483  *
 484  * Return value: the new #GtkMenuToolButton
 485  *
 486  * Since: 2.6
 487  **/
 488 GtkToolItem *
 489 gtk_menu_tool_button_new_from_stock (const gchar *stock_id)
 490 {
 491   GtkMenuToolButton *button;
 492
 493   g_return_val_if_fail (stock_id != NULL, NULL);
 494
 495   button = g_object_new (GTK_TYPE_MENU_TOOL_BUTTON,
 496                          "stock_id", stock_id,
 497                          NULL);
 498
 499   return GTK_TOOL_ITEM (button);
 500 }
 501
 502 /* Callback for the "deactivate" signal on the pop-up menu.
 503  * This is used so that we unset the state of the toggle button
 504  * when the pop-up menu disappears.
 505  */
 506 static int
 507 menu_deactivate_cb (GtkMenuShell      *menu_shell,
 508                     GtkMenuToolButton *button)
 509 {
 510   GtkMenuToolButtonPrivate *priv = button->priv;
 511
 512   gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (priv->arrow_button), FALSE);
 513
 514   return TRUE;
 515 }
 516
 517 /**
 518  * gtk_menu_tool_button_set_menu:
 519  * @button: a #GtkMenuToolButton
 520  * @menu: the #GtkMenu associated with #GtkMenuToolButton
 521  *
 522  * Sets the #GtkMenu that is popped up when the user clicks on the arrow.
 523  * If @menu is NULL, the arrow button becomes insensitive.
 524  *
 525  * Since: 2.6
 526  **/
 527 void
 528 gtk_menu_tool_button_set_menu (GtkMenuToolButton *button,
 529                                GtkWidget         *menu)
 530 {
 531   GtkMenuToolButtonPrivate *priv;
 532
 533   g_return_if_fail (GTK_IS_MENU_TOOL_BUTTON (button));
 534   g_return_if_fail (GTK_IS_MENU (menu) || menu == NULL);
 535
 536   priv = button->priv;
 537
 538   if (priv->menu != GTK_MENU (menu))
 539     {
 540       if (priv->menu && GTK_WIDGET_VISIBLE (priv->menu))
 541         gtk_menu_shell_deactivate (GTK_MENU_SHELL (priv->menu));
 542
 543       if (priv->menu)
 544         g_object_unref (priv->menu);
 545
 546       priv->menu = GTK_MENU (menu);
 547
 548       if (priv->menu)
 549         {
 550           g_object_ref (priv->menu);
 551           gtk_object_sink (GTK_OBJECT (priv->menu));
 552
 553           gtk_widget_set_sensitive (priv->arrow_button, TRUE);
 554
 555           g_signal_connect (button->priv->menu, "deactivate",
 556                             G_CALLBACK (menu_deactivate_cb), button);
 557         }
 558       else
 559        gtk_widget_set_sensitive (priv->arrow_button, FALSE);
 560     }
 561
 562   g_object_notify (G_OBJECT (button), "menu");
 563 }
 564
 565 /**
 566  * gtk_menu_tool_button_get_menu:
 567  * @button: a #GtkMenuToolButton
 568  * @menu: the #GtkMenu associated with #GtkMenuToolButton
 569  *
 570  * Gets the #GtkMenu associated with #GtkMenuToolButton.
 571  *
 572  * Return value: the #GtkMenu associated with #GtkMenuToolButton
 573  *
 574  * Since: 2.6
 575  **/
 576 GtkWidget *
 577 gtk_menu_tool_button_get_menu (GtkMenuToolButton *button)
 578 {
 579   g_return_val_if_fail (GTK_IS_MENU_TOOL_BUTTON (button), NULL);
 580
 581   return GTK_WIDGET (button->priv->menu);
 582 }
 583
 584 /**
 585  * gtk_menu_tool_set_arrow_tooltip:
 586  * @button: a #GtkMenuToolButton
 587  * @tooltips: the #GtkTooltips object to be used
 588  * @tip_text: text to be used as tooltip text for tool_item
 589  * @tip_private: text to be used as private tooltip text
 590  *
 591  * Sets the #GtkTooltips object to be used for arrow button which
 592  * pops up the menu. See gtk_tool_item_set_tooltip() for setting
 593  * a tooltip on the whole #GtkMenuToolButton.
 594  *
 595  * Since: 2.6
 596  **/
 597 void
 598 gtk_menu_tool_button_set_arrow_tooltip (GtkMenuToolButton *button,
 599                                         GtkTooltips       *tooltips,
 600                                         const gchar       *tip_text,
 601                                         const gchar       *tip_private)
 602 {
 603   g_return_if_fail (GTK_IS_MENU_TOOL_BUTTON (button));
 604
 605   gtk_tooltips_set_tip (tooltips, button->priv->arrow_button, tip_text, tip_private);
 606 }
 607