gtkcheckmenuitem.c 15.3 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
#include "gtkmarshalers.h"
31 32
#include "gtkprivate.h"
#include "gtkintl.h"
33
#include "gtkalias.h"
Elliot Lee's avatar
Elliot Lee committed
34 35 36 37 38 39

enum {
  TOGGLED,
  LAST_SIGNAL
};

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

47 48 49 50
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,
51
						      gint                  *requisition);
52 53 54 55
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);
56 57 58 59 60 61 62 63
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);
Elliot Lee's avatar
Elliot Lee committed
64 65


66
static guint check_menu_item_signals[LAST_SIGNAL] = { 0 };
Elliot Lee's avatar
Elliot Lee committed
67

Matthias Clasen's avatar
Matthias Clasen committed
68
G_DEFINE_TYPE (GtkCheckMenuItem, gtk_check_menu_item, GTK_TYPE_MENU_ITEM)
Elliot Lee's avatar
Elliot Lee committed
69

70 71 72
static void
gtk_check_menu_item_class_init (GtkCheckMenuItemClass *klass)
{
Manish Singh's avatar
Manish Singh committed
73
  GObjectClass *gobject_class;
74 75 76
  GtkWidgetClass *widget_class;
  GtkMenuItemClass *menu_item_class;
  
Manish Singh's avatar
Manish Singh committed
77
  gobject_class = G_OBJECT_CLASS (klass);
78 79 80
  widget_class = (GtkWidgetClass*) klass;
  menu_item_class = (GtkMenuItemClass*) klass;
  
Manish Singh's avatar
Manish Singh committed
81 82
  gobject_class->set_property = gtk_check_menu_item_set_property;
  gobject_class->get_property = gtk_check_menu_item_get_property;
83

Manish Singh's avatar
Manish Singh committed
84
  g_object_class_install_property (gobject_class,
85 86
                                   PROP_ACTIVE,
                                   g_param_spec_boolean ("active",
87 88
                                                         P_("Active"),
                                                         P_("Whether the menu item is checked"),
89
                                                         FALSE,
90
                                                         GTK_PARAM_READWRITE));
91
  
Manish Singh's avatar
Manish Singh committed
92
  g_object_class_install_property (gobject_class,
Owen Taylor's avatar
Owen Taylor committed
93
                                   PROP_INCONSISTENT,
94
                                   g_param_spec_boolean ("inconsistent",
95 96
                                                         P_("Inconsistent"),
                                                         P_("Whether to display an \"inconsistent\" state"),
97
                                                         FALSE,
98
                                                         GTK_PARAM_READWRITE));
99
  
100
  g_object_class_install_property (gobject_class,
101
                                   PROP_DRAW_AS_RADIO,
102
                                   g_param_spec_boolean ("draw-as-radio",
103 104
                                                         P_("Draw as radio menu item"),
                                                         P_("Whether the menu item looks like a radio menu item"),
105
                                                         FALSE,
106
                                                         GTK_PARAM_READWRITE));
107
  
108
  gtk_widget_class_install_style_property (widget_class,
109
                                           g_param_spec_int ("indicator-size",
110 111 112 113 114
                                                             P_("Indicator Size")
,
                                                             P_("Size of check or radio indicator"),
                                                             0,
                                                             G_MAXINT,
115
                                                             13,
116
                                                             GTK_PARAM_READABLE));
117

118 119 120 121
  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;
122
  menu_item_class->toggle_size_request = gtk_check_menu_item_toggle_size_request;
123 124 125 126 127
  
  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
128
    g_signal_new (I_("toggled"),
Manish Singh's avatar
Manish Singh committed
129 130 131 132 133 134
		  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);
135 136
}

Elliot Lee's avatar
Elliot Lee committed
137
GtkWidget*
138
gtk_check_menu_item_new (void)
Elliot Lee's avatar
Elliot Lee committed
139
{
Manish Singh's avatar
Manish Singh committed
140
  return g_object_new (GTK_TYPE_CHECK_MENU_ITEM, NULL);
Elliot Lee's avatar
Elliot Lee committed
141 142 143 144 145
}

