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, see <http://www.gnu.org/licenses/>.
19 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
20 * file for a list of people on the GTK+ Team. See the ChangeLog
21 * files for a list of changes. These files are distributed with
22 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
26 #include "gtkaccellabel.h"
27 #include "gtkmarshalers.h"
28 #include "gtkradiomenuitem.h"
29 #include "gtkactivatable.h"
30 #include "gtkprivate.h"
32 #include "a11y/gtkradiomenuitemaccessible.h"
35 * SECTION:gtkradiomenuitem
36 * @Short_description: A choice from multiple check menu items
37 * @Title: GtkRadioMenuItem
38 * @See_also: #GtkMenuItem, #GtkCheckMenuItem
40 * A radio menu item is a check menu item that belongs to a group. At each
41 * instant exactly one of the radio menu items from a group is selected.
43 * The group list does not need to be freed, as each #GtkRadioMenuItem will
44 * remove itself and its list item when it is destroyed.
46 * The correct way to create a group of radio menu items is approximatively
50 * <title>How to create a group of radio menu items.</title>
52 * GSList *group = NULL;
56 * for (i = 0; i < 5; i++)
58 * item = gtk_radio_menu_item_new_with_label (group, "This is an example");
59 * group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (item));
61 * gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (item), TRUE);
68 struct _GtkRadioMenuItemPrivate
79 static void gtk_radio_menu_item_destroy (GtkWidget *widget);
80 static void gtk_radio_menu_item_activate (GtkMenuItem *menu_item);
81 static void gtk_radio_menu_item_set_property (GObject *object,
85 static void gtk_radio_menu_item_get_property (GObject *object,
90 static guint group_changed_signal = 0;
92 G_DEFINE_TYPE (GtkRadioMenuItem, gtk_radio_menu_item, GTK_TYPE_CHECK_MENU_ITEM)
95 * gtk_radio_menu_item_new:
96 * @group: (element-type GtkRadioMenuItem): the group to which the
97 * radio menu item is to be attached
99 * Creates a new #GtkRadioMenuItem.
101 * Returns: a new #GtkRadioMenuItem
104 gtk_radio_menu_item_new (GSList *group)
106 GtkRadioMenuItem *radio_menu_item;
108 radio_menu_item = g_object_new (GTK_TYPE_RADIO_MENU_ITEM, NULL);
110 gtk_radio_menu_item_set_group (radio_menu_item, group);
112 return GTK_WIDGET (radio_menu_item);
116 gtk_radio_menu_item_set_property (GObject *object,
121 GtkRadioMenuItem *radio_menu_item;
123 radio_menu_item = GTK_RADIO_MENU_ITEM (object);
130 slist = g_value_get_object (value);
132 slist = gtk_radio_menu_item_get_group ((GtkRadioMenuItem*) g_value_get_object (value));
133 gtk_radio_menu_item_set_group (radio_menu_item, slist);
136 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
142 gtk_radio_menu_item_get_property (GObject *object,
150 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
156 * gtk_radio_menu_item_set_group:
157 * @radio_menu_item: a #GtkRadioMenuItem.
158 * @group: (element-type GtkRadioMenuItem): the new group.
160 * Sets the group of a radio menu item, or changes it.
163 gtk_radio_menu_item_set_group (GtkRadioMenuItem *radio_menu_item,
166 GtkRadioMenuItemPrivate *priv;
167 GtkWidget *old_group_singleton = NULL;
168 GtkWidget *new_group_singleton = NULL;
170 g_return_if_fail (GTK_IS_RADIO_MENU_ITEM (radio_menu_item));
171 g_return_if_fail (!g_slist_find (group, radio_menu_item));
173 priv = radio_menu_item->priv;
179 priv->group = g_slist_remove (priv->group, radio_menu_item);
181 if (priv->group && !priv->group->next)
182 old_group_singleton = g_object_ref (priv->group->data);
184 for (slist = priv->group; slist; slist = slist->next)
186 GtkRadioMenuItem *tmp_item;
188 tmp_item = slist->data;
190 tmp_item->priv->group = priv->group;
194 if (group && !group->next)
195 new_group_singleton = g_object_ref (group->data);
197 priv->group = g_slist_prepend (group, radio_menu_item);
203 for (slist = group; slist; slist = slist->next)
205 GtkRadioMenuItem *tmp_item;
207 tmp_item = slist->data;
209 tmp_item->priv->group = priv->group;
214 _gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (radio_menu_item), TRUE);
215 /* gtk_widget_set_state (GTK_WIDGET (radio_menu_item), GTK_STATE_ACTIVE);
219 g_object_ref (radio_menu_item);
221 g_object_notify (G_OBJECT (radio_menu_item), "group");
222 g_signal_emit (radio_menu_item, group_changed_signal, 0);
223 if (old_group_singleton)
225 g_signal_emit (old_group_singleton, group_changed_signal, 0);
226 g_object_unref (old_group_singleton);
228 if (new_group_singleton)
230 g_signal_emit (new_group_singleton, group_changed_signal, 0);
231 g_object_unref (new_group_singleton);
234 g_object_unref (radio_menu_item);
239 * gtk_radio_menu_item_new_with_label:
240 * @group: (element-type GtkRadioMenuItem) (transfer full):
241 * @label: the text for the label
243 * Creates a new #GtkRadioMenuItem whose child is a simple #GtkLabel.
245 * Returns: (transfer none): A new #GtkRadioMenuItem
248 gtk_radio_menu_item_new_with_label (GSList *group,
251 return g_object_new (GTK_TYPE_RADIO_MENU_ITEM,
252 "group", (group) ? group->data : NULL,
259 * gtk_radio_menu_item_new_with_mnemonic:
260 * @group: (element-type GtkRadioMenuItem): group the radio menu item is inside
261 * @label: the text of the button, with an underscore in front of the
264 * Creates a new #GtkRadioMenuItem containing a label. The label
265 * will be created using gtk_label_new_with_mnemonic(), so underscores
266 * in @label indicate the mnemonic for the menu item.
268 * Returns: a new #GtkRadioMenuItem
271 gtk_radio_menu_item_new_with_mnemonic (GSList *group,
274 return g_object_new (GTK_TYPE_RADIO_MENU_ITEM,
275 "group", (group) ? group->data : NULL,
277 "use-underline", TRUE,
282 * gtk_radio_menu_item_new_from_widget: (constructor)
283 * @group: An existing #GtkRadioMenuItem
285 * Creates a new #GtkRadioMenuItem adding it to the same group as @group.
287 * Return value: (transfer none): The new #GtkRadioMenuItem
292 gtk_radio_menu_item_new_from_widget (GtkRadioMenuItem *group)
296 g_return_val_if_fail (GTK_IS_RADIO_MENU_ITEM (group), NULL);
299 list = gtk_radio_menu_item_get_group (group);
301 return gtk_radio_menu_item_new (list);
305 * gtk_radio_menu_item_new_with_mnemonic_from_widget: (constructor)
306 * @group: An existing #GtkRadioMenuItem
307 * @label: the text of the button, with an underscore in front of the
310 * Creates a new GtkRadioMenuItem containing a label. The label will be
311 * created using gtk_label_new_with_mnemonic(), so underscores in label
312 * indicate the mnemonic for the menu item.
314 * The new #GtkRadioMenuItem is added to the same group as @group.
316 * Return value: (transfer none): The new #GtkRadioMenuItem
321 gtk_radio_menu_item_new_with_mnemonic_from_widget (GtkRadioMenuItem *group,
326 g_return_val_if_fail (GTK_IS_RADIO_MENU_ITEM (group), NULL);
329 list = gtk_radio_menu_item_get_group (group);
331 return gtk_radio_menu_item_new_with_mnemonic (list, label);
335 * gtk_radio_menu_item_new_with_label_from_widget: (constructor)
336 * @group: an existing #GtkRadioMenuItem
337 * @label: the text for the label
339 * Creates a new GtkRadioMenuItem whose child is a simple GtkLabel.
340 * The new #GtkRadioMenuItem is added to the same group as @group.
342 * Return value: (transfer none): The new #GtkRadioMenuItem
347 gtk_radio_menu_item_new_with_label_from_widget (GtkRadioMenuItem *group,
352 g_return_val_if_fail (GTK_IS_RADIO_MENU_ITEM (group), NULL);
355 list = gtk_radio_menu_item_get_group (group);
357 return gtk_radio_menu_item_new_with_label (list, label);
361 * gtk_radio_menu_item_get_group:
362 * @radio_menu_item: a #GtkRadioMenuItem
364 * Returns the group to which the radio menu item belongs, as a #GList of
365 * #GtkRadioMenuItem. The list belongs to GTK+ and should not be freed.
367 * Returns: (element-type GtkRadioMenuItem) (transfer none): the group
368 * of @radio_menu_item
371 gtk_radio_menu_item_get_group (GtkRadioMenuItem *radio_menu_item)
373 g_return_val_if_fail (GTK_IS_RADIO_MENU_ITEM (radio_menu_item), NULL);
375 return radio_menu_item->priv->group;
379 gtk_radio_menu_item_class_init (GtkRadioMenuItemClass *klass)
381 GObjectClass *gobject_class;
382 GtkWidgetClass *widget_class;
383 GtkMenuItemClass *menu_item_class;
385 gobject_class = G_OBJECT_CLASS (klass);
386 widget_class = GTK_WIDGET_CLASS (klass);
387 menu_item_class = GTK_MENU_ITEM_CLASS (klass);
389 gobject_class->set_property = gtk_radio_menu_item_set_property;
390 gobject_class->get_property = gtk_radio_menu_item_get_property;
392 widget_class->destroy = gtk_radio_menu_item_destroy;
394 gtk_widget_class_set_accessible_type (widget_class, GTK_TYPE_RADIO_MENU_ITEM_ACCESSIBLE);
396 menu_item_class->activate = gtk_radio_menu_item_activate;
399 * GtkRadioMenuItem:group:
401 * The radio menu item whose group this widget belongs to.
405 g_object_class_install_property (gobject_class,
407 g_param_spec_object ("group",
409 P_("The radio menu item whose group this widget belongs to."),
410 GTK_TYPE_RADIO_MENU_ITEM,
411 GTK_PARAM_WRITABLE));
414 * GtkStyle::group-changed:
415 * @style: the object which received the signal
417 * Emitted when the group of radio menu items that a radio menu item belongs
418 * to changes. This is emitted when a radio menu item switches from
419 * being alone to being part of a group of 2 or more menu items, or
420 * vice-versa, and when a button is moved from one group of 2 or
421 * more menu items ton a different one, but not when the composition
422 * of the group that a menu item belongs to changes.
426 group_changed_signal = g_signal_new (I_("group-changed"),
427 G_OBJECT_CLASS_TYPE (gobject_class),
429 G_STRUCT_OFFSET (GtkRadioMenuItemClass, group_changed),
431 _gtk_marshal_VOID__VOID,
434 g_type_class_add_private (klass, sizeof (GtkRadioMenuItemPrivate));
438 gtk_radio_menu_item_init (GtkRadioMenuItem *radio_menu_item)
440 GtkRadioMenuItemPrivate *priv;
442 radio_menu_item->priv = G_TYPE_INSTANCE_GET_PRIVATE (radio_menu_item,
443 GTK_TYPE_RADIO_MENU_ITEM,
444 GtkRadioMenuItemPrivate);
445 priv = radio_menu_item->priv;
447 priv->group = g_slist_prepend (NULL, radio_menu_item);
448 gtk_check_menu_item_set_draw_as_radio (GTK_CHECK_MENU_ITEM (radio_menu_item), TRUE);
452 gtk_radio_menu_item_destroy (GtkWidget *widget)
454 GtkRadioMenuItem *radio_menu_item = GTK_RADIO_MENU_ITEM (widget);
455 GtkRadioMenuItemPrivate *priv = radio_menu_item->priv;
456 GtkWidget *old_group_singleton = NULL;
457 GtkRadioMenuItem *tmp_menu_item;
459 gboolean was_in_group;
461 was_in_group = priv->group && priv->group->next;
463 priv->group = g_slist_remove (priv->group, radio_menu_item);
464 if (priv->group && !priv->group->next)
465 old_group_singleton = priv->group->data;
467 tmp_list = priv->group;
471 tmp_menu_item = tmp_list->data;
472 tmp_list = tmp_list->next;
474 tmp_menu_item->priv->group = priv->group;
477 /* this radio menu item is no longer in the group */
480 if (old_group_singleton)
481 g_signal_emit (old_group_singleton, group_changed_signal, 0);
483 g_signal_emit (radio_menu_item, group_changed_signal, 0);
485 GTK_WIDGET_CLASS (gtk_radio_menu_item_parent_class)->destroy (widget);
489 gtk_radio_menu_item_activate (GtkMenuItem *menu_item)
491 GtkRadioMenuItem *radio_menu_item = GTK_RADIO_MENU_ITEM (menu_item);
492 GtkRadioMenuItemPrivate *priv = radio_menu_item->priv;
493 GtkCheckMenuItem *check_menu_item = GTK_CHECK_MENU_ITEM (menu_item);
494 GtkCheckMenuItem *tmp_menu_item;
500 action = gtk_activatable_get_related_action (GTK_ACTIVATABLE (menu_item));
501 if (action && gtk_menu_item_get_submenu (menu_item) == NULL)
502 gtk_action_activate (action);
506 active = gtk_check_menu_item_get_active (check_menu_item);
509 tmp_menu_item = NULL;
510 tmp_list = priv->group;
514 tmp_menu_item = tmp_list->data;
515 tmp_list = tmp_list->next;
517 if (gtk_check_menu_item_get_active (tmp_menu_item) &&
518 tmp_menu_item != check_menu_item)
521 tmp_menu_item = NULL;
527 _gtk_check_menu_item_set_active (check_menu_item, !active);
533 _gtk_check_menu_item_set_active (check_menu_item, !active);
535 tmp_list = priv->group;
538 tmp_menu_item = tmp_list->data;
539 tmp_list = tmp_list->next;
541 if (gtk_check_menu_item_get_active (tmp_menu_item) &&
542 tmp_menu_item != check_menu_item)
544 gtk_menu_item_activate (GTK_MENU_ITEM (tmp_menu_item));
552 gtk_check_menu_item_toggled (check_menu_item);
555 gtk_widget_queue_draw (GTK_WIDGET (radio_menu_item));