gtkcheckmenuitem.c 17.5 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Elliot Lee's avatar
Elliot Lee committed
2 3 4
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10 11
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
15 16 17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
18
 */
19 20

/*
21
 * Modified by the GTK+ Team and others 1997-2001.  See the AUTHORS
22 23 24 25 26
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

27
#include "config.h"
Elliot Lee's avatar
Elliot Lee committed
28
#include "gtkcheckmenuitem.h"
Tim Janik's avatar
Tim Janik committed
29
#include "gtkaccellabel.h"
30 31
#include "gtkactivatable.h"
#include "gtktoggleaction.h"
32
#include "gtkmarshalers.h"
33 34
#include "gtkprivate.h"
#include "gtkintl.h"
35

Elliot Lee's avatar
Elliot Lee committed
36 37 38 39 40 41

enum {
  TOGGLED,
  LAST_SIGNAL
};

42 43 44
enum {
  PROP_0,
  PROP_ACTIVE,
45 46
  PROP_INCONSISTENT,
  PROP_DRAW_AS_RADIO
47
};
Elliot Lee's avatar
Elliot Lee committed
48

49 50 51 52
static gint gtk_check_menu_item_expose               (GtkWidget             *widget,
						      GdkEventExpose        *event);
static void gtk_check_menu_item_activate             (GtkMenuItem           *menu_item);
static void gtk_check_menu_item_toggle_size_request  (GtkMenuItem           *menu_item,
53
						      gint                  *requisition);
54 55 56 57
static void gtk_check_menu_item_draw_indicator       (GtkCheckMenuItem      *check_menu_item,
						      GdkRectangle          *area);
static void gtk_real_check_menu_item_draw_indicator  (GtkCheckMenuItem      *check_menu_item,
						      GdkRectangle          *area);
58 59 60 61 62 63 64 65 66 67
static void gtk_check_menu_item_set_property         (GObject               *object,
						      guint                  prop_id,
						      const GValue          *value,
						      GParamSpec            *pspec);
static void gtk_check_menu_item_get_property         (GObject               *object,
						      guint                  prop_id,
						      GValue                *value,
						      GParamSpec            *pspec);

static void gtk_check_menu_item_activatable_interface_init (GtkActivatableIface  *iface);
68
static void gtk_check_menu_item_update                     (GtkActivatable       *activatable,
69 70
							    GtkAction            *action,
							    const gchar          *property_name);
71
static void gtk_check_menu_item_sync_action_properties     (GtkActivatable       *activatable,
72 73 74 75 76 77 78 79
							    GtkAction            *action);

static GtkActivatableIface *parent_activatable_iface;
static guint                check_menu_item_signals[LAST_SIGNAL] = { 0 };

G_DEFINE_TYPE_WITH_CODE (GtkCheckMenuItem, gtk_check_menu_item, GTK_TYPE_MENU_ITEM,
			 G_IMPLEMENT_INTERFACE (GTK_TYPE_ACTIVATABLE,
						gtk_check_menu_item_activatable_interface_init))
Elliot Lee's avatar
Elliot Lee committed
80

81 82 83
static void
gtk_check_menu_item_class_init (GtkCheckMenuItemClass *klass)
{
Manish Singh's avatar
Manish Singh committed
84
  GObjectClass *gobject_class;
85 86 87
  GtkWidgetClass *widget_class;
  GtkMenuItemClass *menu_item_class;
  
Manish Singh's avatar
Manish Singh committed
88
  gobject_class = G_OBJECT_CLASS (klass);
89 90 91
  widget_class = (GtkWidgetClass*) klass;
  menu_item_class = (GtkMenuItemClass*) klass;
  
Manish Singh's avatar
Manish Singh committed
92 93
  gobject_class->set_property = gtk_check_menu_item_set_property;
  gobject_class->get_property = gtk_check_menu_item_get_property;
94

Manish Singh's avatar
Manish Singh committed
95
  g_object_class_install_property (gobject_class,
96 97
                                   PROP_ACTIVE,
                                   g_param_spec_boolean ("active",
98 99
                                                         P_("Active"),
                                                         P_("Whether the menu item is checked"),
100
                                                         FALSE,
101
                                                         GTK_PARAM_READWRITE));
102
  
Manish Singh's avatar
Manish Singh committed
103
  g_object_class_install_property (gobject_class,
Owen Taylor's avatar
Owen Taylor committed
104
                                   PROP_INCONSISTENT,
105
                                   g_param_spec_boolean ("inconsistent",
106 107
                                                         P_("Inconsistent"),
                                                         P_("Whether to display an \"inconsistent\" state"),
108
                                                         FALSE,
109
                                                         GTK_PARAM_READWRITE));
110
  
111
  g_object_class_install_property (gobject_class,
112
                                   PROP_DRAW_AS_RADIO,
113
                                   g_param_spec_boolean ("draw-as-radio",
114 115
                                                         P_("Draw as radio menu item"),
                                                         P_("Whether the menu item looks like a radio menu item"),
116
                                                         FALSE,
117
                                                         GTK_PARAM_READWRITE));
118
  
119
  gtk_widget_class_install_style_property (widget_class,
120
                                           g_param_spec_int ("indicator-size",
121
                                                             P_("Indicator Size"),
122 123 124
                                                             P_("Size of check or radio indicator"),
                                                             0,
                                                             G_MAXINT,
125
                                                             13,
126
                                                             GTK_PARAM_READABLE));
127

128 129 130 131
  widget_class->expose_event = gtk_check_menu_item_expose;
  
  menu_item_class->activate = gtk_check_menu_item_activate;
  menu_item_class->hide_on_activate = FALSE;
132
  menu_item_class->toggle_size_request = gtk_check_menu_item_toggle_size_request;
133 134 135 136 137
  
  klass->toggled = NULL;
  klass->draw_indicator = gtk_real_check_menu_item_draw_indicator;

  check_menu_item_signals[TOGGLED] =
Matthias Clasen's avatar
Matthias Clasen committed
138
    g_signal_new (I_("toggled"),
Manish Singh's avatar
Manish Singh committed
139 140 141 142 143 144
		  G_OBJECT_CLASS_TYPE (gobject_class),
		  G_SIGNAL_RUN_FIRST,
		  G_STRUCT_OFFSET (GtkCheckMenuItemClass, toggled),
		  NULL, NULL,
		  _gtk_marshal_VOID__VOID,
		  G_TYPE_NONE, 0);
145 146
}

147 148 149 150
static void 
gtk_check_menu_item_activatable_interface_init (GtkActivatableIface  *iface)
{
  parent_activatable_iface = g_type_interface_peek_parent (iface);
151 152
  iface->update = gtk_check_menu_item_update;
  iface->sync_action_properties = gtk_check_menu_item_sync_action_properties;
153 154
}

155 156 157 158
static void
gtk_check_menu_item_update (GtkActivatable *activatable,
			    GtkAction      *action,
			    const gchar    *property_name)
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
{
  GtkCheckMenuItem *check_menu_item;

  check_menu_item = GTK_CHECK_MENU_ITEM (activatable);

  parent_activatable_iface->update (activatable, action, property_name);

  if (strcmp (property_name, "active") == 0)
    {
      gtk_action_block_activate (action);
      gtk_check_menu_item_set_active (check_menu_item, gtk_toggle_action_get_active (GTK_TOGGLE_ACTION (action)));
      gtk_action_unblock_activate (action);
    }

  if (!gtk_activatable_get_use_action_appearance (activatable))
    return;

  if (strcmp (property_name, "draw-as-radio") == 0)
177
    gtk_check_menu_item_set_draw_as_radio (check_menu_item,
178 179 180
					   gtk_toggle_action_get_draw_as_radio (GTK_TOGGLE_ACTION (action)));
}

181 182 183
static void
gtk_check_menu_item_sync_action_properties (GtkActivatable *activatable,
		                            GtkAction      *action)
184 185 186 187 188
{
  GtkCheckMenuItem *check_menu_item;

  check_menu_item = GTK_CHECK_MENU_ITEM (activatable);

189
  parent_activatable_iface->sync_action_properties (activatable, action);
190

191
  if (!GTK_IS_TOGGLE_ACTION (action))
192 193 194 195 196 197 198 199 200
    return;

  gtk_action_block_activate (action);
  gtk_check_menu_item_set_active (check_menu_item, gtk_toggle_action_get_active (GTK_TOGGLE_ACTION (action)));
  gtk_action_unblock_activate (action);
  
  if (!gtk_activatable_get_use_action_appearance (activatable))
    return;

201
  gtk_check_menu_item_set_draw_as_radio (check_menu_item,
202 203 204
					 gtk_toggle_action_get_draw_as_radio (GTK_TOGGLE_ACTION (action)));
}

Elliot Lee's avatar
Elliot Lee committed
205
GtkWidget*
206
gtk_check_menu_item_new (void)
Elliot Lee's avatar
Elliot Lee committed
207
{
Manish Singh's avatar
Manish Singh committed
208
  return g_object_new (GTK_TYPE_CHECK_MENU_ITEM, NULL);
Elliot Lee's avatar
Elliot Lee committed
209 210 211 212 213
}

GtkWidget*
gtk_check_menu_item_new_with_label (const gchar *label)
{
214 215 216
  return g_object_new (GTK_TYPE_CHECK_MENU_ITEM, 
		       "label", label,
		       NULL);
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
}


/**
 * gtk_check_menu_item_new_with_mnemonic:
 * @label: The text of the button, with an underscore in front of the
 *         mnemonic character
 * @returns: a new #GtkCheckMenuItem
 *
 * Creates a new #GtkCheckMenuItem containing a label. The label
 * will be created using gtk_label_new_with_mnemonic(), so underscores
 * in @label indicate the mnemonic for the menu item.
 **/
