1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
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.
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.
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.
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/.
27 #include "gtkcheckmenuitem.h"
28 #include "gtkaccellabel.h"
29 #include "gtksignal.h"
31 #include "gtkmarshalers.h"
33 #define CHECK_TOGGLE_SIZE 12
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,
53 static void gtk_check_menu_item_draw_indicator (GtkCheckMenuItem *check_menu_item,
55 static void gtk_real_check_menu_item_draw_indicator (GtkCheckMenuItem *check_menu_item,
57 static void gtk_check_menu_item_set_property (GObject *object,
61 static void gtk_check_menu_item_get_property (GObject *object,
67 static GtkMenuItemClass *parent_class = NULL;
68 static guint check_menu_item_signals[LAST_SIGNAL] = { 0 };
72 gtk_check_menu_item_get_type (void)
74 static GtkType check_menu_item_type = 0;
76 if (!check_menu_item_type)
78 static const GtkTypeInfo check_menu_item_info =
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,
90 check_menu_item_type = gtk_type_unique (GTK_TYPE_MENU_ITEM, &check_menu_item_info);
93 return check_menu_item_type;
97 gtk_check_menu_item_class_init (GtkCheckMenuItemClass *klass)
99 GtkObjectClass *object_class;
100 GtkWidgetClass *widget_class;
101 GtkMenuItemClass *menu_item_class;
103 object_class = (GtkObjectClass*) klass;
104 widget_class = (GtkWidgetClass*) klass;
105 menu_item_class = (GtkMenuItemClass*) klass;
107 parent_class = gtk_type_class (GTK_TYPE_MENU_ITEM);
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;
112 g_object_class_install_property (G_OBJECT_CLASS (object_class),
114 g_param_spec_boolean ("active",
116 _("Whether the menu item is checked."),
118 G_PARAM_READABLE | G_PARAM_WRITABLE));
120 g_object_class_install_property (G_OBJECT_CLASS (object_class),
122 g_param_spec_boolean ("inconsistent",
124 _("Whether to display an \"inconsistent\" state."),
126 G_PARAM_READABLE | G_PARAM_WRITABLE));
128 widget_class->expose_event = gtk_check_menu_item_expose;
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;
134 klass->toggled = NULL;
135 klass->draw_indicator = gtk_real_check_menu_item_draw_indicator;
137 check_menu_item_signals[TOGGLED] =
138 gtk_signal_new ("toggled",
140 GTK_CLASS_TYPE (object_class),
141 GTK_SIGNAL_OFFSET (GtkCheckMenuItemClass, toggled),
142 _gtk_marshal_VOID__VOID,
147 gtk_check_menu_item_new (void)
149 return GTK_WIDGET (gtk_type_new (GTK_TYPE_CHECK_MENU_ITEM));
153 gtk_check_menu_item_new_with_label (const gchar *label)
155 GtkWidget *check_menu_item;
156 GtkWidget *accel_label;
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);
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);
166 return check_menu_item;
171 * gtk_check_menu_item_new_with_mnemonic:
172 * @label: The text of the button, with an underscore in front of the
174 * @returns: a new #GtkCheckMenuItem
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.
181 gtk_check_menu_item_new_with_mnemonic (const gchar *label)
183 GtkWidget *check_menu_item;
184 GtkWidget *accel_label;
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);
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);
195 return check_menu_item;
199 gtk_check_menu_item_set_active (GtkCheckMenuItem *check_menu_item,
202 g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
204 is_active = is_active != 0;
206 if (check_menu_item->active != is_active)
207 gtk_menu_item_activate (GTK_MENU_ITEM (check_menu_item));
211 * gtk_check_menu_item_get_active:
212 * @check_menu_item: a #GtkCheckMenuItem
214 * Returns whether the check menu item is active. See
215 * gtk_check_menu_item_set_active ().
217 * Return value: %TRUE if the menu item is checked.
220 gtk_check_menu_item_get_active (GtkCheckMenuItem *check_menu_item)
222 g_return_val_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item), FALSE);
224 return check_menu_item->active;
228 gtk_check_menu_item_toggle_size_request (GtkMenuItem *menu_item,
231 g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (menu_item));
233 *requisition = CHECK_TOGGLE_SIZE;
237 gtk_check_menu_item_set_show_toggle (GtkCheckMenuItem *menu_item,
240 g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (menu_item));
243 menu_item->always_show_toggle = always != FALSE;
248 gtk_check_menu_item_toggled (GtkCheckMenuItem *check_menu_item)
250 gtk_signal_emit (GTK_OBJECT (check_menu_item), check_menu_item_signals[TOGGLED]);
254 * gtk_check_menu_item_set_inconsistent:
255 * @check_menu_item: a #GtkCheckMenuItem
256 * @setting: %TRUE to display an "inconsistent" third state check
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.
269 gtk_check_menu_item_set_inconsistent (GtkCheckMenuItem *check_menu_item,
272 g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
274 setting = setting != FALSE;
276 if (setting != check_menu_item->inconsistent)
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");
285 * gtk_check_menu_item_get_inconsistent:
286 * @check_menu_item: a #GtkCheckMenuItem
288 * Retrieves the value set by gtk_check_menu_item_set_inconsistent().
290 * Return value: %TRUE if inconsistent
293 gtk_check_menu_item_get_inconsistent (GtkCheckMenuItem *check_menu_item)
295 g_return_val_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item), FALSE);
297 return check_menu_item->inconsistent;
301 gtk_check_menu_item_init (GtkCheckMenuItem *check_menu_item)
303 check_menu_item->active = FALSE;
304 check_menu_item->always_show_toggle = TRUE;
308 gtk_check_menu_item_expose (GtkWidget *widget,
309 GdkEventExpose *event)
311 g_return_val_if_fail (widget != NULL, FALSE);
312 g_return_val_if_fail (GTK_IS_CHECK_MENU_ITEM (widget), FALSE);
313 g_return_val_if_fail (event != NULL, FALSE);
315 if (GTK_WIDGET_CLASS (parent_class)->expose_event)
316 (* GTK_WIDGET_CLASS (parent_class)->expose_event) (widget, event);
318 gtk_check_menu_item_draw_indicator (GTK_CHECK_MENU_ITEM (widget), &event->area);
324 gtk_check_menu_item_activate (GtkMenuItem *menu_item)
326 GtkCheckMenuItem *check_menu_item;
328 g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (menu_item));
330 check_menu_item = GTK_CHECK_MENU_ITEM (menu_item);
331 check_menu_item->active = !check_menu_item->active;
333 gtk_check_menu_item_toggled (check_menu_item);
334 gtk_widget_queue_draw (GTK_WIDGET (check_menu_item));
336 g_object_notify (G_OBJECT(check_menu_item), "active");
340 gtk_check_menu_item_draw_indicator (GtkCheckMenuItem *check_menu_item,
343 g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
344 g_return_if_fail (GTK_CHECK_MENU_ITEM_GET_CLASS (check_menu_item) != NULL);
346 if (GTK_CHECK_MENU_ITEM_GET_CLASS (check_menu_item)->draw_indicator)
347 (* GTK_CHECK_MENU_ITEM_GET_CLASS (check_menu_item)->draw_indicator) (check_menu_item, area);
351 gtk_real_check_menu_item_draw_indicator (GtkCheckMenuItem *check_menu_item,
355 GtkStateType state_type;
356 GtkShadowType shadow_type;
360 g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
362 if (GTK_WIDGET_DRAWABLE (check_menu_item))
364 widget = GTK_WIDGET (check_menu_item);
368 x = widget->allocation.x + (GTK_CONTAINER (check_menu_item)->border_width +
369 widget->style->xthickness + 2);
370 y = widget->allocation.y + (widget->allocation.height - height) / 2;
372 if (check_menu_item->active ||
373 check_menu_item->always_show_toggle ||
374 (GTK_WIDGET_STATE (check_menu_item) == GTK_STATE_PRELIGHT))
376 state_type = GTK_WIDGET_STATE (widget);
378 if (check_menu_item->always_show_toggle)
380 shadow_type = GTK_SHADOW_OUT;
381 if (check_menu_item->active)
382 shadow_type = GTK_SHADOW_IN;
386 shadow_type = GTK_SHADOW_IN;
387 if (check_menu_item->active &&
388 (state_type == GTK_STATE_PRELIGHT))
389 shadow_type = GTK_SHADOW_OUT;
392 if (check_menu_item->inconsistent)
394 shadow_type = GTK_SHADOW_ETCHED_IN;
395 if (state_type == GTK_STATE_ACTIVE)
396 state_type = GTK_STATE_NORMAL;
399 gtk_paint_check (widget->style, widget->window,
400 state_type, shadow_type,
401 area, widget, "check",
402 x, y, width, height);
409 gtk_check_menu_item_get_property (GObject *object,
414 GtkCheckMenuItem *checkitem = GTK_CHECK_MENU_ITEM (object);
419 g_value_set_boolean (value, checkitem->active);
421 case PROP_INCONSISTENT:
422 g_value_set_boolean (value, checkitem->inconsistent);
425 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
432 gtk_check_menu_item_set_property (GObject *object,
437 GtkCheckMenuItem *checkitem = GTK_CHECK_MENU_ITEM (object);
442 gtk_check_menu_item_set_active (checkitem, g_value_get_boolean (value));
444 case PROP_INCONSISTENT:
445 gtk_check_menu_item_set_inconsistent (checkitem, g_value_get_boolean (value));
448 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);