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, see <http://www.gnu.org/licenses/>.
22 #include "gtkradiotoolbutton.h"
23 #include "gtkradiobutton.h"
25 #include "gtkprivate.h"
29 * SECTION:gtkradiotoolbutton
30 * @Short_description: A toolbar item that contains a radio button
31 * @Title: GtkRadioToolButton
32 * @See_also: #GtkToolbar, #GtkToolButton
34 * A #GtkRadioToolButton is a #GtkToolItem that contains a radio button,
35 * that is, a button that is part of a group of toggle buttons where only
36 * one button can be active at a time.
38 * Use gtk_radio_tool_button_new() to create a new
39 * #GtkRadioToolButton. Use gtk_radio_tool_button_new_from_widget() to
40 * create a new #GtkRadioToolButton that is part of the same group as an
41 * existing #GtkRadioToolButton. Use
42 * gtk_radio_tool_button_new_from_stock() or
43 * gtk_radio_tool_button_new_with_stock_from_widget() create a new
44 * #GtkRadioToolButton containing a stock item.
53 static void gtk_radio_tool_button_set_property (GObject *object,
58 G_DEFINE_TYPE (GtkRadioToolButton, gtk_radio_tool_button, GTK_TYPE_TOGGLE_TOOL_BUTTON)
61 gtk_radio_tool_button_class_init (GtkRadioToolButtonClass *klass)
63 GObjectClass *object_class;
64 GtkToolButtonClass *toolbutton_class;
66 object_class = (GObjectClass *)klass;
67 toolbutton_class = (GtkToolButtonClass *)klass;
69 object_class->set_property = gtk_radio_tool_button_set_property;
71 toolbutton_class->button_type = GTK_TYPE_RADIO_BUTTON;
74 * GtkRadioToolButton:group:
76 * Sets a new group for a radio tool button.
80 g_object_class_install_property (object_class,
82 g_param_spec_object ("group",
84 P_("The radio tool button whose group this button belongs to."),
85 GTK_TYPE_RADIO_TOOL_BUTTON,
91 gtk_radio_tool_button_init (GtkRadioToolButton *button)
93 GtkToolButton *tool_button = GTK_TOOL_BUTTON (button);
94 gtk_toggle_button_set_mode (GTK_TOGGLE_BUTTON (_gtk_tool_button_get_button (tool_button)), FALSE);
98 gtk_radio_tool_button_set_property (GObject *object,
103 GtkRadioToolButton *button;
105 button = GTK_RADIO_TOOL_BUTTON (object);
111 GtkRadioToolButton *arg;
112 GSList *slist = NULL;
113 if (G_VALUE_HOLDS_OBJECT (value))
115 arg = GTK_RADIO_TOOL_BUTTON (g_value_get_object (value));
117 slist = gtk_radio_tool_button_get_group (arg);
118 gtk_radio_tool_button_set_group (button, slist);
123 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
129 * gtk_radio_tool_button_new:
130 * @group: (allow-none) (transfer none) (element-type GtkRadioButton): An
131 * existing radio button group, or %NULL if you are creating a new group
133 * Creates a new #GtkRadioToolButton, adding it to @group.
135 * Return value: The new #GtkRadioToolButton
140 gtk_radio_tool_button_new (GSList *group)
142 GtkRadioToolButton *button;
144 button = g_object_new (GTK_TYPE_RADIO_TOOL_BUTTON,
147 gtk_radio_tool_button_set_group (button, group);
149 return GTK_TOOL_ITEM (button);
153 * gtk_radio_tool_button_new_from_stock:
154 * @group: (allow-none) (element-type GtkRadioButton): an existing radio button
155 * group, or %NULL if you are creating a new group
156 * @stock_id: the name of a stock item
158 * Creates a new #GtkRadioToolButton, adding it to @group.
159 * The new #GtkRadioToolButton will contain an icon and label from the
160 * stock item indicated by @stock_id.
162 * Return value: The new #GtkRadioToolButton
167 gtk_radio_tool_button_new_from_stock (GSList *group,
168 const gchar *stock_id)
170 GtkRadioToolButton *button;
172 g_return_val_if_fail (stock_id != NULL, NULL);
174 button = g_object_new (GTK_TYPE_RADIO_TOOL_BUTTON,
175 "stock-id", stock_id,
179 gtk_radio_tool_button_set_group (button, group);
181 return GTK_TOOL_ITEM (button);
185 * gtk_radio_tool_button_new_from_widget: (constructor)
186 * @group: (allow-none): An existing #GtkRadioToolButton, or %NULL
188 * Creates a new #GtkRadioToolButton adding it to the same group as @gruup
190 * Return value: (transfer none): The new #GtkRadioToolButton
195 gtk_radio_tool_button_new_from_widget (GtkRadioToolButton *group)
199 g_return_val_if_fail (group == NULL || GTK_IS_RADIO_TOOL_BUTTON (group), NULL);
202 list = gtk_radio_tool_button_get_group (GTK_RADIO_TOOL_BUTTON (group));
204 return gtk_radio_tool_button_new (list);
208 * gtk_radio_tool_button_new_with_stock_from_widget: (constructor)
209 * @group: (allow-none): An existing #GtkRadioToolButton.
210 * @stock_id: the name of a stock item
212 * Creates a new #GtkRadioToolButton adding it to the same group as @group.
213 * The new #GtkRadioToolButton will contain an icon and label from the
214 * stock item indicated by @stock_id.
216 * Return value: (transfer none): A new #GtkRadioToolButton
221 gtk_radio_tool_button_new_with_stock_from_widget (GtkRadioToolButton *group,
222 const gchar *stock_id)
226 g_return_val_if_fail (group == NULL || GTK_IS_RADIO_TOOL_BUTTON (group), NULL);
229 list = gtk_radio_tool_button_get_group (group);
231 return gtk_radio_tool_button_new_from_stock (list, stock_id);
234 static GtkRadioButton *
235 get_radio_button (GtkRadioToolButton *button)
237 return GTK_RADIO_BUTTON (_gtk_tool_button_get_button (GTK_TOOL_BUTTON (button)));
241 * gtk_radio_tool_button_get_group:
242 * @button: a #GtkRadioToolButton
244 * Returns the radio button group @button belongs to.
246 * Return value: (transfer none) (element-type GtkRadioButton): The group @button belongs to.
251 gtk_radio_tool_button_get_group (GtkRadioToolButton *button)
253 g_return_val_if_fail (GTK_IS_RADIO_TOOL_BUTTON (button), NULL);
255 return gtk_radio_button_get_group (get_radio_button (button));
259 * gtk_radio_tool_button_set_group:
260 * @button: a #GtkRadioToolButton
261 * @group: (transfer none) (element-type GtkRadioButton): an existing radio button group
263 * Adds @button to @group, removing it from the group it belonged to before.
268 gtk_radio_tool_button_set_group (GtkRadioToolButton *button,
271 g_return_if_fail (GTK_IS_RADIO_TOOL_BUTTON (button));
273 gtk_radio_button_set_group (get_radio_button (button), group);