GtkWidget*
gtk_check_menu_item_new_with_label (const gchar *label)
{
146 147 148
  return g_object_new (GTK_TYPE_CHECK_MENU_ITEM, 
		       "label", label,
		       NULL);
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
}


/**
 * 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)
{
165 166 167 168
  return g_object_new (GTK_TYPE_CHECK_MENU_ITEM, 
		       "label", label,
		       "use-underline", TRUE,
		       NULL);
Elliot Lee's avatar
Elliot Lee committed
169 170
}

171 172 173
void
gtk_check_menu_item_set_active (GtkCheckMenuItem *check_menu_item,
				gboolean          is_active)
Elliot Lee's avatar
Elliot Lee committed
174 175 176
{
  g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));

177 178 179
  is_active = is_active != 0;

  if (check_menu_item->active != is_active)
180
    gtk_menu_item_activate (GTK_MENU_ITEM (check_menu_item));
Elliot Lee's avatar
Elliot Lee committed
181 182
}

183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
/**
 * 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;
}

200 201
static void
gtk_check_menu_item_toggle_size_request (GtkMenuItem *menu_item,
202
					 gint        *requisition)
203
{
204
  guint toggle_spacing;
205
  guint indicator_size;
206
  
207
  g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (menu_item));
208 209
  
  gtk_widget_style_get (GTK_WIDGET (menu_item),
210 211
			"toggle-spacing", &toggle_spacing,
			"indicator-size", &indicator_size,
212
			NULL);
213 214

  *requisition = indicator_size + toggle_spacing;
215 216
}

217 218 219 220 221
void
gtk_check_menu_item_set_show_toggle (GtkCheckMenuItem *menu_item,
				     gboolean          always)
{
  g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (menu_item));
222 223

#if 0
224
  menu_item->always_show_toggle = always != FALSE;
225
#endif  
226 227
}

Elliot Lee's avatar
Elliot Lee committed
228 229 230
void
gtk_check_menu_item_toggled (GtkCheckMenuItem *check_menu_item)
{
Manish Singh's avatar
Manish Singh committed
231
  g_signal_emit (check_menu_item, check_menu_item_signals[TOGGLED], 0);
Elliot Lee's avatar
Elliot Lee committed
232 233
}

234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
/**
 * 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));
261
      g_object_notify (G_OBJECT (check_menu_item), "inconsistent");
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
    }
}

/**
 * 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;
}

281 282 283 284 285 286 287
/**
 * 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
288
 * Since: 2.4
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
 **/
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));

304
      g_object_notify (G_OBJECT (check_menu_item), "draw-as-radio");
305 306 307 308 309 310 311 312 313 314
    }
}

/**
 * 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
315 316
 * 
 * Since: 2.4
317 318 319 320 321 322 323 324 325
 **/
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
326 327 328 329
static void
gtk_check_menu_item_init (GtkCheckMenuItem *check_menu_item)
{
  check_menu_item->active = FALSE;
330
  check_menu_item->always_show_toggle = TRUE;
Elliot Lee's avatar
Elliot Lee committed
331 332 333 334 335 336
}

static gint
gtk_check_menu_item_expose (GtkWidget      *widget,
			    GdkEventExpose *event)
{
Matthias Clasen's avatar
Matthias Clasen committed
337
  if (GTK_WIDGET_CLASS (gtk_check_menu_item_parent_class)->expose_event)
338
    GTK_WIDGET_CLASS (gtk_check_menu_item_parent_class)->expose_event (widget, event);
Elliot Lee's avatar
Elliot Lee committed
339 340 341 342 343 344 345 346 347

  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)
{
348
  GtkCheckMenuItem *check_menu_item = GTK_CHECK_MENU_ITEM (menu_item);
Elliot Lee's avatar
Elliot Lee committed
349 350 351 352
  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));
