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