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   SHOW_MENU,
  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[SHOW_MENU] =
 236     g_signal_new ("show-menu",
 237                   G_OBJECT_CLASS_TYPE (klass),
 238                   G_SIGNAL_RUN_FIRST,
 239                   G_STRUCT_OFFSET (GtkMenuToolButtonClass, show_menu),
 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 *other;
 262   GtkStateType state = GTK_WIDGET_STATE (widget);
 263
 264   priv = GTK_MENU_TOOL_BUTTON_GET_PRIVATE (button);
 265
 266   other = (widget == priv->arrow_button) ? priv->button : priv->arrow_button;
 267
 268   g_signal_handlers_block_by_func (G_OBJECT (other),
 269                                    G_CALLBACK (button_state_changed_cb),
 270                                    button);
 271
 272   if (state == GTK_STATE_PRELIGHT)
 273     {
 274       gtk_widget_set_state (other, state);
 275     }
 276   else if (state == GTK_STATE_NORMAL)
 277     {
 278       gtk_widget_set_state (other, state);
 279     }
 280   else if (state == GTK_STATE_ACTIVE)
 281     {
 282       gtk_widget_set_state (other, GTK_STATE_NORMAL);
 283     }
 284
 285   g_signal_handlers_unblock_by_func (G_OBJECT (other),
 286                                      G_CALLBACK (button_state_changed_cb),
 287                                      button);
 288 }
 289
 290 static void
 291 menu_position_func (GtkMenu           *menu,
 292                     int               *x,
 293                     int               *y,
 294                     gboolean          *push_in,
 295                     GtkMenuToolButton *button)
 296 {
 297   GtkMenuToolButtonPrivate *priv;
 298   GtkRequisition req;
 299   GtkRequisition menu_req;
 300   GtkOrientation orientation;
 301   GtkTextDirection direction;
 302
 303   priv = GTK_MENU_TOOL_BUTTON_GET_PRIVATE (button);
 304
 305   gdk_window_get_origin (GTK_BUTTON (priv->arrow_button)->event_window, x, y);
 306   gtk_widget_size_request (priv->arrow_button, &req);
 307   gtk_widget_size_request (GTK_WIDGET (priv->menu), &menu_req);
 308
 309   orientation = gtk_tool_item_get_orientation (GTK_TOOL_ITEM (button));
 310   direction = gtk_widget_get_direction (GTK_WIDGET (priv->arrow_button));
 311
 312   if (orientation == GTK_ORIENTATION_HORIZONTAL)
 313     {
 314       if (direction == GTK_TEXT_DIR_LTR)
 315         *x += priv->arrow_button->allocation.width - req.width;
 316       else
 317         *x += req.width - menu_req.width;
 318       *y += priv->arrow_button->allocation.height;
 319     }
 320   else
 321     {
 322       if (direction == GTK_TEXT_DIR_LTR)
 323         *x += priv->arrow_button->allocation.width;
 324       else
 325         *x -= menu_req.width;
 326       *y += priv->arrow_button->allocation.height - req.height;
 327     }
 328
 329   *push_in = TRUE;
 330 }
 331
 332 static void
 333 popup_menu_under_arrow (GtkMenuToolButton *button,
 334                         GdkEventButton    *event)
 335 {
 336   GtkMenuToolButtonPrivate *priv;
 337
 338   priv = GTK_MENU_TOOL_BUTTON_GET_PRIVATE (button);
 339
 340   g_signal_emit (button, signals[SHOW_MENU], 0);
 341
 342   if (!priv->menu)
 343     return;
 344
 345   gtk_menu_popup (priv->menu, NULL, NULL,
 346                   (GtkMenuPositionFunc) menu_position_func,
 347                   button,
 348                   event ? event->button : 0,
 349                   event ? event->time : gtk_get_current_event_time ());
 350 }
 351
 352 static void
 353 arrow_button_toggled_cb (GtkToggleButton   *togglebutton,
 354                          GtkMenuToolButton *button)
 355 {
 356   GtkMenuToolButtonPrivate *priv;
 357
 358   priv = GTK_MENU_TOOL_BUTTON_GET_PRIVATE (button);
 359
 360   if (!priv->menu)
 361     return;
 362
 363   if (gtk_toggle_button_get_active (togglebutton) &&
 364       !GTK_WIDGET_VISIBLE (priv->menu))
 365     {
 366       /* we get here only when the menu is activated by a key
 367        * press, so that we can select the first menu item */
 368       popup_menu_under_arrow (button, NULL);
 369       gtk_menu_shell_select_first (GTK_MENU_SHELL (priv->menu), FALSE);
 370     }
 371 }
 372
 373 static gboolean
 374 arrow_button_button_press_event_cb (GtkWidget         *widget,
 375                                     GdkEventButton    *event,
 376                                     GtkMenuToolButton *button)
 377 {
 378   popup_menu_under_arrow (button, event);
 379   gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (widget), TRUE);
 380
 381   return TRUE;
 382 }
 383
 384 static void
 385 gtk_menu_tool_button_init (GtkMenuToolButton *button)
 386 {
 387   GtkWidget *box;
 388   GtkWidget *arrow;
 389   GtkWidget *arrow_button;
 390   GtkWidget *real_button;
 391
 392   button->priv = GTK_MENU_TOOL_BUTTON_GET_PRIVATE (button);
 393
 394   gtk_tool_item_set_homogeneous (GTK_TOOL_ITEM (button), FALSE);
 395
 396   box = gtk_hbox_new (FALSE, 0);
 397
 398   real_button = GTK_BIN (button)->child;
 399   g_object_ref (real_button);
 400   gtk_container_remove (GTK_CONTAINER (button), real_button);
 401   gtk_container_add (GTK_CONTAINER (box), real_button);
 402   g_object_unref (real_button);
 403
 404   arrow_button = gtk_toggle_button_new ();
 405   arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_NONE);
 406   gtk_button_set_relief (GTK_BUTTON (arrow_button), GTK_RELIEF_NONE);
 407   gtk_container_add (GTK_CONTAINER (arrow_button), arrow);
 408   gtk_box_pack_end (GTK_BOX (box), arrow_button,
 409                     FALSE, FALSE, 0);
 410
 411   /* the arrow button is insentive until we set a menu */
 412   gtk_widget_set_sensitive (arrow_button, FALSE);
 413
 414   gtk_widget_show_all (box);
 415
 416   gtk_container_add (GTK_CONTAINER (button), box);
 417
 418   button->priv->button = real_button;
 419   button->priv->arrow = arrow;
 420   button->priv->arrow_button = arrow_button;
 421   button->priv->box = box;
 422
 423   g_signal_connect (real_button, "state_changed",
 424                     G_CALLBACK (button_state_changed_cb), button);
 425   g_signal_connect (arrow_button, "state_changed",
 426                     G_CALLBACK (button_state_changed_cb), button);
 427   g_signal_connect (arrow_button, "toggled",
 428                     G_CALLBACK (arrow_button_toggled_cb), button);
 429   g_signal_connect (arrow_button, "button_press_event",
 430                     G_CALLBACK (arrow_button_button_press_event_cb), button);
 431 }
 432
 433 static void
 434 gtk_menu_tool_button_finalize (GObject *object)
 435 {
 436   GtkMenuToolButton *button;
 437
 438   button = GTK_MENU_TOOL_BUTTON (object);
 439
 440   if (button->priv->menu)
 441     g_object_unref (button->priv->menu);
 442
 443   G_OBJECT_CLASS (parent_class)->finalize (object);
 444 }
 445
 446 /**
 447  * gtk_menu_tool_button_new:
 448  * @icon_widget: a widget that will be used as icon widget, or %NULL
 449  * @label: a string that will be used as label, or %NULL
 450  *
 451  * Creates a new #GtkMenuToolButton using @icon_widget as icon and
 452  * @label as label.
 453  *
 454  * Return value: the new #GtkMenuToolButton
 455  *
 456  * Since: 2.6
 457  **/
 458 GtkToolItem *
 459 gtk_menu_tool_button_new (GtkWidget   *icon_widget,
 460                           const gchar *label)
 461 {
 462   GtkMenuToolButton *button;
 463
 464   button = g_object_new (GTK_TYPE_MENU_TOOL_BUTTON, NULL);
 465
 466   if (label)
 467     gtk_tool_button_set_label (GTK_TOOL_BUTTON (button), label);
 468
 469   if (icon_widget)
 470     gtk_tool_button_set_icon_widget (GTK_TOOL_BUTTON (button), icon_widget);
 471
 472   return GTK_TOOL_ITEM (button);
 473 }
 474
 475 /**
 476  * gtk_menu_tool_button_new_from_stock:
 477  * @stock_id: the name of a stock item
 478  *
 479  * Creates a new #GtkMenuToolButton.
 480  * The new #GtkMenuToolButton will contain an icon and label from
 481  * the stock item indicated by @stock_id.
 482  *
 483  * Return value: the new #GtkMenuToolButton
 484  *
 485  * Since: 2.6
 486  **/
 487 GtkToolItem *
 488 gtk_menu_tool_button_new_from_stock (const gchar *stock_id)
 489 {
 490   GtkMenuToolButton *button;
 491
 492   g_return_val_if_fail (stock_id != NULL, NULL);
 493
 494   button = g_object_new (GTK_TYPE_MENU_TOOL_BUTTON,
 495                          "stock_id", stock_id,
 496                          NULL);
 497
 498   return GTK_TOOL_ITEM (button);
 499 }
 500
 501 /* Callback for the "deactivate" signal on the pop-up menu.
 502  * This is used so that we unset the state of the toggle button
 503  * when the pop-up menu disappears.
 504  */
 505 static int
 506 menu_deactivate_cb (GtkMenuShell      *menu_shell,
 507                     GtkMenuToolButton *button)
 508 {
 509   GtkMenuToolButtonPrivate *priv = button->priv;
 510
 511   gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (priv->arrow_button), FALSE);
 512
 513   return TRUE;
 514 }
 515
 516 /**
 517  * gtk_menu_tool_button_set_menu:
 518  * @button: a #GtkMenuToolButton
 519  * @menu: the #GtkMenu associated with #GtkMenuToolButton
 520  *
 521  * Sets the #GtkMenu that is popped up when the user clicks on the arrow.
 522  * If @menu is NULL, the arrow button becomes insensitive.
 523  *
 524  * Since: 2.6
 525  **/
 526 void
 527 gtk_menu_tool_button_set_menu (GtkMenuToolButton *button,
 528                                GtkWidget         *menu)
 529 {
 530   GtkMenuToolButtonPrivate *priv;
 531
 532   g_return_if_fail (GTK_IS_MENU_TOOL_BUTTON (button));
 533   g_return_if_fail (GTK_IS_MENU (menu) || menu == NULL);
 534
 535   priv = button->priv;
 536
 537   if (priv->menu != GTK_MENU (menu))
 538     {
 539       if (priv->menu && GTK_WIDGET_VISIBLE (priv->menu))
 540         gtk_menu_shell_deactivate (GTK_MENU_SHELL (priv->menu));
 541
 542       if (priv->menu)
 543         g_object_unref (priv->menu);
 544
 545       priv->menu = GTK_MENU (menu);
 546
 547       if (priv->menu)
 548         {
 549           g_object_ref (priv->menu);
 550           gtk_object_sink (GTK_OBJECT (priv->menu));
 551
 552           gtk_widget_set_sensitive (priv->arrow_button, TRUE);
 553
 554           g_signal_connect (button->priv->menu, "deactivate",
 555                             G_CALLBACK (menu_deactivate_cb), button);
 556         }
 557       else
 558        gtk_widget_set_sensitive (priv->arrow_button, FALSE);
 559     }
 560
 561   g_object_notify (G_OBJECT (button), "menu");
 562 }
 563
 564 /**
 565  * gtk_menu_tool_button_get_menu:
 566  * @button: a #GtkMenuToolButton
 567  *
 568  * Gets the #GtkMenu associated with #GtkMenuToolButton.
 569  *
 570  * Return value: the #GtkMenu associated with #GtkMenuToolButton
 571  *
 572  * Since: 2.6
 573  **/
 574 GtkWidget *
 575 gtk_menu_tool_button_get_menu (GtkMenuToolButton *button)
 576 {
 577   g_return_val_if_fail (GTK_IS_MENU_TOOL_BUTTON (button), NULL);
 578
 579   return GTK_WIDGET (button->priv->menu);
 580 }
 581
 582 /**
 583  * gtk_menu_tool_set_arrow_tooltip:
 584  * @button: a #GtkMenuToolButton
 585  * @tooltips: the #GtkTooltips object to be used
 586  * @tip_text: text to be used as tooltip text for tool_item
 587  * @tip_private: text to be used as private tooltip text
 588  *
 589  * Sets the #GtkTooltips object to be used for arrow button which
 590  * pops up the menu. See gtk_tool_item_set_tooltip() for setting
 591  * a tooltip on the whole #GtkMenuToolButton.
 592  *
 593  * Since: 2.6
 594  **/
 595 void
 596 gtk_menu_tool_button_set_arrow_tooltip (GtkMenuToolButton *button,
 597                                         GtkTooltips       *tooltips,
 598                                         const gchar       *tip_text,
 599                                         const gchar       *tip_private)
 600 {
 601   g_return_if_fail (GTK_IS_MENU_TOOL_BUTTON (button));
 602
 603   gtk_tooltips_set_tip (tooltips, button->priv->arrow_button, tip_text, tip_private);
 604 }
 605