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

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GTK+ Team and others 1997-2001.  See the AUTHORS
  22  * file for a list of people on the GTK+ Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #include "config.h"
  28 #include "gtkcheckmenuitem.h"
  29 #include "gtkaccellabel.h"
  30 #include "gtkmarshalers.h"
  31 #include "gtkprivate.h"
  32 #include "gtkintl.h"
  33 #include "gtkalias.h"
  34
  35 enum {
  36   TOGGLED,
  37   LAST_SIGNAL
  38 };
  39
  40 enum {
  41   PROP_0,
  42   PROP_ACTIVE,
  43   PROP_INCONSISTENT,
  44   PROP_DRAW_AS_RADIO
  45 };
  46
  47 static gint gtk_check_menu_item_expose               (GtkWidget             *widget,
  48                                                       GdkEventExpose        *event);
  49 static void gtk_check_menu_item_activate             (GtkMenuItem           *menu_item);
  50 static void gtk_check_menu_item_toggle_size_request  (GtkMenuItem           *menu_item,
  51                                                       gint                  *requisition);
  52 static void gtk_check_menu_item_draw_indicator       (GtkCheckMenuItem      *check_menu_item,
  53                                                       GdkRectangle          *area);
  54 static void gtk_real_check_menu_item_draw_indicator  (GtkCheckMenuItem      *check_menu_item,
  55                                                       GdkRectangle          *area);
  56 static void gtk_check_menu_item_set_property (GObject         *object,
  57                                               guint            prop_id,
  58                                               const GValue    *value,
  59                                               GParamSpec      *pspec);
  60 static void gtk_check_menu_item_get_property (GObject         *object,
  61                                               guint            prop_id,
  62                                               GValue          *value,
  63                                               GParamSpec      *pspec);
  64
  65
  66 static guint check_menu_item_signals[LAST_SIGNAL] = { 0 };
  67
  68 G_DEFINE_TYPE (GtkCheckMenuItem, gtk_check_menu_item, GTK_TYPE_MENU_ITEM)
  69
  70 static void
  71 gtk_check_menu_item_class_init (GtkCheckMenuItemClass *klass)
  72 {
  73   GObjectClass *gobject_class;
  74   GtkWidgetClass *widget_class;
  75   GtkMenuItemClass *menu_item_class;
  76
  77   gobject_class = G_OBJECT_CLASS (klass);
  78   widget_class = (GtkWidgetClass*) klass;
  79   menu_item_class = (GtkMenuItemClass*) klass;
  80
  81   gobject_class->set_property = gtk_check_menu_item_set_property;
  82   gobject_class->get_property = gtk_check_menu_item_get_property;
  83
  84   g_object_class_install_property (gobject_class,
  85                                    PROP_ACTIVE,
  86                                    g_param_spec_boolean ("active",
  87                                                          P_("Active"),
  88                                                          P_("Whether the menu item is checked"),
  89                                                          FALSE,
  90                                                          GTK_PARAM_READWRITE));
  91
  92   g_object_class_install_property (gobject_class,
  93                                    PROP_INCONSISTENT,
  94                                    g_param_spec_boolean ("inconsistent",
  95                                                          P_("Inconsistent"),
  96                                                          P_("Whether to display an \"inconsistent\" state"),
  97                                                          FALSE,
  98                                                          GTK_PARAM_READWRITE));
  99
 100   g_object_class_install_property (gobject_class,
 101                                    PROP_DRAW_AS_RADIO,
 102                                    g_param_spec_boolean ("draw-as-radio",
 103                                                          P_("Draw as radio menu item"),
 104                                                          P_("Whether the menu item looks like a radio menu item"),
 105                                                          FALSE,
 106                                                          GTK_PARAM_READWRITE));
 107
 108   gtk_widget_class_install_style_property (widget_class,
 109                                            g_param_spec_int ("indicator-size",
 110                                                              P_("Indicator Size")
 111 ,
 112                                                              P_("Size of check or radio indicator"),
 113                                                              0,
 114                                                              G_MAXINT,
 115                                                              13,
 116                                                              GTK_PARAM_READABLE));
 117
 118   widget_class->expose_event = gtk_check_menu_item_expose;
 119
 120   menu_item_class->activate = gtk_check_menu_item_activate;
 121   menu_item_class->hide_on_activate = FALSE;
 122   menu_item_class->toggle_size_request = gtk_check_menu_item_toggle_size_request;
 123
 124   klass->toggled = NULL;
 125   klass->draw_indicator = gtk_real_check_menu_item_draw_indicator;
 126
 127   check_menu_item_signals[TOGGLED] =
 128     g_signal_new (I_("toggled"),
 129                   G_OBJECT_CLASS_TYPE (gobject_class),
 130                   G_SIGNAL_RUN_FIRST,
 131                   G_STRUCT_OFFSET (GtkCheckMenuItemClass, toggled),
 132                   NULL, NULL,
 133                   _gtk_marshal_VOID__VOID,
 134                   G_TYPE_NONE, 0);
 135 }
 136
 137 GtkWidget*
 138 gtk_check_menu_item_new (void)
 139 {
 140   return g_object_new (GTK_TYPE_CHECK_MENU_ITEM, NULL);
 141 }
 142
 143 GtkWidget*
 144 gtk_check_menu_item_new_with_label (const gchar *label)
 145 {
 146   GtkWidget *check_menu_item;
 147   GtkWidget *accel_label;
 148
 149   check_menu_item = gtk_check_menu_item_new ();
 150   accel_label = gtk_accel_label_new (label);
 151   gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
 152
 153   gtk_container_add (GTK_CONTAINER (check_menu_item), accel_label);
 154   gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label), check_menu_item);
 155   gtk_widget_show (accel_label);
 156
 157   return check_menu_item;
 158 }
 159
 160
 161 /**
 162  * gtk_check_menu_item_new_with_mnemonic:
 163  * @label: The text of the button, with an underscore in front of the
 164  *         mnemonic character
 165  * @returns: a new #GtkCheckMenuItem
 166  *
 167  * Creates a new #GtkCheckMenuItem containing a label. The label
 168  * will be created using gtk_label_new_with_mnemonic(), so underscores
 169  * in @label indicate the mnemonic for the menu item.
 170  **/
 171 GtkWidget*
 172 gtk_check_menu_item_new_with_mnemonic (const gchar *label)
 173 {
 174   GtkWidget *check_menu_item;
 175   GtkWidget *accel_label;
 176
 177   check_menu_item = gtk_check_menu_item_new ();
 178   accel_label = g_object_new (GTK_TYPE_ACCEL_LABEL, NULL);
 179   gtk_label_set_text_with_mnemonic (GTK_LABEL (accel_label), label);
 180   gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
 181
 182   gtk_container_add (GTK_CONTAINER (check_menu_item), accel_label);
 183   gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label), check_menu_item);
 184   gtk_widget_show (accel_label);
 185
 186   return check_menu_item;
 187 }
 188
 189 void
 190 gtk_check_menu_item_set_active (GtkCheckMenuItem *check_menu_item,
 191                                 gboolean          is_active)
 192 {
 193   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
 194
 195   is_active = is_active != 0;
 196
 197   if (check_menu_item->active != is_active)
 198     gtk_menu_item_activate (GTK_MENU_ITEM (check_menu_item));
 199 }
 200
 201 /**
 202  * gtk_check_menu_item_get_active:
 203  * @check_menu_item: a #GtkCheckMenuItem
 204  *
 205  * Returns whether the check menu item is active. See
 206  * gtk_check_menu_item_set_active ().
 207  *
 208  * Return value: %TRUE if the menu item is checked.
 209  */
 210 gboolean
 211 gtk_check_menu_item_get_active (GtkCheckMenuItem *check_menu_item)
 212 {
 213   g_return_val_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item), FALSE);
 214
 215   return check_menu_item->active;
 216 }
 217
 218 static void
 219 gtk_check_menu_item_toggle_size_request (GtkMenuItem *menu_item,
 220                                          gint        *requisition)
 221 {
 222   guint toggle_spacing;
 223   guint indicator_size;
 224
 225   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (menu_item));
 226
 227   gtk_widget_style_get (GTK_WIDGET (menu_item),
 228                         "toggle-spacing", &toggle_spacing,
 229                         "indicator-size", &indicator_size,
 230                         NULL);
 231
 232   *requisition = indicator_size + toggle_spacing;
 233 }
 234
 235 void
 236 gtk_check_menu_item_set_show_toggle (GtkCheckMenuItem *menu_item,
 237                                      gboolean          always)
 238 {
 239   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (menu_item));
 240
 241 #if 0
 242   menu_item->always_show_toggle = always != FALSE;
 243 #endif
 244 }
 245
 246 void
 247 gtk_check_menu_item_toggled (GtkCheckMenuItem *check_menu_item)
 248 {
 249   g_signal_emit (check_menu_item, check_menu_item_signals[TOGGLED], 0);
 250 }
 251
 252 /**
 253  * gtk_check_menu_item_set_inconsistent:
 254  * @check_menu_item: a #GtkCheckMenuItem
 255  * @setting: %TRUE to display an "inconsistent" third state check
 256  *
 257  * If the user has selected a range of elements (such as some text or
 258  * spreadsheet cells) that are affected by a boolean setting, and the
 259  * current values in that range are inconsistent, you may want to
 260  * display the check in an "in between" state. This function turns on
 261  * "in between" display.  Normally you would turn off the inconsistent
 262  * state again if the user explicitly selects a setting. This has to be
 263  * done manually, gtk_check_menu_item_set_inconsistent() only affects
 264  * visual appearance, it doesn't affect the semantics of the widget.
 265  *
 266  **/
 267 void
 268 gtk_check_menu_item_set_inconsistent (GtkCheckMenuItem *check_menu_item,
 269                                       gboolean          setting)
 270 {
 271   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
 272
 273   setting = setting != FALSE;
 274
 275   if (setting != check_menu_item->inconsistent)
 276     {
 277       check_menu_item->inconsistent = setting;
 278       gtk_widget_queue_draw (GTK_WIDGET (check_menu_item));
 279       g_object_notify (G_OBJECT (check_menu_item), "inconsistent");
 280     }
 281 }
 282
 283 /**
 284  * gtk_check_menu_item_get_inconsistent:
 285  * @check_menu_item: a #GtkCheckMenuItem
 286  *
 287  * Retrieves the value set by gtk_check_menu_item_set_inconsistent().
 288  *
 289  * Return value: %TRUE if inconsistent
 290  **/
 291 gboolean
 292 gtk_check_menu_item_get_inconsistent (GtkCheckMenuItem *check_menu_item)
 293 {
 294   g_return_val_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item), FALSE);
 295
 296   return check_menu_item->inconsistent;
 297 }
 298
 299 /**
 300  * gtk_check_menu_item_set_draw_as_radio:
 301  * @check_menu_item: a #GtkCheckMenuItem
 302  * @draw_as_radio: whether @check_menu_item is drawn like a #GtkRadioMenuItem
 303  *
 304  * Sets whether @check_menu_item is drawn like a #GtkRadioMenuItem
 305  *
 306  * Since: 2.4
 307  **/
 308 void
 309 gtk_check_menu_item_set_draw_as_radio (GtkCheckMenuItem *check_menu_item,
 310                                        gboolean          draw_as_radio)
 311 {
 312   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
 313
 314   draw_as_radio = draw_as_radio != FALSE;
 315
 316   if (draw_as_radio != check_menu_item->draw_as_radio)
 317     {
 318       check_menu_item->draw_as_radio = draw_as_radio;
 319
 320       gtk_widget_queue_draw (GTK_WIDGET (check_menu_item));
 321
 322       g_object_notify (G_OBJECT (check_menu_item), "draw-as-radio");
 323     }
 324 }
 325
 326 /**
 327  * gtk_check_menu_item_get_draw_as_radio:
 328  * @check_menu_item: a #GtkCheckMenuItem
 329  *
 330  * Returns whether @check_menu_item looks like a #GtkRadioMenuItem
 331  *
 332  * Return value: Whether @check_menu_item looks like a #GtkRadioMenuItem
 333  *
 334  * Since: 2.4
 335  **/
 336 gboolean
 337 gtk_check_menu_item_get_draw_as_radio (GtkCheckMenuItem *check_menu_item)
 338 {
 339   g_return_val_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item), FALSE);
 340
 341   return check_menu_item->draw_as_radio;
 342 }
 343
 344 static void
 345 gtk_check_menu_item_init (GtkCheckMenuItem *check_menu_item)
 346 {
 347   check_menu_item->active = FALSE;
 348   check_menu_item->always_show_toggle = TRUE;
 349 }
 350
 351 static gint
 352 gtk_check_menu_item_expose (GtkWidget      *widget,
 353                             GdkEventExpose *event)
 354 {
 355   if (GTK_WIDGET_CLASS (gtk_check_menu_item_parent_class)->expose_event)
 356     (* GTK_WIDGET_CLASS (gtk_check_menu_item_parent_class)->expose_event) (widget, event);
 357
 358   gtk_check_menu_item_draw_indicator (GTK_CHECK_MENU_ITEM (widget), &event->area);
 359
 360   return FALSE;
 361 }
 362
 363 static void
 364 gtk_check_menu_item_activate (GtkMenuItem *menu_item)
 365 {
 366   GtkCheckMenuItem *check_menu_item = GTK_CHECK_MENU_ITEM (menu_item);
 367   check_menu_item->active = !check_menu_item->active;
 368
 369   gtk_check_menu_item_toggled (check_menu_item);
 370   gtk_widget_queue_draw (GTK_WIDGET (check_menu_item));
 371
 372   g_object_notify (G_OBJECT (check_menu_item), "active");
 373 }
 374
 375 static void
 376 gtk_check_menu_item_draw_indicator (GtkCheckMenuItem *check_menu_item,
 377                                     GdkRectangle     *area)
 378 {
 379   if (GTK_CHECK_MENU_ITEM_GET_CLASS (check_menu_item)->draw_indicator)
 380     (* GTK_CHECK_MENU_ITEM_GET_CLASS (check_menu_item)->draw_indicator) (check_menu_item, area);
 381 }
 382
 383 static void
 384 gtk_real_check_menu_item_draw_indicator (GtkCheckMenuItem *check_menu_item,
 385                                          GdkRectangle     *area)
 386 {
 387   GtkWidget *widget;
 388   GtkStateType state_type;
 389   GtkShadowType shadow_type;
 390   gint x, y;
 391
 392   if (GTK_WIDGET_DRAWABLE (check_menu_item))
 393     {
 394       guint offset;
 395       guint toggle_size;
 396       guint toggle_spacing;
 397       guint horizontal_padding;
 398       guint indicator_size;
 399
 400       widget = GTK_WIDGET (check_menu_item);
 401
 402       gtk_widget_style_get (GTK_WIDGET (check_menu_item),
 403                             "toggle-spacing", &toggle_spacing,
 404                             "horizontal-padding", &horizontal_padding,
 405                             "indicator-size", &indicator_size,
 406                             NULL);
 407
 408       toggle_size = GTK_MENU_ITEM (check_menu_item)->toggle_size;
 409       offset = GTK_CONTAINER (check_menu_item)->border_width +
 410         widget->style->xthickness + 2;
 411
 412       if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR)
 413         {
 414           x = widget->allocation.x + offset + horizontal_padding +
 415             (toggle_size - toggle_spacing - indicator_size) / 2;
 416         }
 417       else
 418         {
 419           x = widget->allocation.x + widget->allocation.width -
 420             offset - horizontal_padding - toggle_size + toggle_spacing +
 421             (toggle_size - toggle_spacing - indicator_size) / 2;
 422         }
 423
 424       y = widget->allocation.y + (widget->allocation.height - indicator_size) / 2;
 425
 426       if (check_menu_item->active ||
 427           check_menu_item->always_show_toggle ||
 428           (GTK_WIDGET_STATE (check_menu_item) == GTK_STATE_PRELIGHT))
 429         {
 430           state_type = GTK_WIDGET_STATE (widget);
 431
 432           if (check_menu_item->inconsistent)
 433             shadow_type = GTK_SHADOW_ETCHED_IN;
 434           else if (check_menu_item->active)
 435             shadow_type = GTK_SHADOW_IN;
 436           else
 437             shadow_type = GTK_SHADOW_OUT;
 438
 439           if (!GTK_WIDGET_IS_SENSITIVE (widget))
 440             state_type = GTK_STATE_INSENSITIVE;
 441
 442           if (check_menu_item->draw_as_radio)
 443             {
 444               gtk_paint_option (widget->style, widget->window,
 445                                 state_type, shadow_type,
 446                                 area, widget, "option",
 447                                 x, y, indicator_size, indicator_size);
 448             }
 449           else
 450             {
 451               gtk_paint_check (widget->style, widget->window,
 452                                state_type, shadow_type,
 453                                area, widget, "check",
 454                                x, y, indicator_size, indicator_size);
 455             }
 456         }
 457     }
 458 }
 459
 460
 461 static void
 462 gtk_check_menu_item_get_property (GObject     *object,
 463                                   guint        prop_id,
 464                                   GValue      *value,
 465                                   GParamSpec  *pspec)
 466 {
 467   GtkCheckMenuItem *checkitem = GTK_CHECK_MENU_ITEM (object);
 468
 469   switch (prop_id)
 470     {
 471     case PROP_ACTIVE:
 472       g_value_set_boolean (value, checkitem->active);
 473       break;
 474     case PROP_INCONSISTENT:
 475       g_value_set_boolean (value, checkitem->inconsistent);
 476       break;
 477     case PROP_DRAW_AS_RADIO:
 478       g_value_set_boolean (value, checkitem->draw_as_radio);
 479       break;
 480     default:
 481       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 482       break;
 483     }
 484 }
 485
 486
 487 static void
 488 gtk_check_menu_item_set_property (GObject      *object,
 489                                   guint         prop_id,
 490                                   const GValue *value,
 491                                   GParamSpec   *pspec)
 492 {
 493   GtkCheckMenuItem *checkitem = GTK_CHECK_MENU_ITEM (object);
 494
 495   switch (prop_id)
 496     {
 497     case PROP_ACTIVE:
 498       gtk_check_menu_item_set_active (checkitem, g_value_get_boolean (value));
 499       break;
 500     case PROP_INCONSISTENT:
 501       gtk_check_menu_item_set_inconsistent (checkitem, g_value_get_boolean (value));
 502       break;
 503     case PROP_DRAW_AS_RADIO:
 504       gtk_check_menu_item_set_draw_as_radio (checkitem, g_value_get_boolean (value));
 505       break;
 506     default:
 507       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 508       break;
 509     }
 510 }
 511
 512 #define __GTK_CHECK_MENU_ITEM_C__
 513 #include "gtkaliasdef.c"