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"
30 #include "gtkmarshalers.h"
32 #define CHECK_TOGGLE_SIZE 12
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,
52 static void gtk_check_menu_item_draw_indicator (GtkCheckMenuItem *check_menu_item,
54 static void gtk_real_check_menu_item_draw_indicator (GtkCheckMenuItem *check_menu_item,
56 static void gtk_check_menu_item_set_property (GObject *object,
60 static void gtk_check_menu_item_get_property (GObject *object,
66 static GtkMenuItemClass *parent_class = NULL;
67 static guint check_menu_item_signals[LAST_SIGNAL] = { 0 };
71 gtk_check_menu_item_get_type (void)
73 static GType check_menu_item_type = 0;
75 if (!check_menu_item_type)
77 static const GTypeInfo check_menu_item_info =
79 sizeof (GtkCheckMenuItemClass),
81 NULL, /* base_finalize */
82 (GClassInitFunc) gtk_check_menu_item_class_init,
83 NULL, /* class_finalize */
84 NULL, /* class_data */
85 sizeof (GtkCheckMenuItem),
87 (GInstanceInitFunc) gtk_check_menu_item_init,
90 check_menu_item_type =
91 g_type_register_static (GTK_TYPE_MENU_ITEM, "GtkCheckMenuItem",
92 &check_menu_item_info, 0);
95 return check_menu_item_type;
99 gtk_check_menu_item_class_init (GtkCheckMenuItemClass *klass)
101 GObjectClass *gobject_class;
102 GtkWidgetClass *widget_class;
103 GtkMenuItemClass *menu_item_class;
105 gobject_class = G_OBJECT_CLASS (klass);
106 widget_class = (GtkWidgetClass*) klass;
107 menu_item_class = (GtkMenuItemClass*) klass;
109 parent_class = g_type_class_peek_parent (klass);
111 gobject_class->set_property = gtk_check_menu_item_set_property;
112 gobject_class->get_property = gtk_check_menu_item_get_property;
114 g_object_class_install_property (gobject_class,
116 g_param_spec_boolean ("active",
118 _("Whether the menu item is checked"),
122 g_object_class_install_property (gobject_class,
124 g_param_spec_boolean ("inconsistent",
126 _("Whether to display an \"inconsistent\" state"),
130 widget_class->expose_event = gtk_check_menu_item_expose;
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;
136 klass->toggled = NULL;
137 klass->draw_indicator = gtk_real_check_menu_item_draw_indicator;
139 check_menu_item_signals[TOGGLED] =
140 g_signal_new ("toggled",
141 G_OBJECT_CLASS_TYPE (gobject_class),
143 G_STRUCT_OFFSET (GtkCheckMenuItemClass, toggled),
145 _gtk_marshal_VOID__VOID,
150 gtk_check_menu_item_new (void)
152 return g_object_new (GTK_TYPE_CHECK_MENU_ITEM, NULL);
156 gtk_check_menu_item_new_with_label (const gchar *label)
158 GtkWidget *check_menu_item;
159 GtkWidget *accel_label;
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);
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);
169 return check_menu_item;
174 * gtk_check_menu_item_new_with_mnemonic:
175 * @label: The text of the button, with an underscore in front of the
177 * @returns: a new #GtkCheckMenuItem
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.
184 gtk_check_menu_item_new_with_mnemonic (const gchar *label)
186 GtkWidget *check_menu_item;
187 GtkWidget *accel_label;
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);
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);
198 return check_menu_item;
202 gtk_check_menu_item_set_active (GtkCheckMenuItem *check_menu_item,
205 g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
207 is_active = is_active != 0;
209 if (check_menu_item->active != is_active)
210 gtk_menu_item_activate (GTK_MENU_ITEM (check_menu_item));
214 * gtk_check_menu_item_get_active:
215 * @check_menu_item: a #GtkCheckMenuItem
217 * Returns whether the check menu item is active. See
218 * gtk_check_menu_item_set_active ().
220 * Return value: %TRUE if the menu item is checked.
223 gtk_check_menu_item_get_active (GtkCheckMenuItem *check_menu_item)
225 g_return_val_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item), FALSE);
227 return check_menu_item->active;
231 gtk_check_menu_item_toggle_size_request (GtkMenuItem *menu_item,
234 guint toggle_spacing;
236 g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (menu_item));
238 gtk_widget_style_get (GTK_WIDGET (menu_item),
239 "toggle_spacing", &toggle_spacing,
242 *requisition = CHECK_TOGGLE_SIZE + toggle_spacing;
246 gtk_check_menu_item_set_show_toggle (GtkCheckMenuItem *menu_item,
249 g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (menu_item));
252 menu_item->always_show_toggle = always != FALSE;
257 gtk_check_menu_item_toggled (GtkCheckMenuItem *check_menu_item)
259 g_signal_emit (check_menu_item, check_menu_item_signals[TOGGLED], 0);
263 * gtk_check_menu_item_set_inconsistent:
264 * @check_menu_item: a #GtkCheckMenuItem
265 * @setting: %TRUE to display an "inconsistent" third state check
267 * If the user has selected a range of elements (such as some text or
268 * spreadsheet cells) that are affected by a boolean setting, and the
269 * current values in that range are inconsistent, you may want to
270 * display the check in an "in between" state. This function turns on
271 * "in between" display. Normally you would turn off the inconsistent
272 * state again if the user explicitly selects a setting. This has to be
273 * done manually, gtk_check_menu_item_set_inconsistent() only affects
274 * visual appearance, it doesn't affect the semantics of the widget.
278 gtk_check_menu_item_set_inconsistent (GtkCheckMenuItem *check_menu_item,
281 g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
283 setting = setting != FALSE;
285 if (setting != check_menu_item->inconsistent)
287 check_menu_item->inconsistent = setting;
288 gtk_widget_queue_draw (GTK_WIDGET (check_menu_item));
289 g_object_notify (G_OBJECT (check_menu_item), "inconsistent");
294 * gtk_check_menu_item_get_inconsistent:
295 * @check_menu_item: a #GtkCheckMenuItem
297 * Retrieves the value set by gtk_check_menu_item_set_inconsistent().
299 * Return value: %TRUE if inconsistent
302 gtk_check_menu_item_get_inconsistent (GtkCheckMenuItem *check_menu_item)
304 g_return_val_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item), FALSE);
306 return check_menu_item->inconsistent;
310 gtk_check_menu_item_init (GtkCheckMenuItem *check_menu_item)
312 check_menu_item->active = FALSE;
313 check_menu_item->always_show_toggle = TRUE;
317 gtk_check_menu_item_expose (GtkWidget *widget,
318 GdkEventExpose *event)
320 if (GTK_WIDGET_CLASS (parent_class)->expose_event)
321 (* GTK_WIDGET_CLASS (parent_class)->expose_event) (widget, event);
323 gtk_check_menu_item_draw_indicator (GTK_CHECK_MENU_ITEM (widget), &event->area);
329 gtk_check_menu_item_activate (GtkMenuItem *menu_item)
331 GtkCheckMenuItem *check_menu_item = GTK_CHECK_MENU_ITEM (menu_item);
332 check_menu_item->active = !check_menu_item->active;
334 gtk_check_menu_item_toggled (check_menu_item);
335 gtk_widget_queue_draw (GTK_WIDGET (check_menu_item));
337 g_object_notify (G_OBJECT (check_menu_item), "active");
341 gtk_check_menu_item_draw_indicator (GtkCheckMenuItem *check_menu_item,
344 if (GTK_CHECK_MENU_ITEM_GET_CLASS (check_menu_item)->draw_indicator)
345 (* GTK_CHECK_MENU_ITEM_GET_CLASS (check_menu_item)->draw_indicator) (check_menu_item, area);
349 gtk_real_check_menu_item_draw_indicator (GtkCheckMenuItem *check_menu_item,
353 GtkStateType state_type;
354 GtkShadowType shadow_type;
358 if (GTK_WIDGET_DRAWABLE (check_menu_item))
362 guint toggle_spacing;
363 guint horizontal_padding;
365 widget = GTK_WIDGET (check_menu_item);
367 gtk_widget_style_get (GTK_WIDGET (check_menu_item),
368 "toggle_spacing", &toggle_spacing,
369 "horizontal_padding", &horizontal_padding,
375 toggle_size = GTK_MENU_ITEM (check_menu_item)->toggle_size;
376 offset = GTK_CONTAINER (check_menu_item)->border_width + widget->style->xthickness;
378 offset = GTK_CONTAINER (check_menu_item)->border_width +
379 widget->style->xthickness + 2;
381 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR)
383 x = widget->allocation.x + offset + horizontal_padding +
384 (toggle_size - toggle_spacing - width) / 2;
388 x = widget->allocation.x + widget->allocation.width -
389 offset - horizontal_padding - toggle_size + toggle_spacing +
390 (toggle_size - toggle_spacing - width) / 2;
393 y = widget->allocation.y + (widget->allocation.height - height) / 2;
395 if (check_menu_item->active ||
396 check_menu_item->always_show_toggle ||
397 (GTK_WIDGET_STATE (check_menu_item) == GTK_STATE_PRELIGHT))
399 state_type = GTK_WIDGET_STATE (widget);
401 if (check_menu_item->always_show_toggle)
403 shadow_type = GTK_SHADOW_OUT;
404 if (check_menu_item->active)
405 shadow_type = GTK_SHADOW_IN;
409 shadow_type = GTK_SHADOW_IN;
410 if (check_menu_item->active &&
411 (state_type == GTK_STATE_PRELIGHT))
412 shadow_type = GTK_SHADOW_OUT;
415 if (check_menu_item->inconsistent)
417 shadow_type = GTK_SHADOW_ETCHED_IN;
418 if (state_type == GTK_STATE_ACTIVE)
419 state_type = GTK_STATE_NORMAL;
422 if (!GTK_WIDGET_IS_SENSITIVE (widget))
423 state_type = GTK_STATE_INSENSITIVE;
425 gtk_paint_check (widget->style, widget->window,
426 state_type, shadow_type,
427 area, widget, "check",
428 x, y, width, height);
435 gtk_check_menu_item_get_property (GObject *object,
440 GtkCheckMenuItem *checkitem = GTK_CHECK_MENU_ITEM (object);
445 g_value_set_boolean (value, checkitem->active);
447 case PROP_INCONSISTENT:
448 g_value_set_boolean (value, checkitem->inconsistent);
451 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
458 gtk_check_menu_item_set_property (GObject *object,
463 GtkCheckMenuItem *checkitem = GTK_CHECK_MENU_ITEM (object);
468 gtk_check_menu_item_set_active (checkitem, g_value_get_boolean (value));
470 case PROP_INCONSISTENT:
471 gtk_check_menu_item_set_inconsistent (checkitem, g_value_get_boolean (value));
474 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);