GtkWidget*
gtk_check_menu_item_new_with_mnemonic (const gchar *label)
{
233 234 235 236
  return g_object_new (GTK_TYPE_CHECK_MENU_ITEM, 
		       "label", label,
		       "use-underline", TRUE,
		       NULL);
Elliot Lee's avatar
Elliot Lee committed
237 238
}

239 240 241
void
gtk_check_menu_item_set_active (GtkCheckMenuItem *check_menu_item,
				gboolean          is_active)
Elliot Lee's avatar
Elliot Lee committed
242 243 244
{
  g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));

245 246 247
  is_active = is_active != 0;

  if (check_menu_item->active != is_active)
248
    gtk_menu_item_activate (GTK_MENU_ITEM (check_menu_item));
Elliot Lee's avatar
Elliot Lee committed
249 250
}

251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
/**
 * gtk_check_menu_item_get_active:
 * @check_menu_item: a #GtkCheckMenuItem
 * 
 * Returns whether the check menu item is active. See
 * gtk_check_menu_item_set_active ().
 * 
 * Return value: %TRUE if the menu item is checked.
 */
gboolean
gtk_check_menu_item_get_active (GtkCheckMenuItem *check_menu_item)
{
  g_return_val_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item), FALSE);

  return check_menu_item->active;
}

