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