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
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 GType check_menu_item_type = 0;
76 if (!check_menu_item_type)
78 static const GTypeInfo check_menu_item_info =
80 sizeof (GtkCheckMenuItemClass),
82 NULL, /* base_finalize */
83 (GClassInitFunc) gtk_check_menu_item_class_init,
84 NULL, /* class_finalize */
85 NULL, /* class_data */
86 sizeof (GtkCheckMenuItem),
88 (GInstanceInitFunc) gtk_check_menu_item_init,
91 check_menu_item_type =
92 g_type_register_static (GTK_TYPE_MENU_ITEM, "GtkCheckMenuItem",
93 &check_menu_item_info, 0);
96 return check_menu_item_type;
100 gtk_check_menu_item_class_init (GtkCheckMenuItemClass *klass)
102 GObjectClass *gobject_class;
103 GtkWidgetClass *widget_class;
104 GtkMenuItemClass *menu_item_class;
106 gobject_class = G_OBJECT_CLASS (klass);
107 widget_class = (GtkWidgetClass*) klass;
108 menu_item_class = (GtkMenuItemClass*) klass;
110 parent_class = g_type_class_peek_parent (klass);
112 gobject_class->set_property = gtk_check_menu_item_set_property;
113 gobject_class->get_property = gtk_check_menu_item_get_property;
115 g_object_class_install_property (gobject_class,
117 g_param_spec_boolean ("active",
119 _("Whether the menu item is checked"),
123 g_object_class_install_property (gobject_class,
125 g_param_spec_boolean ("inconsistent",
127 _("Whether to display an \"inconsistent\" state"),
131 g_object_class_install_property (gobject_class,
133 g_param_spec_boolean ("draw_as_radio",
134 _("Draw as radio menu item"),
135 _("Whether the menu item looks like a radio menu item"),
139 widget_class->expose_event = gtk_check_menu_item_expose;
141 menu_item_class->activate = gtk_check_menu_item_activate;
142 menu_item_class->hide_on_activate = FALSE;
143 menu_item_class->toggle_size_request = gtk_check_menu_item_toggle_size_request;
145 klass->toggled = NULL;
146 klass->draw_indicator = gtk_real_check_menu_item_draw_indicator;
148 check_menu_item_signals[TOGGLED] =
149 g_signal_new ("toggled",
150 G_OBJECT_CLASS_TYPE (gobject_class),
152 G_STRUCT_OFFSET (GtkCheckMenuItemClass, toggled),
154 _gtk_marshal_VOID__VOID,
159 gtk_check_menu_item_new (void)
161 return g_object_new (GTK_TYPE_CHECK_MENU_ITEM, NULL);
165 gtk_check_menu_item_new_with_label (const gchar *label)
167 GtkWidget *check_menu_item;
168 GtkWidget *accel_label;
170 check_menu_item = gtk_check_menu_item_new ();
171 accel_label = gtk_accel_label_new (label);
172 gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
174 gtk_container_add (GTK_CONTAINER (check_menu_item), accel_label);
175 gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label), check_menu_item);
176 gtk_widget_show (accel_label);
178 return check_menu_item;
183 * gtk_check_menu_item_new_with_mnemonic:
184 * @label: The text of the button, with an underscore in front of the
186 * @returns: a new #GtkCheckMenuItem
188 * Creates a new #GtkCheckMenuItem containing a label. The label
189 * will be created using gtk_label_new_with_mnemonic(), so underscores
190 * in @label indicate the mnemonic for the menu item.
193 gtk_check_menu_item_new_with_mnemonic (const gchar *label)
195 GtkWidget *check_menu_item;
196 GtkWidget *accel_label;
198 check_menu_item = gtk_check_menu_item_new ();
199 accel_label = g_object_new (GTK_TYPE_ACCEL_LABEL, NULL);
200 gtk_label_set_text_with_mnemonic (GTK_LABEL (accel_label), label);
201 gtk_misc_set_alignment (GTK_MISC (accel_label), 0.0, 0.5);
203 gtk_container_add (GTK_CONTAINER (check_menu_item), accel_label);
204 gtk_accel_label_set_accel_widget (GTK_ACCEL_LABEL (accel_label), check_menu_item);
205 gtk_widget_show (accel_label);
207 return check_menu_item;
211 gtk_check_menu_item_set_active (GtkCheckMenuItem *check_menu_item,
214 g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
216 is_active = is_active != 0;
218 if (check_menu_item->active != is_active)
219 gtk_menu_item_activate (GTK_MENU_ITEM (check_menu_item));
223 * gtk_check_menu_item_get_active:
224 * @check_menu_item: a #GtkCheckMenuItem
226 * Returns whether the check menu item is active. See
227 * gtk_check_menu_item_set_active ().
229 * Return value: %TRUE if the menu item is checked.
232 gtk_check_menu_item_get_active (GtkCheckMenuItem *check_menu_item)
234 g_return_val_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item), FALSE);
236 return check_menu_item->active;
240 gtk_check_menu_item_toggle_size_request (GtkMenuItem *menu_item,
243 guint toggle_spacing;
245 g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (menu_item));
247 gtk_widget_style_get (GTK_WIDGET (menu_item),
248 "toggle_spacing", &toggle_spacing,
251 *requisition = CHECK_TOGGLE_SIZE + toggle_spacing;
255 gtk_check_menu_item_set_show_toggle (GtkCheckMenuItem *menu_item,
258 g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (menu_item));
261 menu_item->always_show_toggle = always != FALSE;
266 gtk_check_menu_item_toggled (GtkCheckMenuItem *check_menu_item)
268 g_signal_emit (check_menu_item, check_menu_item_signals[TOGGLED], 0);
272 * gtk_check_menu_item_set_inconsistent:
273 * @check_menu_item: a #GtkCheckMenuItem
274 * @setting: %TRUE to display an "inconsistent" third state check
276 * If the user has selected a range of elements (such as some text or
277 * spreadsheet cells) that are affected by a boolean setting, and the
278 * current values in that range are inconsistent, you may want to
279 * display the check in an "in between" state. This function turns on
280 * "in between" display. Normally you would turn off the inconsistent
281 * state again if the user explicitly selects a setting. This has to be
282 * done manually, gtk_check_menu_item_set_inconsistent() only affects
283 * visual appearance, it doesn't affect the semantics of the widget.
287 gtk_check_menu_item_set_inconsistent (GtkCheckMenuItem *check_menu_item,
290 g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
292 setting = setting != FALSE;
294 if (setting != check_menu_item->inconsistent)
296 check_menu_item->inconsistent = setting;
297 gtk_widget_queue_draw (GTK_WIDGET (check_menu_item));
298 g_object_notify (G_OBJECT (check_menu_item), "inconsistent");
303 * gtk_check_menu_item_get_inconsistent:
304 * @check_menu_item: a #GtkCheckMenuItem
306 * Retrieves the value set by gtk_check_menu_item_set_inconsistent().
308 * Return value: %TRUE if inconsistent
311 gtk_check_menu_item_get_inconsistent (GtkCheckMenuItem *check_menu_item)
313 g_return_val_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item), FALSE);
315 return check_menu_item->inconsistent;
319 * gtk_check_menu_item_set_draw_as_radio:
320 * @check_menu_item: a #GtkCheckMenuItem
321 * @draw_as_radio: whether @check_menu_item is drawn like a #GtkRadioMenuItem
323 * Sets whether @check_menu_item is drawn like a #GtkRadioMenuItem
327 gtk_check_menu_item_set_draw_as_radio (GtkCheckMenuItem *check_menu_item,
328 gboolean draw_as_radio)
330 g_return_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item));
332 draw_as_radio = draw_as_radio != FALSE;
334 if (draw_as_radio != check_menu_item->draw_as_radio)
336 check_menu_item->draw_as_radio = draw_as_radio;
338 gtk_widget_queue_draw (GTK_WIDGET (check_menu_item));
340 g_object_notify (G_OBJECT (check_menu_item), "draw_as_radio");
345 * gtk_check_menu_item_get_draw_as_radio:
346 * @check_menu_item: a #GtkCheckMenuItem
348 * Returns whether @check_menu_item looks like a #GtkRadioMenuItem
350 * Return value: Whether @check_menu_item looks like a #GtkRadioMenuItem
353 gtk_check_menu_item_get_draw_as_radio (GtkCheckMenuItem *check_menu_item)
355 g_return_val_if_fail (GTK_IS_CHECK_MENU_ITEM (check_menu_item), FALSE);
357 return check_menu_item->draw_as_radio;
361 gtk_check_menu_item_init (GtkCheckMenuItem *check_menu_item)
363 check_menu_item->active = FALSE;
364 check_menu_item->always_show_toggle = TRUE;
368 gtk_check_menu_item_expose (GtkWidget *widget,
369 GdkEventExpose *event)
371 if (GTK_WIDGET_CLASS (parent_class)->expose_event)
372 (* GTK_WIDGET_CLASS (parent_class)->expose_event) (widget, event);
374 gtk_check_menu_item_draw_indicator (GTK_CHECK_MENU_ITEM (widget), &event->area);
380 gtk_check_menu_item_activate (GtkMenuItem *menu_item)
382 GtkCheckMenuItem *check_menu_item = GTK_CHECK_MENU_ITEM (menu_item);
383 check_menu_item->active = !check_menu_item->active;
385 gtk_check_menu_item_toggled (check_menu_item);
386 gtk_widget_queue_draw (GTK_WIDGET (check_menu_item));
388 g_object_notify (G_OBJECT (check_menu_item), "active");
392 gtk_check_menu_item_draw_indicator (GtkCheckMenuItem *check_menu_item,
395 if (GTK_CHECK_MENU_ITEM_GET_CLASS (check_menu_item)->draw_indicator)
396 (* GTK_CHECK_MENU_ITEM_GET_CLASS (check_menu_item)->draw_indicator) (check_menu_item, area);
400 gtk_real_check_menu_item_draw_indicator (GtkCheckMenuItem *check_menu_item,
404 GtkStateType state_type;
405 GtkShadowType shadow_type;
409 if (GTK_WIDGET_DRAWABLE (check_menu_item))
413 guint toggle_spacing;
414 guint horizontal_padding;
416 widget = GTK_WIDGET (check_menu_item);
418 gtk_widget_style_get (GTK_WIDGET (check_menu_item),
419 "toggle_spacing", &toggle_spacing,
420 "horizontal_padding", &horizontal_padding,
426 toggle_size = GTK_MENU_ITEM (check_menu_item)->toggle_size;
427 offset = GTK_CONTAINER (check_menu_item)->border_width + widget->style->xthickness;
429 offset = GTK_CONTAINER (check_menu_item)->border_width +
430 widget->style->xthickness + 2;
432 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_LTR)
434 x = widget->allocation.x + offset + horizontal_padding +
435 (toggle_size - toggle_spacing - width) / 2;
439 x = widget->allocation.x + widget->allocation.width -
440 offset - horizontal_padding - toggle_size + toggle_spacing +
441 (toggle_size - toggle_spacing - width) / 2;
444 y = widget->allocation.y + (widget->allocation.height - height) / 2;
446 if (check_menu_item->active ||
447 check_menu_item->always_show_toggle ||
448 (GTK_WIDGET_STATE (check_menu_item) == GTK_STATE_PRELIGHT))
450 state_type = GTK_WIDGET_STATE (widget);
452 if (check_menu_item->inconsistent)
453 shadow_type = GTK_SHADOW_ETCHED_IN;
454 else if (check_menu_item->active)
455 shadow_type = GTK_SHADOW_IN;
457 shadow_type = GTK_SHADOW_OUT;
459 if (!GTK_WIDGET_IS_SENSITIVE (widget))
460 state_type = GTK_STATE_INSENSITIVE;
462 if (check_menu_item->draw_as_radio)
464 gtk_paint_option (widget->style, widget->window,
465 state_type, shadow_type,
466 area, widget, "option",
467 x, y, width, height);
471 gtk_paint_check (widget->style, widget->window,
472 state_type, shadow_type,
473 area, widget, "check",
474 x, y, width, height);
482 gtk_check_menu_item_get_property (GObject *object,
487 GtkCheckMenuItem *checkitem = GTK_CHECK_MENU_ITEM (object);
492 g_value_set_boolean (value, checkitem->active);
494 case PROP_INCONSISTENT:
495 g_value_set_boolean (value, checkitem->inconsistent);
497 case PROP_DRAW_AS_RADIO:
498 g_value_set_boolean (value, checkitem->draw_as_radio);
501 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
508 gtk_check_menu_item_set_property (GObject *object,
513 GtkCheckMenuItem *checkitem = GTK_CHECK_MENU_ITEM (object);
518 gtk_check_menu_item_set_active (checkitem, g_value_get_boolean (value));
520 case PROP_INCONSISTENT:
521 gtk_check_menu_item_set_inconsistent (checkitem, g_value_get_boolean (value));
523 case PROP_DRAW_AS_RADIO:
524 gtk_check_menu_item_set_draw_as_radio (checkitem, g_value_get_boolean (value));
527 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);