268 269
static void
gtk_check_menu_item_toggle_size_request (GtkMenuItem *menu_item,
270
					 gint        *requisition)
271
{
272
  guint toggle_spacing;
273
  guint indicator_size;
274
  
275
  g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (menu_item));
276 277
  
  gtk_widget_style_get (GTK_WIDGET (menu_item),
278 279
			"toggle-spacing", &toggle_spacing,
			"indicator-size", &indicator_size,
280
			NULL);
281 282

  *requisition = indicator_size + toggle_spacing;
283 284
}

Elliot Lee's avatar
Elliot Lee committed
285 286 287
void
gtk_check_menu_item_toggled (GtkCheckMenuItem *check_menu_item)
{
Manish Singh's avatar
Manish Singh committed
288
  g_signal_emit (check_menu_item, check_menu_item_signals[TOGGLED], 0);
Elliot Lee's avatar
Elliot Lee committed
289 290
}

291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
/**
 * gtk_check_menu_item_set_inconsistent:
 * @check_menu_item: a #GtkCheckMenuItem
 * @setting: %TRUE to display an "inconsistent" third state check
 *
 * If the user has selected a range of elements (such as some text or
 * spreadsheet cells) that are affected by a boolean setting, and the
 * current values in that range are inconsistent, you may want to
 * display the check in an "in between" state. This function turns on
 * "in between" display.  Normally you would turn off the inconsistent
 * state again if the user explicitly selects a setting. This has to be
 * done manually, gtk_check_menu_item_set_inconsistent() only affects
 * visual appearance, it doesn't affect the semantics of the widget.
 * 
 **/
void
gtk_check_menu_item_set_inconsistent (GtkCheckMenuItem *check_menu_item,
                                      gboolean          setting)
{
  g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
  
  setting = setting != FALSE;

  if (setting != check_menu_item->inconsistent)
    {
      check_menu_item->inconsistent = setting;
      gtk_widget_queue_draw (GTK_WIDGET (check_menu_item));
318
      g_object_notify (G_OBJECT (check_menu_item), "inconsistent");
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
    }
}

