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   return g_object_new (GTK_TYPE_CHECK_MENU_ITEM,
 147                        "label", label,
 148                        NULL);
 149 }
 150
 151
 152 /**
 153  * gtk_check_menu_item_new_with_mnemonic:
 154  * @label: The text of the button, with an underscore in front of the
 155  *         mnemonic character
 156  * @returns: a new #GtkCheckMenuItem
 157  *
 158  * Creates a new #GtkCheckMenuItem containing a label. The label
 159  * will be created using gtk_label_new_with_mnemonic(), so underscores
 160  * in @label indicate the mnemonic for the menu item.
 161  **/
 162 GtkWidget*
 163 gtk_check_menu_item_new_with_mnemonic (const gchar *label)
 164 {
 165   return g_object_new (GTK_TYPE_CHECK_MENU_ITEM,
 166                        "label", label,
 167                        "use-underline", TRUE,
 168                        NULL);
 169 }
 170
 171 void
 172 gtk_check_menu_item_set_active (GtkCheckMenuItem *check_menu_item,
 173                                 gboolean          is_active)
 174 {
 175   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
 176
 177   is_active = is_active != 0;
 178
 179   if (check_menu_item->active != is_active)
 180     gtk_menu_item_activate (GTK_MENU_ITEM (check_menu_item));
 181 }
 182
 183 /**
 184  * gtk_check_menu_item_get_active:
 185  * @check_menu_item: a #GtkCheckMenuItem
 186  *
 187  * Returns whether the check menu item is active. See
 188  * gtk_check_menu_item_set_active ().
 189  *
 190  * Return value: %TRUE if the menu item is checked.
 191  */
 192 gboolean
 193 gtk_check_menu_item_get_active (GtkCheckMenuItem *check_menu_item)
 194 {
 195   g_return_val_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item), FALSE);
 196
 197   return check_menu_item->active;
 198 }
 199
 200 static void
 201 gtk_check_menu_item_toggle_size_request (GtkMenuItem *menu_item,
 202                                          gint        *requisition)
 203 {
 204   guint toggle_spacing;
 205   guint indicator_size;
 206
 207   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (menu_item));
 208
 209   gtk_widget_style_get (GTK_WIDGET (menu_item),
 210                         "toggle-spacing", &toggle_spacing,
 211                         "indicator-size", &indicator_size,
 212                         NULL);
 213
 214   *requisition = indicator_size + toggle_spacing;
 215 }
 216
 217 void
 218 gtk_check_menu_item_set_show_toggle (GtkCheckMenuItem *menu_item,
 219                                      gboolean          always)
 220 {
 221   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (menu_item));
 222
 223 #if 0
 224   menu_item->always_show_toggle = always != FALSE;
 225 #endif
 226 }
 227
 228 void
 229 gtk_check_menu_item_toggled (GtkCheckMenuItem *check_menu_item)
 230 {
 231   g_signal_emit (check_menu_item, check_menu_item_signals[TOGGLED], 0);
 232 }
 233
 234 /**
 235  * gtk_check_menu_item_set_inconsistent:
 236  * @check_menu_item: a #GtkCheckMenuItem
 237  * @setting: %TRUE to display an "inconsistent" third state check
 238  *
 239  * If the user has selected a range of elements (such as some text or
 240  * spreadsheet cells) that are affected by a boolean setting, and the
 241  * current values in that range are inconsistent, you may want to
 242  * display the check in an "in between" state. This function turns on
 243  * "in between" display.  Normally you would turn off the inconsistent
 244  * state again if the user explicitly selects a setting. This has to be
 245  * done manually, gtk_check_menu_item_set_inconsistent() only affects
 246  * visual appearance, it doesn't affect the semantics of the widget.
 247  *
 248  **/
 249 void
 250 gtk_check_menu_item_set_inconsistent (GtkCheckMenuItem *check_menu_item,
 251                                       gboolean          setting)
 252 {
 253   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
 254
 255   setting = setting != FALSE;
 256
 257   if (setting != check_menu_item->inconsistent)
 258     {
 259       check_menu_item->inconsistent = setting;
 260       gtk_widget_queue_draw (GTK_WIDGET (check_menu_item));
 261       g_object_notify (G_OBJECT (check_menu_item), "inconsistent");
 262     }
 263 }
 264
 265 /**
 266  * gtk_check_menu_item_get_inconsistent:
 267  * @check_menu_item: a #GtkCheckMenuItem
 268  *
 269  * Retrieves the value set by gtk_check_menu_item_set_inconsistent().
 270  *
 271  * Return value: %TRUE if inconsistent
 272  **/
 273 gboolean
 274 gtk_check_menu_item_get_inconsistent (GtkCheckMenuItem *check_menu_item)
 275 {
 276   g_return_val_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item), FALSE);
 277
 278   return check_menu_item->inconsistent;
 279 }
 280
 281 /**
 282  * gtk_check_menu_item_set_draw_as_radio:
 283  * @check_menu_item: a #GtkCheckMenuItem
 284  * @draw_as_radio: whether @check_menu_item is drawn like a #GtkRadioMenuItem
 285  *
 286  * Sets whether @check_menu_item is drawn like a #GtkRadioMenuItem
 287  *
 288  * Since: 2.4
 289  **/
 290 void
 291 gtk_check_menu_item_set_draw_as_radio (GtkCheckMenuItem *check_menu_item,
 292                                        gboolean          draw_as_radio)
 293 {
 294   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
 295
 296   draw_as_radio = draw_as_radio != FALSE;
 297
 298   if (draw_as_radio != check_menu_item->draw_as_radio)
 299     {
 300       check_menu_item->draw_as_radio = draw_as_radio;
 301
 302       gtk_widget_queue_draw (GTK_WIDGET (check_menu_item));
 303
 304       g_object_notify (G_OBJECT (check_menu_item), "draw-as-radio");
 305     }
 306 }
 307
 308 /**
 309  * gtk_check_menu_item_get_draw_as_radio:
 310  * @check_menu_item: a #GtkCheckMenuItem
 311  *
 312  * Returns whether @check_menu_item looks like a #GtkRadioMenuItem
 313  *
 314  * Return value: Whether @check_menu_item looks like a #GtkRadioMenuItem
 315  *
 316  * Since: 2.4
 317  **/
 318 gboolean
 319 gtk_check_menu_item_get_draw_as_radio (GtkCheckMenuItem *check_menu_item)
 320 {
 321   g_return_val_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item), FALSE);
 322
 323   return check_menu_item->draw_as_radio;
 324 }
 325
 326 static void
 327 gtk_check_menu_item_init (GtkCheckMenuItem *check_menu_item)
 328 {
 329   check_menu_item->active = FALSE;
 330   check_menu_item->always_show_toggle = TRUE;
 331 }
 332
 333 static gint
 334 gtk_check_menu_item_expose (GtkWidget      *widget,
 335                             GdkEventExpose *event)
 336 {
 337   if (GTK_WIDGET_CLASS (gtk_check_menu_item_parent_class)->expose_event)
 338     GTK_WIDGET_CLASS (gtk_check_menu_item_parent_class)->expose_event (widget, event);
 339
 340   gtk_check_menu_item_draw_indicator (GTK_CHECK_MENU_ITEM (widget), &event->area);
 341
 342   return FALSE;
 343 }
 344
 345 static void
 346 gtk_check_menu_item_activate (GtkMenuItem *menu_item)
 347 {
 348   GtkCheckMenuItem *check_menu_item = GTK_CHECK_MENU_ITEM (menu_item);
 349   check_menu_item->active = !check_menu_item->active;
 350
 351   gtk_check_menu_item_toggled (check_menu_item);
 352   gtk_widget_queue_draw (GTK_WIDGET (check_menu_item));
 353
 354   g_object_notify (G_OBJECT (check_menu_item), "active");
 355 }
 356
 357 static void
 358 gtk_check_menu_item_draw_indicator (GtkCheckMenuItem *check_menu_item,
 359                                     GdkRectangle     *area)
 360 {
 361   if (GTK_CHECK_MENU_ITEM_GET_CLASS (check_menu_item)->draw_indicator)
 362     GTK_CHECK_MENU_ITEM_GET_CLASS (check_menu_item)->draw_indicator (check_menu_item, area);
 363 }
 364
 365 static void
 366 gtk_real_check_menu_item_draw_indicator (GtkCheckMenuItem *check_menu_item,
 367                                          GdkRectangle     *area)
 368 {
 369   GtkWidget *widget;
 370   GtkStateType state_type;
 371   GtkShadowType shadow_type;
 372   gint x, y;
 373
 374   if (GTK_WIDGET_DRAWABLE (check_menu_item))
 375     {
 376       guint offset;
 377       guint toggle_size;
 378       guint toggle_spacing;
 379       guint horizontal_padding;
 380       guint indicator_size;
 381
 382       widget = GTK_WIDGET (check_menu_item);
 383
 384       gtk_widget_style_get (GTK_WIDGET (check_menu_item),
 385                             "toggle-spacing", &toggle_spacing,
 386                             "horizontal-padding", &horizontal_padding,
 387                             "indicator-size", &indicator_size,
 388                             NULL);
 389
 390       toggle_size = GTK_MENU_ITEM (check_menu_item)->toggle_size;
 391       offset = GTK_CONTAINER (check_menu_item)->border_width +
 392         widget->style->xthickness + 2;
 393
 394       if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR)
 395         {
 396           x = widget->allocation.x + offset + horizontal_padding +
 397             (toggle_size - toggle_spacing - indicator_size) / 2;
 398         }
 399       else
 400         {
 401           x = widget->allocation.x + widget->allocation.width -
 402             offset - horizontal_padding - toggle_size + toggle_spacing +
 403             (toggle_size - toggle_spacing - indicator_size) / 2;
 404         }
 405
 406       y = widget->allocation.y + (widget->allocation.height - indicator_size) / 2;
 407
 408       if (check_menu_item->active ||
 409           check_menu_item->always_show_toggle ||
 410           (GTK_WIDGET_STATE (check_menu_item) == GTK_STATE_PRELIGHT))
 411         {
 412           state_type = GTK_WIDGET_STATE (widget);
 413
 414           if (check_menu_item->inconsistent)
 415             shadow_type = GTK_SHADOW_ETCHED_IN;
 416           else if (check_menu_item->active)
 417             shadow_type = GTK_SHADOW_IN;
 418           else
 419             shadow_type = GTK_SHADOW_OUT;
 420
 421           if (!GTK_WIDGET_IS_SENSITIVE (widget))
 422             state_type = GTK_STATE_INSENSITIVE;
 423
 424           if (check_menu_item->draw_as_radio)
 425             {
 426               gtk_paint_option (widget->style, widget->window,
 427                                 state_type, shadow_type,
 428                                 area, widget, "option",
 429                                 x, y, indicator_size, indicator_size);
 430             }
 431           else
 432             {
 433               gtk_paint_check (widget->style, widget->window,
 434                                state_type, shadow_type,
 435                                area, widget, "check",
 436                                x, y, indicator_size, indicator_size);
 437             }
 438         }
 439     }
 440 }
 441
 442
 443 static void
 444 gtk_check_menu_item_get_property (GObject     *object,
 445                                   guint        prop_id,
 446                                   GValue      *value,
 447                                   GParamSpec  *pspec)
 448 {
 449   GtkCheckMenuItem *checkitem = GTK_CHECK_MENU_ITEM (object);
 450
 451   switch (prop_id)
 452     {
 453     case PROP_ACTIVE:
 454       g_value_set_boolean (value, checkitem->active);
 455       break;
 456     case PROP_INCONSISTENT:
 457       g_value_set_boolean (value, checkitem->inconsistent);
 458       break;
 459     case PROP_DRAW_AS_RADIO:
 460       g_value_set_boolean (value, checkitem->draw_as_radio);
 461       break;
 462     default:
 463       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 464       break;
 465     }
 466 }
 467
 468
 469 static void
 470 gtk_check_menu_item_set_property (GObject      *object,
 471                                   guint         prop_id,
 472                                   const GValue *value,
 473                                   GParamSpec   *pspec)
 474 {
 475   GtkCheckMenuItem *checkitem = GTK_CHECK_MENU_ITEM (object);
 476
 477   switch (prop_id)
 478     {
 479     case PROP_ACTIVE:
 480       gtk_check_menu_item_set_active (checkitem, g_value_get_boolean (value));
 481       break;
 482     case PROP_INCONSISTENT:
 483       gtk_check_menu_item_set_inconsistent (checkitem, g_value_get_boolean (value));
 484       break;
 485     case PROP_DRAW_AS_RADIO:
 486       gtk_check_menu_item_set_draw_as_radio (checkitem, g_value_get_boolean (value));
 487       break;
 488     default:
 489       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 490       break;
 491     }
 492 }
 493
 494 #define __GTK_CHECK_MENU_ITEM_C__
 495 #include "gtkaliasdef.c"