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 static void
 214 gtk_check_menu_item_toggle_size_request (GtkMenuItem *menu_item,
 215                                          gint        *requisition)
 216 {
 217   g_return_if_fail (menu_item != NULL);
 218   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (menu_item));
 219
 220   *requisition = CHECK_TOGGLE_SIZE;
 221 }
 222
 223 void
 224 gtk_check_menu_item_set_show_toggle (GtkCheckMenuItem *menu_item,
 225                                      gboolean          always)
 226 {
 227   g_return_if_fail (menu_item != NULL);
 228   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (menu_item));
 229
 230 #if 0
 231   menu_item->always_show_toggle = always != FALSE;
 232 #endif
 233 }
 234
 235 void
 236 gtk_check_menu_item_toggled (GtkCheckMenuItem *check_menu_item)
 237 {
 238   gtk_signal_emit (GTK_OBJECT (check_menu_item), check_menu_item_signals[TOGGLED]);
 239 }
 240
 241 /**
 242  * gtk_check_menu_item_set_inconsistent:
 243  * @check_menu_item: a #GtkCheckMenuItem
 244  * @setting: %TRUE to display an "inconsistent" third state check
 245  *
 246  * If the user has selected a range of elements (such as some text or
 247  * spreadsheet cells) that are affected by a boolean setting, and the
 248  * current values in that range are inconsistent, you may want to
 249  * display the check in an "in between" state. This function turns on
 250  * "in between" display.  Normally you would turn off the inconsistent
 251  * state again if the user explicitly selects a setting. This has to be
 252  * done manually, gtk_check_menu_item_set_inconsistent() only affects
 253  * visual appearance, it doesn't affect the semantics of the widget.
 254  *
 255  **/
 256 void
 257 gtk_check_menu_item_set_inconsistent (GtkCheckMenuItem *check_menu_item,
 258                                       gboolean          setting)
 259 {
 260   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
 261
 262   setting = setting != FALSE;
 263
 264   if (setting != check_menu_item->inconsistent)
 265     {
 266       check_menu_item->inconsistent = setting;
 267       gtk_widget_queue_draw (GTK_WIDGET (check_menu_item));
 268       g_object_notify (G_OBJECT (check_menu_item), "inconsistent");
 269     }
 270 }
 271
 272 /**
 273  * gtk_check_menu_item_get_inconsistent:
 274  * @check_menu_item: a #GtkCheckMenuItem
 275  *
 276  * Retrieves the value set by gtk_check_menu_item_set_inconsistent().
 277  *
 278  * Return value: %TRUE if inconsistent
 279  **/
 280 gboolean
 281 gtk_check_menu_item_get_inconsistent (GtkCheckMenuItem *check_menu_item)
 282 {
 283   g_return_val_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item), FALSE);
 284
 285   return check_menu_item->inconsistent;
 286 }
 287
 288 static void
 289 gtk_check_menu_item_init (GtkCheckMenuItem *check_menu_item)
 290 {
 291   check_menu_item->active = FALSE;
 292   check_menu_item->always_show_toggle = TRUE;
 293 }
 294
 295 static gint
 296 gtk_check_menu_item_expose (GtkWidget      *widget,
 297                             GdkEventExpose *event)
 298 {
 299   g_return_val_if_fail (widget != NULL, FALSE);
 300   g_return_val_if_fail (GTK_IS_CHECK_MENU_ITEM (widget), FALSE);
 301   g_return_val_if_fail (event != NULL, FALSE);
 302
 303   if (GTK_WIDGET_CLASS (parent_class)->expose_event)
 304     (* GTK_WIDGET_CLASS (parent_class)->expose_event) (widget, event);
 305
 306   gtk_check_menu_item_draw_indicator (GTK_CHECK_MENU_ITEM (widget), &event->area);
 307
 308   return FALSE;
 309 }
 310
 311 static void
 312 gtk_check_menu_item_activate (GtkMenuItem *menu_item)
 313 {
 314   GtkCheckMenuItem *check_menu_item;
 315
 316   g_return_if_fail (menu_item != NULL);
 317   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (menu_item));
 318
 319   check_menu_item = GTK_CHECK_MENU_ITEM (menu_item);
 320   check_menu_item->active = !check_menu_item->active;
 321
 322   gtk_check_menu_item_toggled (check_menu_item);
 323   gtk_widget_queue_draw (GTK_WIDGET (check_menu_item));
 324 }
 325
 326 static void
 327 gtk_check_menu_item_draw_indicator (GtkCheckMenuItem *check_menu_item,
 328                                     GdkRectangle     *area)
 329 {
 330   g_return_if_fail (check_menu_item != NULL);
 331   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
 332   g_return_if_fail (GTK_CHECK_MENU_ITEM_GET_CLASS (check_menu_item) != NULL);
 333
 334   if (GTK_CHECK_MENU_ITEM_GET_CLASS (check_menu_item)->draw_indicator)
 335     (* GTK_CHECK_MENU_ITEM_GET_CLASS (check_menu_item)->draw_indicator) (check_menu_item, area);
 336 }
 337
 338 static void
 339 gtk_real_check_menu_item_draw_indicator (GtkCheckMenuItem *check_menu_item,
 340                                          GdkRectangle     *area)
 341 {
 342   GtkWidget *widget;
 343   GtkStateType state_type;
 344   GtkShadowType shadow_type;
 345   gint width, height;
 346   gint x, y;
 347
 348   g_return_if_fail (check_menu_item != NULL);
 349   g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
 350
 351   if (GTK_WIDGET_DRAWABLE (check_menu_item))
 352     {
 353       widget = GTK_WIDGET (check_menu_item);
 354
 355       width = 8;
 356       height = 8;
 357       x = (GTK_CONTAINER (check_menu_item)->border_width +
 358            widget->style->xthickness + 2);
 359       y = (widget->allocation.height - height) / 2;
 360
 361       if (check_menu_item->active ||
 362           check_menu_item->always_show_toggle ||
 363           (GTK_WIDGET_STATE (check_menu_item) == GTK_STATE_PRELIGHT))
 364         {
 365           state_type = GTK_WIDGET_STATE (widget);
 366
 367           if (check_menu_item->always_show_toggle)
 368             {
 369               shadow_type = GTK_SHADOW_OUT;
 370               if (check_menu_item->active)
 371                 shadow_type = GTK_SHADOW_IN;
 372             }
 373           else
 374             {
 375               shadow_type = GTK_SHADOW_IN;
 376               if (check_menu_item->active &&
 377                   (state_type == GTK_STATE_PRELIGHT))
 378                 shadow_type = GTK_SHADOW_OUT;
 379             }
 380
 381           if (check_menu_item->inconsistent)
 382             {
 383               shadow_type = GTK_SHADOW_ETCHED_IN;
 384               if (state_type == GTK_STATE_ACTIVE)
 385                 state_type = GTK_STATE_NORMAL;
 386             }
 387
 388           gtk_paint_check (widget->style, widget->window,
 389                            state_type, shadow_type,
 390                            area, widget, "check",
 391                            x, y, width, height);
 392         }
 393     }
 394 }
 395
 396
 397 static void
 398 gtk_check_menu_item_get_property (GObject     *object,
 399                                   guint        prop_id,
 400                                   GValue      *value,
 401                                   GParamSpec  *pspec)
 402 {
 403   GtkCheckMenuItem *checkitem = GTK_CHECK_MENU_ITEM (object);
 404
 405   switch (prop_id)
 406     {
 407     case PROP_ACTIVE:
 408       g_value_set_boolean (value, checkitem->active);
 409       break;
 410     case PROP_INCONSISTENT:
 411       g_value_set_boolean (value, checkitem->inconsistent);
 412       break;
 413     default:
 414       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 415       break;
 416     }
 417 }
 418
 419
 420 static void
 421 gtk_check_menu_item_set_property (GObject      *object,
 422                                   guint         prop_id,
 423                                   const GValue *value,
 424                                   GParamSpec   *pspec)
 425 {
 426   GtkCheckMenuItem *checkitem = GTK_CHECK_MENU_ITEM (object);
 427
 428   switch (prop_id)
 429     {
 430     case PROP_ACTIVE:
 431       gtk_check_menu_item_set_active (checkitem, g_value_get_boolean (value));
 432       break;
 433     case PROP_INCONSISTENT:
 434       gtk_check_menu_item_set_inconsistent (checkitem, g_value_get_boolean (value));
 435       break;
 436     default:
 437       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 438       break;
 439     }
 440 }