/**
 * gtk_check_menu_item_get_inconsistent:
 * @check_menu_item: a #GtkCheckMenuItem
 * 
 * Retrieves the value set by gtk_check_menu_item_set_inconsistent().
 * 
 * Return value: %TRUE if inconsistent
 **/
gboolean
gtk_check_menu_item_get_inconsistent (GtkCheckMenuItem *check_menu_item)
{
  g_return_val_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item), FALSE);

  return check_menu_item->inconsistent;
}

338 339 340 341 342 343 344
/**
 * gtk_check_menu_item_set_draw_as_radio:
 * @check_menu_item: a #GtkCheckMenuItem
 * @draw_as_radio: whether @check_menu_item is drawn like a #GtkRadioMenuItem
 *
 * Sets whether @check_menu_item is drawn like a #GtkRadioMenuItem
 *
Matthias Clasen's avatar
Matthias Clasen committed
345
 * Since: 2.4
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
 **/
void
gtk_check_menu_item_set_draw_as_radio (GtkCheckMenuItem *check_menu_item,
				       gboolean          draw_as_radio)
{
  g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
  
  draw_as_radio = draw_as_radio != FALSE;

  if (draw_as_radio != check_menu_item->draw_as_radio)
    {
      check_menu_item->draw_as_radio = draw_as_radio;

      gtk_widget_queue_draw (GTK_WIDGET (check_menu_item));

361
      g_object_notify (G_OBJECT (check_menu_item), "draw-as-radio");
362 363 364 365 366 367 368 369 370 371
    }
}

/**
 * gtk_check_menu_item_get_draw_as_radio:
 * @check_menu_item: a #GtkCheckMenuItem
 * 
 * Returns whether @check_menu_item looks like a #GtkRadioMenuItem
 * 
 * Return value: Whether @check_menu_item looks like a #GtkRadioMenuItem
Matthias Clasen's avatar
Matthias Clasen committed
372 373
 * 
 * Since: 2.4
374 375 376 377 378 379 380 381 382
 **/
gboolean
gtk_check_menu_item_get_draw_as_radio (GtkCheckMenuItem *check_menu_item)
{
  g_return_val_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item), FALSE);
  
  return check_menu_item->draw_as_radio;
}

Elliot Lee's avatar
Elliot Lee committed
383 384 385 386
static void
gtk_check_menu_item_init (GtkCheckMenuItem *check_menu_item)
{
  check_menu_item->active = FALSE;
387
  check_menu_item->always_show_toggle = TRUE;
Elliot Lee's avatar
Elliot Lee committed
388 389 390 391 392 393
}

static gint
gtk_check_menu_item_expose (GtkWidget      *widget,
			    GdkEventExpose *event)
{
Matthias Clasen's avatar
Matthias Clasen committed
394
  if (GTK_WIDGET_CLASS (gtk_check_menu_item_parent_class)->expose_event)
395
    GTK_WIDGET_CLASS (gtk_check_menu_item_parent_class)->expose_event (widget, event);
Elliot Lee's avatar
Elliot Lee committed
396 397 398 399 400 401 402 403 404

  gtk_check_menu_item_draw_indicator (GTK_CHECK_MENU_ITEM (widget), &event->area);

  return FALSE;
}

static void
gtk_check_menu_item_activate (GtkMenuItem *menu_item)
{
405
  GtkCheckMenuItem *check_menu_item = GTK_CHECK_MENU_ITEM (menu_item);
Elliot Lee's avatar
Elliot Lee committed
406 407 408 409
  check_menu_item->active = !check_menu_item->active;

  gtk_check_menu_item_toggled (check_menu_item);
  gtk_widget_queue_draw (GTK_WIDGET (check_menu_item));
410

411 412
  GTK_MENU_ITEM_CLASS (gtk_check_menu_item_parent_class)->activate (menu_item);

413
  g_object_notify (G_OBJECT (check_menu_item), "active");
Elliot Lee's avatar
Elliot Lee committed
414 415 416 417 418 419
}

static void
gtk_check_menu_item_draw_indicator (GtkCheckMenuItem *check_menu_item,
				    GdkRectangle     *area)
{
420
  if (GTK_CHECK_MENU_ITEM_GET_CLASS (check_menu_item)->draw_indicator)
421
    GTK_CHECK_MENU_ITEM_GET_CLASS (check_menu_item)->draw_indicator (check_menu_item, area);
Elliot Lee's avatar
Elliot Lee committed
422 423 424 425 426 427 428 429 430 431 432
}

