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