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 "gtkcheckmenuitem.h"
  28 #include "gtkaccellabel.h"
  29 #include "gtksignal.h"
  30 #include "gtkintl.h"
  31
  32 #define CHECK_TOGGLE_SIZE 12
  33
  34 enum {
  35   TOGGLED,
  36   LAST_SIGNAL
  37 };
  38
  39 enum {
  40   PROP_0,
  41   PROP_ACTIVE,
  42   PROP_INCONSISTENT
  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 GtkType
  71 gtk_check_menu_item_get_type (void)
  72 {
  73   static GtkType check_menu_item_type = 0;
  74
  75   if (!check_menu_item_type)
  76     {
  77       static const GtkTypeInfo check_menu_item_info =
  78       {
  79         "GtkCheckMenuItem",
  80         sizeof (GtkCheckMenuItem),
  81         sizeof (GtkCheckMenuItemClass),
  82         (GtkClassInitFunc) gtk_check_menu_item_class_init,
  83         (GtkObjectInitFunc) gtk_check_menu_item_init,
  84         /* reserved_1 */ NULL,
  85         /* reserved_2 */ NULL,
  86         (GtkClassInitFunc) NULL,
  87       };
  88
  89       check_menu_item_type = gtk_type_unique (GTK_TYPE_MENU_ITEM, &check_menu_item_info);
  90     }
  91
  92   return check_menu_item_type;
  93 }
  94
  95 static void
  96 gtk_check_menu_item_class_init (GtkCheckMenuItemClass *klass)
  97 {
  98   GtkObjectClass *object_class;
  99   GtkWidgetClass *widget_class;
 100   GtkMenuItemClass *menu_item_class;
 101
 102   object_class = (GtkObjectClass*) klass;
 103   widget_class = (GtkWidgetClass*) klass;
 104   menu_item_class = (GtkMenuItemClass*) klass;
 105
 106   parent_class = gtk_type_class (GTK_TYPE_MENU_ITEM);
 107
 108   G_OBJECT_CLASS(object_class)->set_property = gtk_check_menu_item_set_property;
 109   G_OBJECT_CLASS(object_class)->get_property = gtk_check_menu_item_get_property;
 110
 111   g_object_class_install_property (G_OBJECT_CLASS (object_class),
 112                                    PROP_ACTIVE,
 113                                    g_param_spec_boolean ("active",
 114                                                          _("Active"),
 115                                                          _("Whether the menu item is checked."),
 116                                                          FALSE,
 117                                                          G_PARAM_READABLE | G_PARAM_WRITABLE));
 118
 119   g_object_class_install_property (G_OBJECT_CLASS (object_class),
 120                                    PROP_INCONSISTENT,
 121                                    g_param_spec_boolean ("inconsistent",
 122                                                          _("Inconsistent"),
 123                                                          _("Whether to display an \"inconsistent\" state."),
 124                                                          FALSE,
 125                                                          G_PARAM_READABLE | G_PARAM_WRITABLE));
 126
 127   widget_class->expose_event = gtk_check_menu_item_expose;
 128
 129   menu_item_class->activate = gtk_check_menu_item_activate;
 130   menu_item_class->hide_on_activate = FALSE;
 131   menu_item_class->toggle_size_request = gtk_check_menu_item_toggle_size_request;
 132
 133   klass->toggled = NULL;
 134   klass->draw_indicator = gtk_real_check_menu_item_draw_indicator;
 135
 136   check_menu_item_signals[TOGGLED] =
 137     gtk_signal_new ("toggled",
 138                     GTK_RUN_FIRST,
 139                     GTK_CLASS_TYPE (object_class),
 140                     GTK_SIGNAL_OFFSET (GtkCheckMenuItemClass, toggled),
 141                     gtk_marshal_VOID__VOID,
 142                     GTK_TYPE_NONE, 0);
 143 }
 144
 145 GtkWidget*
 146 gtk_check_menu_item_new (void)
 147 {
 148   return GTK_WIDGET (gtk_type_new (GTK_TYPE_CHECK_MENU_ITEM));
 149 }
 150
 151 GtkWidget*
 152 gtk_check_menu_item_new_with_label (const gchar *label)
 153 {
 154   GtkWidget *check_menu_item;
 155   GtkWidget *accel_label;
 156
 157   check_menu_item = gtk_check_menu_item_new ();
 158   accel_label = gtk_accel_label_new (label);
 159   gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
 160
 161   gtk_container_add (GTK_CONTAINER (check_menu_item), accel_label);
 162   gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label), check_menu_item);
 163   gtk_widget_show (accel_label);
 164
 165   return check_menu_item;
 166 }
 167
 168
 169 /**
 170  * gtk_check_menu_item_new_with_mnemonic:
 171  * @label: The text of the button, with an underscore in front of the
 172  *         mnemonic character
 173  * @returns: a new #GtkCheckMenuItem
 174  *
 175  * Creates a new #GtkCheckMenuItem containing a label. The label
 176  * will be created using gtk_label_new_with_mnemonic(), so underscores
 177  * in @label indicate the mnemonic for the menu item.
 178  **/
 179 GtkWidget*
 180 gtk_check_menu_item_new_with_mnemonic (const gchar *label)
 181 {
 182   GtkWidget *check_menu_item;
 183   GtkWidget *accel_label;
 184
 185   check_menu_item = gtk_check_menu_item_new ();
 186   accel_label = gtk_type_new (GTK_TYPE_ACCEL_LABEL);
 187   gtk_label_set_text_with_mnemonic (GTK_LABEL (accel_label), label);
 188   gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
 189
 190   gtk_container_add (GTK_CONTAINER (check_menu_item), accel_label);
 191   gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label), check_menu_item);
 192   gtk_widget_show (accel_label);
 193
 194   return check_menu_item;
 195 }
 196
 197 void
 198 gtk_check_menu_item_set_active (GtkCheckMenuItem *check_menu_item,
 199                                 gboolean          is_active)
 200 {
 201   g_return_if_fail (check_menu_item != NULL);
 202   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
 203
 204   is_active = is_active != 0;
 205
 206   if (check_menu_item->active != is_active)
 207      {
 208         gtk_menu_item_activate (GTK_MENU_ITEM (check_menu_item));
 209         g_object_notify (G_OBJECT(check_menu_item), "active");
 210      }
 211 }
 212
 213 /**
 214  * gtk_check_menu_item_get_active:
 215  * @check_menu_item: a #GtkCheckMenuItem
 216  *
 217  * Returns whether the check menu item is active. See
 218  * gtk_check_menu_item_set_active ().
 219  *
 220  * Return value: %TRUE if the menu item is checked.
 221  */
 222 gboolean
 223 gtk_check_menu_item_get_active (GtkCheckMenuItem *check_menu_item)
 224 {
 225   g_return_val_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item), FALSE);
 226
 227   return check_menu_item->active;
 228 }
 229
 230 static void
 231 gtk_check_menu_item_toggle_size_request (GtkMenuItem *menu_item,
 232                                          gint        *requisition)
 233 {
 234   g_return_if_fail (menu_item != NULL);
 235   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (menu_item));
 236
 237   *requisition = CHECK_TOGGLE_SIZE;
 238 }
 239
 240 void
 241 gtk_check_menu_item_set_show_toggle (GtkCheckMenuItem *menu_item,
 242                                      gboolean          always)
 243 {
 244   g_return_if_fail (menu_item != NULL);
 245   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (menu_item));
 246
 247 #if 0
 248   menu_item->always_show_toggle = always != FALSE;
 249 #endif
 250 }
 251
 252 void
 253 gtk_check_menu_item_toggled (GtkCheckMenuItem *check_menu_item)
 254 {
 255   gtk_signal_emit (GTK_OBJECT (check_menu_item), check_menu_item_signals[TOGGLED]);
 256 }
 257
 258 /**
 259  * gtk_check_menu_item_set_inconsistent:
 260  * @check_menu_item: a #GtkCheckMenuItem
 261  * @setting: %TRUE to display an "inconsistent" third state check
 262  *
 263  * If the user has selected a range of elements (such as some text or
 264  * spreadsheet cells) that are affected by a boolean setting, and the
 265  * current values in that range are inconsistent, you may want to
 266  * display the check in an "in between" state. This function turns on
 267  * "in between" display.  Normally you would turn off the inconsistent
 268  * state again if the user explicitly selects a setting. This has to be
 269  * done manually, gtk_check_menu_item_set_inconsistent() only affects
 270  * visual appearance, it doesn't affect the semantics of the widget.
 271  *
 272  **/
 273 void
 274 gtk_check_menu_item_set_inconsistent (GtkCheckMenuItem *check_menu_item,
 275                                       gboolean          setting)
 276 {
 277   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
 278
 279   setting = setting != FALSE;
 280
 281   if (setting != check_menu_item->inconsistent)
 282     {
 283       check_menu_item->inconsistent = setting;
 284       gtk_widget_queue_draw (GTK_WIDGET (check_menu_item));
 285       g_object_notify (G_OBJECT (check_menu_item), "inconsistent");
 286     }
 287 }
 288
 289 /**
 290  * gtk_check_menu_item_get_inconsistent:
 291  * @check_menu_item: a #GtkCheckMenuItem
 292  *
 293  * Retrieves the value set by gtk_check_menu_item_set_inconsistent().
 294  *
 295  * Return value: %TRUE if inconsistent
 296  **/
 297 gboolean
 298 gtk_check_menu_item_get_inconsistent (GtkCheckMenuItem *check_menu_item)
 299 {
 300   g_return_val_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item), FALSE);
 301
 302   return check_menu_item->inconsistent;
 303 }
 304
 305 static void
 306 gtk_check_menu_item_init (GtkCheckMenuItem *check_menu_item)
 307 {
 308   check_menu_item->active = FALSE;
 309   check_menu_item->always_show_toggle = TRUE;
 310 }
 311
 312 static gint
 313 gtk_check_menu_item_expose (GtkWidget      *widget,
 314                             GdkEventExpose *event)
 315 {
 316   g_return_val_if_fail (widget != NULL, FALSE);
 317   g_return_val_if_fail (GTK_IS_CHECK_MENU_ITEM (widget), FALSE);
 318   g_return_val_if_fail (event != NULL, FALSE);
 319
 320   if (GTK_WIDGET_CLASS (parent_class)->expose_event)
 321     (* GTK_WIDGET_CLASS (parent_class)->expose_event) (widget, event);
 322
 323   gtk_check_menu_item_draw_indicator (GTK_CHECK_MENU_ITEM (widget), &event->area);
 324
 325   return FALSE;
 326 }
 327
 328 static void
 329 gtk_check_menu_item_activate (GtkMenuItem *menu_item)
 330 {
 331   GtkCheckMenuItem *check_menu_item;
 332
 333   g_return_if_fail (menu_item != NULL);
 334   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (menu_item));
 335
 336   check_menu_item = GTK_CHECK_MENU_ITEM (menu_item);
 337   check_menu_item->active = !check_menu_item->active;
 338
 339   gtk_check_menu_item_toggled (check_menu_item);
 340   gtk_widget_queue_draw (GTK_WIDGET (check_menu_item));
 341 }
 342
 343 static void
 344 gtk_check_menu_item_draw_indicator (GtkCheckMenuItem *check_menu_item,
 345                                     GdkRectangle     *area)
 346 {
 347   g_return_if_fail (check_menu_item != NULL);
 348   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
 349   g_return_if_fail (GTK_CHECK_MENU_ITEM_GET_CLASS (check_menu_item) != NULL);
 350
 351   if (GTK_CHECK_MENU_ITEM_GET_CLASS (check_menu_item)->draw_indicator)
 352     (* GTK_CHECK_MENU_ITEM_GET_CLASS (check_menu_item)->draw_indicator) (check_menu_item, area);
 353 }
 354
 355 static void
 356 gtk_real_check_menu_item_draw_indicator (GtkCheckMenuItem *check_menu_item,
 357                                          GdkRectangle     *area)
 358 {
 359   GtkWidget *widget;
 360   GtkStateType state_type;
 361   GtkShadowType shadow_type;
 362   gint width, height;
 363   gint x, y;
 364
 365   g_return_if_fail (check_menu_item != NULL);
 366   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
 367
 368   if (GTK_WIDGET_DRAWABLE (check_menu_item))
 369     {
 370       widget = GTK_WIDGET (check_menu_item);
 371
 372       width = 8;
 373       height = 8;
 374       x = (GTK_CONTAINER (check_menu_item)->border_width +
 375            widget->style->xthickness + 2);
 376       y = (widget->allocation.height - height) / 2;
 377
 378       if (check_menu_item->active ||
 379           check_menu_item->always_show_toggle ||
 380           (GTK_WIDGET_STATE (check_menu_item) == GTK_STATE_PRELIGHT))
 381         {
 382           state_type = GTK_WIDGET_STATE (widget);
 383
 384           if (check_menu_item->always_show_toggle)
 385             {
 386               shadow_type = GTK_SHADOW_OUT;
 387               if (check_menu_item->active)
 388                 shadow_type = GTK_SHADOW_IN;
 389             }
 390           else
 391             {
 392               shadow_type = GTK_SHADOW_IN;
 393               if (check_menu_item->active &&
 394                   (state_type == GTK_STATE_PRELIGHT))
 395                 shadow_type = GTK_SHADOW_OUT;
 396             }
 397
 398           if (check_menu_item->inconsistent)
 399             {
 400               shadow_type = GTK_SHADOW_ETCHED_IN;
 401               if (state_type == GTK_STATE_ACTIVE)
 402                 state_type = GTK_STATE_NORMAL;
 403             }
 404
 405           gtk_paint_check (widget->style, widget->window,
 406                            state_type, shadow_type,
 407                            area, widget, "check",
 408                            x, y, width, height);
 409         }
 410     }
 411 }
 412
 413
 414 static void
 415 gtk_check_menu_item_get_property (GObject     *object,
 416                                   guint        prop_id,
 417                                   GValue      *value,
 418                                   GParamSpec  *pspec)
 419 {
 420   GtkCheckMenuItem *checkitem = GTK_CHECK_MENU_ITEM (object);
 421
 422   switch (prop_id)
 423     {
 424     case PROP_ACTIVE:
 425       g_value_set_boolean (value, checkitem->active);
 426       break;
 427     case PROP_INCONSISTENT:
 428       g_value_set_boolean (value, checkitem->inconsistent);
 429       break;
 430     default:
 431       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 432       break;
 433     }
 434 }
 435
 436
 437 static void
 438 gtk_check_menu_item_set_property (GObject      *object,
 439                                   guint         prop_id,
 440                                   const GValue *value,
 441                                   GParamSpec   *pspec)
 442 {
 443   GtkCheckMenuItem *checkitem = GTK_CHECK_MENU_ITEM (object);
 444
 445   switch (prop_id)
 446     {
 447     case PROP_ACTIVE:
 448       gtk_check_menu_item_set_active (checkitem, g_value_get_boolean (value));
 449       break;
 450     case PROP_INCONSISTENT:
 451       gtk_check_menu_item_set_inconsistent (checkitem, g_value_get_boolean (value));
 452       break;
 453     default:
 454       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 455       break;
 456     }
 457 }