1 /* gtkradiotoolbutton.c
3 * Copyright (C) 2002 Anders Carlsson <andersca@gnome.og>
4 * Copyright (C) 2002 James Henstridge <james@daa.com.au>
5 * Copyright (C) 2003 Soeren Sandmann <sandmann@daimi.au.dk>
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
24 #include "gtkradiotoolbutton.h"
25 #include "gtkradiobutton.h"
27 #include "gtkprivate.h"
31 * SECTION:gtkradiotoolbutton
32 * @Short_description: A toolbar item that contains a radio button
33 * @Title: GtkRadioToolButton
34 * @See_also: #GtkToolbar, #GtkToolButton
36 * A #GtkRadioToolButton is a #GtkToolItem that contains a radio button,
37 * that is, a button that is part of a group of toggle buttons where only
38 * one button can be active at a time.
40 * Use gtk_radio_tool_button_new() to create a new
41 * #GtkRadioToolButton. Use gtk_radio_tool_button_new_from_widget() to
42 * create a new #GtkRadioToolButton that is part of the same group as an
43 * existing #GtkRadioToolButton. Use
44 * gtk_radio_tool_button_new_from_stock() or
45 * gtk_radio_tool_button_new_with_stock_from_widget() create a new
46 * #GtkRadioToolButton containing a stock item.
55 static void gtk_radio_tool_button_set_property (GObject *object,
60 G_DEFINE_TYPE (GtkRadioToolButton, gtk_radio_tool_button, GTK_TYPE_TOGGLE_TOOL_BUTTON)
63 gtk_radio_tool_button_class_init (GtkRadioToolButtonClass *klass)
65 GObjectClass *object_class;
66 GtkToolButtonClass *toolbutton_class;
68 object_class = (GObjectClass *)klass;
69 toolbutton_class = (GtkToolButtonClass *)klass;
71 object_class->set_property = gtk_radio_tool_button_set_property;
73 toolbutton_class->button_type = GTK_TYPE_RADIO_BUTTON;
76 * GtkRadioToolButton:group:
78 * Sets a new group for a radio tool button.
82 g_object_class_install_property (object_class,
84 g_param_spec_object ("group",
86 P_("The radio tool button whose group this button belongs to."),
87 GTK_TYPE_RADIO_TOOL_BUTTON,
93 gtk_radio_tool_button_init (GtkRadioToolButton *button)
95 GtkToolButton *tool_button = GTK_TOOL_BUTTON (button);
96 gtk_toggle_button_set_mode (GTK_TOGGLE_BUTTON (_gtk_tool_button_get_button (tool_button)), FALSE);
100 gtk_radio_tool_button_set_property (GObject *object,
105 GtkRadioToolButton *button;
107 button = GTK_RADIO_TOOL_BUTTON (object);
113 GtkRadioToolButton *arg;
114 GSList *slist = NULL;
115 if (G_VALUE_HOLDS_OBJECT (value))
117 arg = GTK_RADIO_TOOL_BUTTON (g_value_get_object (value));
119 slist = gtk_radio_tool_button_get_group (arg);
120 gtk_radio_tool_button_set_group (button, slist);
125 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
131 * gtk_radio_tool_button_new:
132 * @group: (allow-none) (transfer none) (element-type GtkRadioButton): An
133 * existing radio button group, or %NULL if you are creating a new group
135 * Creates a new #GtkRadioToolButton, adding it to @group.
137 * Return value: The new #GtkRadioToolButton
142 gtk_radio_tool_button_new (GSList *group)
144 GtkRadioToolButton *button;
146 button = g_object_new (GTK_TYPE_RADIO_TOOL_BUTTON,
149 gtk_radio_tool_button_set_group (button, group);
151 return GTK_TOOL_ITEM (button);
155 * gtk_radio_tool_button_new_from_stock:
156 * @group: (allow-none): an existing radio button group, or %NULL if you are
157 * creating a new group
158 * @stock_id: the name of a stock item
160 * Creates a new #GtkRadioToolButton, adding it to @group.
161 * The new #GtkRadioToolButton will contain an icon and label from the
162 * stock item indicated by @stock_id.
164 * Return value: The new #GtkRadioToolItem
169 gtk_radio_tool_button_new_from_stock (GSList *group,
170 const gchar *stock_id)
172 GtkRadioToolButton *button;
174 g_return_val_if_fail (stock_id != NULL, NULL);
176 button = g_object_new (GTK_TYPE_RADIO_TOOL_BUTTON,
177 "stock-id", stock_id,
181 gtk_radio_tool_button_set_group (button, group);
183 return GTK_TOOL_ITEM (button);
187 * gtk_radio_tool_button_new_from_widget: (constructor)
188 * @group: (allow-none): An existing #GtkRadioToolButton, or %NULL
190 * Creates a new #GtkRadioToolButton adding it to the same group as @gruup
192 * Return value: (transfer none): The new #GtkRadioToolButton
197 gtk_radio_tool_button_new_from_widget (GtkRadioToolButton *group)
201 g_return_val_if_fail (group == NULL || GTK_IS_RADIO_TOOL_BUTTON (group), NULL);
204 list = gtk_radio_tool_button_get_group (GTK_RADIO_TOOL_BUTTON (group));
206 return gtk_radio_tool_button_new (list);
210 * gtk_radio_tool_button_new_with_stock_from_widget: (constructor)
211 * @group: (allow-none): An existing #GtkRadioToolButton.
212 * @stock_id: the name of a stock item
214 * Creates a new #GtkRadioToolButton adding it to the same group as @group.
215 * The new #GtkRadioToolButton will contain an icon and label from the
216 * stock item indicated by @stock_id.
218 * Return value: (transfer none): A new #GtkRadioToolButton
223 gtk_radio_tool_button_new_with_stock_from_widget (GtkRadioToolButton *group,
224 const gchar *stock_id)
228 g_return_val_if_fail (group == NULL || GTK_IS_RADIO_TOOL_BUTTON (group), NULL);
231 list = gtk_radio_tool_button_get_group (group);
233 return gtk_radio_tool_button_new_from_stock (list, stock_id);
236 static GtkRadioButton *
237 get_radio_button (GtkRadioToolButton *button)
239 return GTK_RADIO_BUTTON (_gtk_tool_button_get_button (GTK_TOOL_BUTTON (button)));
243 * gtk_radio_tool_button_get_group:
244 * @button: a #GtkRadioToolButton
246 * Returns the radio button group @button belongs to.
248 * Return value: (transfer none) (element-type GtkRadioButton): The group @button belongs to.
253 gtk_radio_tool_button_get_group (GtkRadioToolButton *button)
255 g_return_val_if_fail (GTK_IS_RADIO_TOOL_BUTTON (button), NULL);
257 return gtk_radio_button_get_group (get_radio_button (button));
261 * gtk_radio_tool_button_set_group:
262 * @button: a #GtkRadioToolButton
263 * @group: (transfer none) (element-type GtkRadioButton): an existing radio button group
265 * Adds @button to @group, removing it from the group it belonged to before.
270 gtk_radio_tool_button_set_group (GtkRadioToolButton *button,
273 g_return_if_fail (GTK_IS_RADIO_TOOL_BUTTON (button));
275 gtk_radio_button_set_group (get_radio_button (button), group);