353

354
  g_object_notify (G_OBJECT (check_menu_item), "active");
Elliot Lee's avatar
Elliot Lee committed
355 356 357 358 359 360
}

static void
gtk_check_menu_item_draw_indicator (GtkCheckMenuItem *check_menu_item,
				    GdkRectangle     *area)
{
361
  if (GTK_CHECK_MENU_ITEM_GET_CLASS (check_menu_item)->draw_indicator)
362
    GTK_CHECK_MENU_ITEM_GET_CLASS (check_menu_item)->draw_indicator (check_menu_item, area);
Elliot Lee's avatar
Elliot Lee committed
363 364 365 366 367 368 369 370 371 372 373 374 375
}

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;

  if (GTK_WIDGET_DRAWABLE (check_menu_item))
    {
376 377 378 379
      guint offset;
      guint toggle_size;
      guint toggle_spacing;
      guint horizontal_padding;
380
      guint indicator_size;
381
      
Elliot Lee's avatar
Elliot Lee committed
382 383
      widget = GTK_WIDGET (check_menu_item);

384
      gtk_widget_style_get (GTK_WIDGET (check_menu_item),
385 386 387
 			    "toggle-spacing", &toggle_spacing,
 			    "horizontal-padding", &horizontal_padding,
			    "indicator-size", &indicator_size,
388 389 390
 			    NULL);

      toggle_size = GTK_MENU_ITEM (check_menu_item)->toggle_size;
391
      offset = GTK_CONTAINER (check_menu_item)->border_width +
392 393 394 395 396
	widget->style->xthickness + 2; 

      if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR)
	{
	  x = widget->allocation.x + offset + horizontal_padding +
397
	    (toggle_size - toggle_spacing - indicator_size) / 2;
398
	}
399
      else 
400 401 402
	{
	  x = widget->allocation.x + widget->allocation.width -
	    offset - horizontal_padding - toggle_size + toggle_spacing +
403
	    (toggle_size - toggle_spacing - indicator_size) / 2;
404 405
	}
      
406
      y = widget->allocation.y + (widget->allocation.height - indicator_size) / 2;
Elliot Lee's avatar
Elliot Lee committed
407 408

      if (check_menu_item->active ||
409
	  check_menu_item->always_show_toggle ||
Elliot Lee's avatar
Elliot Lee committed
410 411 412
	  (GTK_WIDGET_STATE (check_menu_item) == GTK_STATE_PRELIGHT))
	{
	  state_type = GTK_WIDGET_STATE (widget);
413
	  
414 415 416 417 418 419 420 421 422 423 424
	  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;
	  
	  if (!GTK_WIDGET_IS_SENSITIVE (widget))
	    state_type = GTK_STATE_INSENSITIVE;

	  if (check_menu_item->draw_as_radio)
425
	    {
426 427 428
	      gtk_paint_option (widget->style, widget->window,
				state_type, shadow_type,
				area, widget, "option",
429
				x, y, indicator_size, indicator_size);
430 431 432
	    }
	  else
	    {
433 434 435
	      gtk_paint_check (widget->style, widget->window,
			       state_type, shadow_type,
			       area, widget, "check",
436
			       x, y, indicator_size, indicator_size);
437
	    }
Elliot Lee's avatar
Elliot Lee committed
438 439 440
	}
    }
}
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458


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;
459 460 461
    case PROP_DRAW_AS_RADIO:
      g_value_set_boolean (value, checkitem->draw_as_radio);
      break;
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
    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;
485 486 487
    case PROP_DRAW_AS_RADIO:
      gtk_check_menu_item_set_draw_as_radio (checkitem, g_value_get_boolean (value));
      break;
488 489 490 491 492
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}
493 494 495

#define __GTK_CHECK_MENU_ITEM_C__
#include "gtkaliasdef.c"