static void
gtk_real_check_menu_item_draw_indicator (GtkCheckMenuItem *check_menu_item,
					 GdkRectangle     *area)
{
  GtkWidget *widget;
  GtkStateType state_type;
  GtkShadowType shadow_type;
  gint x, y;

433 434 435
  widget = GTK_WIDGET (check_menu_item);

  if (gtk_widget_is_drawable (widget))
Elliot Lee's avatar
Elliot Lee committed
436
    {
437 438 439 440
      guint offset;
      guint toggle_size;
      guint toggle_spacing;
      guint horizontal_padding;
441
      guint indicator_size;
Elliot Lee's avatar
Elliot Lee committed
442

443
      gtk_widget_style_get (widget,
444 445 446
 			    "toggle-spacing", &toggle_spacing,
 			    "horizontal-padding", &horizontal_padding,
			    "indicator-size", &indicator_size,
447 448 449
 			    NULL);

      toggle_size = GTK_MENU_ITEM (check_menu_item)->toggle_size;
450
      offset = GTK_CONTAINER (check_menu_item)->border_width +
451 452 453 454 455
	widget->style->xthickness + 2; 

      if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR)
	{
	  x = widget->allocation.x + offset + horizontal_padding +
456
	    (toggle_size - toggle_spacing - indicator_size) / 2;
457
	}
458
      else 
459 460 461
	{
	  x = widget->allocation.x + widget->allocation.width -
	    offset - horizontal_padding - toggle_size + toggle_spacing +
462
	    (toggle_size - toggle_spacing - indicator_size) / 2;
463 464
	}
      
465
      y = widget->allocation.y + (widget->allocation.height - indicator_size) / 2;
Elliot Lee's avatar
Elliot Lee committed
466 467

      if (check_menu_item->active ||
468
	  check_menu_item->always_show_toggle ||
469
	  (gtk_widget_get_state (widget) == GTK_STATE_PRELIGHT))
Elliot Lee's avatar
Elliot Lee committed
470
	{
471
	  state_type = gtk_widget_get_state (widget);
472
	  
473 474 475 476 477 478 479
	  if (check_menu_item->inconsistent)
	    shadow_type = GTK_SHADOW_ETCHED_IN;
	  else if (check_menu_item->active)
	    shadow_type = GTK_SHADOW_IN;
	  else 
	    shadow_type = GTK_SHADOW_OUT;
	  
480
	  if (!gtk_widget_is_sensitive (widget))
481 482 483
	    state_type = GTK_STATE_INSENSITIVE;

	  if (check_menu_item->draw_as_radio)
484
	    {
485 486 487
	      gtk_paint_option (widget->style, widget->window,
				state_type, shadow_type,
				area, widget, "option",
488
				x, y, indicator_size, indicator_size);
489 490 491
	    }
	  else
	    {
492 493 494
	      gtk_paint_check (widget->style, widget->window,
			       state_type, shadow_type,
			       area, widget, "check",
495
			       x, y, indicator_size, indicator_size);
496
	    }
Elliot Lee's avatar
Elliot Lee committed
497 498 499
	}
    }
}
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517


static void
gtk_check_menu_item_get_property (GObject     *object,
				  guint        prop_id,
				  GValue      *value,
				  GParamSpec  *pspec)
{
  GtkCheckMenuItem *checkitem = GTK_CHECK_MENU_ITEM (object);
  
  switch (prop_id)
    {
    case PROP_ACTIVE:
      g_value_set_boolean (value, checkitem->active);
      break;
    case PROP_INCONSISTENT:
      g_value_set_boolean (value, checkitem->inconsistent);
      break;
518 519 520
    case PROP_DRAW_AS_RADIO:
      g_value_set_boolean (value, checkitem->draw_as_radio);
      break;
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}


static void
gtk_check_menu_item_set_property (GObject      *object,
				  guint         prop_id,
				  const GValue *value,
				  GParamSpec   *pspec)
{
  GtkCheckMenuItem *checkitem = GTK_CHECK_MENU_ITEM (object);
  
  switch (prop_id)
    {
    case PROP_ACTIVE:
      gtk_check_menu_item_set_active (checkitem, g_value_get_boolean (value));
      break;
    case PROP_INCONSISTENT:
      gtk_check_menu_item_set_inconsistent (checkitem, g_value_get_boolean (value));
      break;
544 545 546
    case PROP_DRAW_AS_RADIO:
      gtk_check_menu_item_set_draw_as_radio (checkitem, g_value_get_boolean (value));
      break;
547 548 549 550 551
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}