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 "gtkintl.h"
  31 #include "gtkmarshalers.h"
  32
  33 enum {
  34   TOGGLED,
  35   LAST_SIGNAL
  36 };
  37
  38 enum {
  39   PROP_0,
  40   PROP_ACTIVE,
  41   PROP_INCONSISTENT,
  42   PROP_DRAW_AS_RADIO
  43 };
  44
  45 static void gtk_check_menu_item_class_init           (GtkCheckMenuItemClass *klass);
  46 static void gtk_check_menu_item_init                 (GtkCheckMenuItem      *check_menu_item);
  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 GtkMenuItemClass *parent_class = NULL;
  67 static guint check_menu_item_signals[LAST_SIGNAL] = { 0 };
  68
  69
  70 GType
  71 gtk_check_menu_item_get_type (void)
  72 {
  73   static GType check_menu_item_type = 0;
  74
  75   if (!check_menu_item_type)
  76     {
  77       static const GTypeInfo check_menu_item_info =
  78       {
  79         sizeof (GtkCheckMenuItemClass),
  80         NULL,           /* base_init */
  81         NULL,           /* base_finalize */
  82         (GClassInitFunc) gtk_check_menu_item_class_init,
  83         NULL,           /* class_finalize */
  84         NULL,           /* class_data */
  85         sizeof (GtkCheckMenuItem),
  86         0,              /* n_preallocs */
  87         (GInstanceInitFunc) gtk_check_menu_item_init,
  88       };
  89
  90       check_menu_item_type =
  91         g_type_register_static (GTK_TYPE_MENU_ITEM, "GtkCheckMenuItem",
  92                                 &check_menu_item_info, 0);
  93     }
  94
  95   return check_menu_item_type;
  96 }
  97
  98 static void
  99 gtk_check_menu_item_class_init (GtkCheckMenuItemClass *klass)
 100 {
 101   GObjectClass *gobject_class;
 102   GtkWidgetClass *widget_class;
 103   GtkMenuItemClass *menu_item_class;
 104
 105   gobject_class = G_OBJECT_CLASS (klass);
 106   widget_class = (GtkWidgetClass*) klass;
 107   menu_item_class = (GtkMenuItemClass*) klass;
 108
 109   parent_class = g_type_class_peek_parent (klass);
 110
 111   gobject_class->set_property = gtk_check_menu_item_set_property;
 112   gobject_class->get_property = gtk_check_menu_item_get_property;
 113
 114   g_object_class_install_property (gobject_class,
 115                                    PROP_ACTIVE,
 116                                    g_param_spec_boolean ("active",
 117                                                          P_("Active"),
 118                                                          P_("Whether the menu item is checked"),
 119                                                          FALSE,
 120                                                          G_PARAM_READWRITE));
 121
 122   g_object_class_install_property (gobject_class,
 123                                    PROP_INCONSISTENT,
 124                                    g_param_spec_boolean ("inconsistent",
 125                                                          P_("Inconsistent"),
 126                                                          P_("Whether to display an \"inconsistent\" state"),
 127                                                          FALSE,
 128                                                          G_PARAM_READWRITE));
 129
 130   g_object_class_install_property (gobject_class,
 131                                    PROP_DRAW_AS_RADIO,
 132                                    g_param_spec_boolean ("draw_as_radio",
 133                                                          P_("Draw as radio menu item"),
 134                                                          P_("Whether the menu item looks like a radio menu item"),
 135                                                          FALSE,
 136                                                          G_PARAM_READWRITE));
 137
 138   gtk_widget_class_install_style_property (widget_class,
 139                                            g_param_spec_int ("indicator_size",
 140                                                              P_("Indicator Size")
 141 ,
 142                                                              P_("Size of check or radio indicator"),
 143                                                              0,
 144                                                              G_MAXINT,
 145                                                              12,
 146                                                              G_PARAM_READABLE));
 147
 148   widget_class->expose_event = gtk_check_menu_item_expose;
 149
 150   menu_item_class->activate = gtk_check_menu_item_activate;
 151   menu_item_class->hide_on_activate = FALSE;
 152   menu_item_class->toggle_size_request = gtk_check_menu_item_toggle_size_request;
 153
 154   klass->toggled = NULL;
 155   klass->draw_indicator = gtk_real_check_menu_item_draw_indicator;
 156
 157   check_menu_item_signals[TOGGLED] =
 158     g_signal_new ("toggled",
 159                   G_OBJECT_CLASS_TYPE (gobject_class),
 160                   G_SIGNAL_RUN_FIRST,
 161                   G_STRUCT_OFFSET (GtkCheckMenuItemClass, toggled),
 162                   NULL, NULL,
 163                   _gtk_marshal_VOID__VOID,
 164                   G_TYPE_NONE, 0);
 165 }
 166
 167 GtkWidget*
 168 gtk_check_menu_item_new (void)
 169 {
 170   return g_object_new (GTK_TYPE_CHECK_MENU_ITEM, NULL);
 171 }
 172
 173 GtkWidget*
 174 gtk_check_menu_item_new_with_label (const gchar *label)
 175 {
 176   GtkWidget *check_menu_item;
 177   GtkWidget *accel_label;
 178
 179   check_menu_item = gtk_check_menu_item_new ();
 180   accel_label = gtk_accel_label_new (label);
 181   gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
 182
 183   gtk_container_add (GTK_CONTAINER (check_menu_item), accel_label);
 184   gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label), check_menu_item);
 185   gtk_widget_show (accel_label);
 186
 187   return check_menu_item;
 188 }
 189
 190
 191 /**
 192  * gtk_check_menu_item_new_with_mnemonic:
 193  * @label: The text of the button, with an underscore in front of the
 194  *         mnemonic character
 195  * @returns: a new #GtkCheckMenuItem
 196  *
 197  * Creates a new #GtkCheckMenuItem containing a label. The label
 198  * will be created using gtk_label_new_with_mnemonic(), so underscores
 199  * in @label indicate the mnemonic for the menu item.
 200  **/
 201 GtkWidget*
 202 gtk_check_menu_item_new_with_mnemonic (const gchar *label)
 203 {
 204   GtkWidget *check_menu_item;
 205   GtkWidget *accel_label;
 206
 207   check_menu_item = gtk_check_menu_item_new ();
 208   accel_label = g_object_new (GTK_TYPE_ACCEL_LABEL, NULL);
 209   gtk_label_set_text_with_mnemonic (GTK_LABEL (accel_label), label);
 210   gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
 211
 212   gtk_container_add (GTK_CONTAINER (check_menu_item), accel_label);
 213   gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label), check_menu_item);
 214   gtk_widget_show (accel_label);
 215
 216   return check_menu_item;
 217 }
 218
 219 void
 220 gtk_check_menu_item_set_active (GtkCheckMenuItem *check_menu_item,
 221                                 gboolean          is_active)
 222 {
 223   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
 224
 225   is_active = is_active != 0;
 226
 227   if (check_menu_item->active != is_active)
 228     gtk_menu_item_activate (GTK_MENU_ITEM (check_menu_item));
 229 }
 230
 231 /**
 232  * gtk_check_menu_item_get_active:
 233  * @check_menu_item: a #GtkCheckMenuItem
 234  *
 235  * Returns whether the check menu item is active. See
 236  * gtk_check_menu_item_set_active ().
 237  *
 238  * Return value: %TRUE if the menu item is checked.
 239  */
 240 gboolean
 241 gtk_check_menu_item_get_active (GtkCheckMenuItem *check_menu_item)
 242 {
 243   g_return_val_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item), FALSE);
 244
 245   return check_menu_item->active;
 246 }
 247
 248 static void
 249 gtk_check_menu_item_toggle_size_request (GtkMenuItem *menu_item,
 250                                          gint        *requisition)
 251 {
 252   guint toggle_spacing;
 253   guint indicator_size;
 254
 255   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (menu_item));
 256
 257   gtk_widget_style_get (GTK_WIDGET (menu_item),
 258                         "toggle_spacing", &toggle_spacing,
 259                         "indicator_size", &indicator_size,
 260                         NULL);
 261
 262   *requisition = indicator_size + toggle_spacing;
 263 }
 264
 265 void
 266 gtk_check_menu_item_set_show_toggle (GtkCheckMenuItem *menu_item,
 267                                      gboolean          always)
 268 {
 269   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (menu_item));
 270
 271 #if 0
 272   menu_item->always_show_toggle = always != FALSE;
 273 #endif
 274 }
 275
 276 void
 277 gtk_check_menu_item_toggled (GtkCheckMenuItem *check_menu_item)
 278 {
 279   g_signal_emit (check_menu_item, check_menu_item_signals[TOGGLED], 0);
 280 }
 281
 282 /**
 283  * gtk_check_menu_item_set_inconsistent:
 284  * @check_menu_item: a #GtkCheckMenuItem
 285  * @setting: %TRUE to display an "inconsistent" third state check
 286  *
 287  * If the user has selected a range of elements (such as some text or
 288  * spreadsheet cells) that are affected by a boolean setting, and the
 289  * current values in that range are inconsistent, you may want to
 290  * display the check in an "in between" state. This function turns on
 291  * "in between" display.  Normally you would turn off the inconsistent
 292  * state again if the user explicitly selects a setting. This has to be
 293  * done manually, gtk_check_menu_item_set_inconsistent() only affects
 294  * visual appearance, it doesn't affect the semantics of the widget.
 295  *
 296  **/
 297 void
 298 gtk_check_menu_item_set_inconsistent (GtkCheckMenuItem *check_menu_item,
 299                                       gboolean          setting)
 300 {
 301   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
 302
 303   setting = setting != FALSE;
 304
 305   if (setting != check_menu_item->inconsistent)
 306     {
 307       check_menu_item->inconsistent = setting;
 308       gtk_widget_queue_draw (GTK_WIDGET (check_menu_item));
 309       g_object_notify (G_OBJECT (check_menu_item), "inconsistent");
 310     }
 311 }
 312
 313 /**
 314  * gtk_check_menu_item_get_inconsistent:
 315  * @check_menu_item: a #GtkCheckMenuItem
 316  *
 317  * Retrieves the value set by gtk_check_menu_item_set_inconsistent().
 318  *
 319  * Return value: %TRUE if inconsistent
 320  **/
 321 gboolean
 322 gtk_check_menu_item_get_inconsistent (GtkCheckMenuItem *check_menu_item)
 323 {
 324   g_return_val_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item), FALSE);
 325
 326   return check_menu_item->inconsistent;
 327 }
 328
 329 /**
 330  * gtk_check_menu_item_set_draw_as_radio:
 331  * @check_menu_item: a #GtkCheckMenuItem
 332  * @draw_as_radio: whether @check_menu_item is drawn like a #GtkRadioMenuItem
 333  *
 334  * Sets whether @check_menu_item is drawn like a #GtkRadioMenuItem
 335  *
 336  * Since: 2.4
 337  **/
 338 void
 339 gtk_check_menu_item_set_draw_as_radio (GtkCheckMenuItem *check_menu_item,
 340                                        gboolean          draw_as_radio)
 341 {
 342   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
 343
 344   draw_as_radio = draw_as_radio != FALSE;
 345
 346   if (draw_as_radio != check_menu_item->draw_as_radio)
 347     {
 348       check_menu_item->draw_as_radio = draw_as_radio;
 349
 350       gtk_widget_queue_draw (GTK_WIDGET (check_menu_item));
 351
 352       g_object_notify (G_OBJECT (check_menu_item), "draw_as_radio");
 353     }
 354 }
 355
 356 /**
 357  * gtk_check_menu_item_get_draw_as_radio:
 358  * @check_menu_item: a #GtkCheckMenuItem
 359  *
 360  * Returns whether @check_menu_item looks like a #GtkRadioMenuItem
 361  *
 362  * Return value: Whether @check_menu_item looks like a #GtkRadioMenuItem
 363  *
 364  * Since: 2.4
 365  **/
 366 gboolean
 367 gtk_check_menu_item_get_draw_as_radio (GtkCheckMenuItem *check_menu_item)
 368 {
 369   g_return_val_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item), FALSE);
 370
 371   return check_menu_item->draw_as_radio;
 372 }
 373
 374 static void
 375 gtk_check_menu_item_init (GtkCheckMenuItem *check_menu_item)
 376 {
 377   check_menu_item->active = FALSE;
 378   check_menu_item->always_show_toggle = TRUE;
 379 }
 380
 381 static gint
 382 gtk_check_menu_item_expose (GtkWidget      *widget,
 383                             GdkEventExpose *event)
 384 {
 385   if (GTK_WIDGET_CLASS (parent_class)->expose_event)
 386     (* GTK_WIDGET_CLASS (parent_class)->expose_event) (widget, event);
 387
 388   gtk_check_menu_item_draw_indicator (GTK_CHECK_MENU_ITEM (widget), &event->area);
 389
 390   return FALSE;
 391 }
 392
 393 static void
 394 gtk_check_menu_item_activate (GtkMenuItem *menu_item)
 395 {
 396   GtkCheckMenuItem *check_menu_item = GTK_CHECK_MENU_ITEM (menu_item);
 397   check_menu_item->active = !check_menu_item->active;
 398
 399   gtk_check_menu_item_toggled (check_menu_item);
 400   gtk_widget_queue_draw (GTK_WIDGET (check_menu_item));
 401
 402   g_object_notify (G_OBJECT (check_menu_item), "active");
 403 }
 404
 405 static void
 406 gtk_check_menu_item_draw_indicator (GtkCheckMenuItem *check_menu_item,
 407                                     GdkRectangle     *area)
 408 {
 409   if (GTK_CHECK_MENU_ITEM_GET_CLASS (check_menu_item)->draw_indicator)
 410     (* GTK_CHECK_MENU_ITEM_GET_CLASS (check_menu_item)->draw_indicator) (check_menu_item, area);
 411 }
 412
 413 static void
 414 gtk_real_check_menu_item_draw_indicator (GtkCheckMenuItem *check_menu_item,
 415                                          GdkRectangle     *area)
 416 {
 417   GtkWidget *widget;
 418   GtkStateType state_type;
 419   GtkShadowType shadow_type;
 420   gint x, y;
 421
 422   if (GTK_WIDGET_DRAWABLE (check_menu_item))
 423     {
 424       guint offset;
 425       guint toggle_size;
 426       guint toggle_spacing;
 427       guint horizontal_padding;
 428       guint indicator_size;
 429
 430       widget = GTK_WIDGET (check_menu_item);
 431
 432       gtk_widget_style_get (GTK_WIDGET (check_menu_item),
 433                             "toggle_spacing", &toggle_spacing,
 434                             "horizontal_padding", &horizontal_padding,
 435                             "indicator_size", &indicator_size,
 436                             NULL);
 437
 438       toggle_size = GTK_MENU_ITEM (check_menu_item)->toggle_size;
 439       offset = GTK_CONTAINER (check_menu_item)->border_width + widget->style->xthickness;
 440
 441       offset = GTK_CONTAINER (check_menu_item)->border_width +
 442         widget->style->xthickness + 2;
 443
 444       if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR)
 445         {
 446           x = widget->allocation.x + offset + horizontal_padding +
 447             (toggle_size - toggle_spacing - indicator_size) / 2;
 448         }
 449       else
 450         {
 451           x = widget->allocation.x + widget->allocation.width -
 452             offset - horizontal_padding - toggle_size + toggle_spacing +
 453             (toggle_size - toggle_spacing - indicator_size) / 2;
 454         }
 455
 456       y = widget->allocation.y + (widget->allocation.height - indicator_size) / 2;
 457
 458       if (check_menu_item->active ||
 459           check_menu_item->always_show_toggle ||
 460           (GTK_WIDGET_STATE (check_menu_item) == GTK_STATE_PRELIGHT))
 461         {
 462           state_type = GTK_WIDGET_STATE (widget);
 463
 464           if (check_menu_item->inconsistent)
 465             shadow_type = GTK_SHADOW_ETCHED_IN;
 466           else if (check_menu_item->active)
 467             shadow_type = GTK_SHADOW_IN;
 468           else
 469             shadow_type = GTK_SHADOW_OUT;
 470
 471           if (!GTK_WIDGET_IS_SENSITIVE (widget))
 472             state_type = GTK_STATE_INSENSITIVE;
 473
 474           if (check_menu_item->draw_as_radio)
 475             {
 476               gtk_paint_option (widget->style, widget->window,
 477                                 state_type, shadow_type,
 478                                 area, widget, "option",
 479                                 x, y, indicator_size, indicator_size);
 480             }
 481           else
 482             {
 483               gtk_paint_check (widget->style, widget->window,
 484                                state_type, shadow_type,
 485                                area, widget, "check",
 486                                x, y, indicator_size, indicator_size);
 487             }
 488         }
 489     }
 490 }
 491
 492
 493 static void
 494 gtk_check_menu_item_get_property (GObject     *object,
 495                                   guint        prop_id,
 496                                   GValue      *value,
 497                                   GParamSpec  *pspec)
 498 {
 499   GtkCheckMenuItem *checkitem = GTK_CHECK_MENU_ITEM (object);
 500
 501   switch (prop_id)
 502     {
 503     case PROP_ACTIVE:
 504       g_value_set_boolean (value, checkitem->active);
 505       break;
 506     case PROP_INCONSISTENT:
 507       g_value_set_boolean (value, checkitem->inconsistent);
 508       break;
 509     case PROP_DRAW_AS_RADIO:
 510       g_value_set_boolean (value, checkitem->draw_as_radio);
 511       break;
 512     default:
 513       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 514       break;
 515     }
 516 }
 517
 518
 519 static void
 520 gtk_check_menu_item_set_property (GObject      *object,
 521                                   guint         prop_id,
 522                                   const GValue *value,
 523                                   GParamSpec   *pspec)
 524 {
 525   GtkCheckMenuItem *checkitem = GTK_CHECK_MENU_ITEM (object);
 526
 527   switch (prop_id)
 528     {
 529     case PROP_ACTIVE:
 530       gtk_check_menu_item_set_active (checkitem, g_value_get_boolean (value));
 531       break;
 532     case PROP_INCONSISTENT:
 533       gtk_check_menu_item_set_inconsistent (checkitem, g_value_get_boolean (value));
 534       break;
 535     case PROP_DRAW_AS_RADIO:
 536       gtk_check_menu_item_set_draw_as_radio (checkitem, g_value_get_boolean (value));
 537       break;
 538     default:
 539       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 540       break;
 541     }
 542 }