1 /* gtktoggletoolbutton.c
3 * Copyright (C) 2002 Anders Carlsson <andersca@gnome.org>
4 * Copyright (C) 2002 James Henstridge <james@daa.com.au>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
24 #include "gtktoggletoolbutton.h"
25 #include "gtkcheckmenuitem.h"
27 #include "gtktogglebutton.h"
30 #include "gtkradiotoolbutton.h"
32 #define MENU_ID "gtk-toggle-tool-button-menu-id"
39 #define GTK_TOGGLE_TOOL_BUTTON_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_TOGGLE_TOOL_BUTTON, GtkToggleToolButtonPrivate))
41 struct _GtkToggleToolButtonPrivate
46 static void gtk_toggle_tool_button_init (GtkToggleToolButton *button);
47 static void gtk_toggle_tool_button_class_init (GtkToggleToolButtonClass *klass);
49 static gboolean gtk_toggle_tool_button_create_menu_proxy (GtkToolItem *button);
51 static void button_toggled (GtkWidget *widget,
52 GtkToggleToolButton *button);
53 static void menu_item_activated (GtkWidget *widget,
54 GtkToggleToolButton *button);
56 static GObjectClass *parent_class = NULL;
57 static guint toggle_signals[LAST_SIGNAL] = { 0 };
60 gtk_toggle_tool_button_get_type (void)
62 static GType type = 0;
66 static const GTypeInfo type_info =
68 sizeof (GtkToggleToolButtonClass),
70 (GBaseFinalizeFunc) 0,
71 (GClassInitFunc) gtk_toggle_tool_button_class_init,
72 (GClassFinalizeFunc) 0,
74 sizeof (GtkToggleToolButton),
76 (GInstanceInitFunc) gtk_toggle_tool_button_init
79 type = g_type_register_static (GTK_TYPE_TOOL_BUTTON,
80 "GtkToggleToolButton", &type_info, 0);
87 gtk_toggle_tool_button_class_init (GtkToggleToolButtonClass *klass)
89 GObjectClass *object_class;
90 GtkToolItemClass *toolitem_class;
91 GtkToolButtonClass *toolbutton_class;
93 parent_class = g_type_class_peek_parent (klass);
95 object_class = (GObjectClass *)klass;
96 toolitem_class = (GtkToolItemClass *)klass;
97 toolbutton_class = (GtkToolButtonClass *)klass;
99 toolitem_class->create_menu_proxy = gtk_toggle_tool_button_create_menu_proxy;
100 toolbutton_class->button_type = GTK_TYPE_TOGGLE_BUTTON;
103 * GtkToggleToolButton::toggled:
104 * @toggle_tool_button: the object that emitted the signal
106 * Emitted whenever the toggle tool button changes state.
108 toggle_signals[TOGGLED] =
109 g_signal_new ("toggled",
110 G_OBJECT_CLASS_TYPE (klass),
112 G_STRUCT_OFFSET (GtkToggleToolButtonClass, toggled),
114 g_cclosure_marshal_VOID__VOID,
117 g_type_class_add_private (object_class, sizeof (GtkToggleToolButtonPrivate));
121 gtk_toggle_tool_button_init (GtkToggleToolButton *button)
123 GtkToolButton *tool_button = GTK_TOOL_BUTTON (button);
124 GtkToggleButton *toggle_button = GTK_TOGGLE_BUTTON (_gtk_tool_button_get_button (tool_button));
126 button->priv = GTK_TOGGLE_TOOL_BUTTON_GET_PRIVATE (button);
128 /* If the real button is a radio button, it may have been
129 * active at the time it was created.
131 button->priv->active = gtk_toggle_button_get_active (toggle_button);
133 g_signal_connect_object (toggle_button,
134 "toggled", G_CALLBACK (button_toggled), button, 0);
138 gtk_toggle_tool_button_create_menu_proxy (GtkToolItem *item)
140 GtkToolButton *tool_button = GTK_TOOL_BUTTON (item);
141 GtkToggleToolButton *toggle_tool_button = GTK_TOGGLE_TOOL_BUTTON (item);
142 GtkWidget *menu_item = NULL;
143 GtkStockItem stock_item;
144 gboolean use_mnemonic = TRUE;
147 GtkWidget *label_widget = gtk_tool_button_get_label_widget (tool_button);
148 const gchar *label_text = gtk_tool_button_get_label (tool_button);
149 const gchar *stock_id = gtk_tool_button_get_stock_id (tool_button);
151 if (label_widget && GTK_IS_LABEL (label_widget))
153 label = gtk_label_get_label (GTK_LABEL (label_widget));
154 use_mnemonic = gtk_label_get_use_underline (GTK_LABEL (label_widget));
159 use_mnemonic = gtk_tool_button_get_use_underline (tool_button);
161 else if (stock_id && gtk_stock_lookup (stock_id, &stock_item))
163 label = stock_item.label;
171 menu_item = gtk_check_menu_item_new_with_mnemonic (label);
173 menu_item = gtk_check_menu_item_new_with_label (label);
175 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (menu_item),
176 toggle_tool_button->priv->active);
178 if (GTK_IS_RADIO_TOOL_BUTTON (toggle_tool_button))
180 gtk_check_menu_item_set_draw_as_radio (GTK_CHECK_MENU_ITEM (menu_item),
184 g_signal_connect_closure_by_id (menu_item,
185 g_signal_lookup ("activate", G_OBJECT_TYPE (menu_item)), 0,
186 g_cclosure_new_object (G_CALLBACK (menu_item_activated),
187 G_OBJECT (toggle_tool_button)),
190 gtk_tool_item_set_proxy_menu_item (item, MENU_ID, menu_item);
195 /* There are two activatable widgets, a toggle button and a menu item.
197 * If a widget is activated and the state of the tool button is the same as
198 * the new state of the activated widget, then the other widget was the one
199 * that was activated by the user and updated the tool button's state.
201 * If the state of the tool button is not the same as the new state of the
202 * activated widget, then the activation was activated by the user, and the
203 * widget needs to make sure the tool button is updated before the other
204 * widget is activated. This will make sure the other widget a tool button
205 * in a state that matches its own new state.
208 menu_item_activated (GtkWidget *menu_item,
209 GtkToggleToolButton *toggle_tool_button)
211 GtkToolButton *tool_button = GTK_TOOL_BUTTON (toggle_tool_button);
212 gboolean menu_active = gtk_check_menu_item_get_active (GTK_CHECK_MENU_ITEM (menu_item));
214 if (toggle_tool_button->priv->active != menu_active)
216 toggle_tool_button->priv->active = menu_active;
218 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (_gtk_tool_button_get_button (tool_button)),
219 toggle_tool_button->priv->active);
221 g_signal_emit (G_OBJECT (toggle_tool_button), toggle_signals[TOGGLED], 0);
226 button_toggled (GtkWidget *widget,
227 GtkToggleToolButton *toggle_tool_button)
229 gboolean toggle_active = GTK_TOGGLE_BUTTON (widget)->active;
231 if (toggle_tool_button->priv->active != toggle_active)
233 GtkWidget *menu_item;
235 toggle_tool_button->priv->active = toggle_active;
238 gtk_tool_item_get_proxy_menu_item (GTK_TOOL_ITEM (toggle_tool_button), MENU_ID)))
240 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (menu_item),
241 toggle_tool_button->priv->active);
244 g_signal_emit (G_OBJECT (toggle_tool_button), toggle_signals[TOGGLED], 0);
249 * gtk_toggle_tool_button_new:
251 * Returns a new #GtkToggleToolButton
253 * Return value: a newly created #GtkToggleToolButton
258 gtk_toggle_tool_button_new (void)
260 GtkToolButton *button;
262 button = g_object_new (GTK_TYPE_TOGGLE_TOOL_BUTTON,
265 return GTK_TOOL_ITEM (button);
269 * gtk_toggle_tool_button_new_from_stock:
270 * @stock_id: the name of the stock item
272 * Creates a new #GtkToggleToolButton containing the image and text from a
273 * stock item. Some stock ids have preprocessor macros like #GTK_STOCK_OK
274 * and #GTK_STOCK_APPLY.
276 * It is an error if @stock_id is not a name of a stock item.
278 * Return value: A new #GtkToggleToolButton
283 gtk_toggle_tool_button_new_from_stock (const gchar *stock_id)
285 GtkToolButton *button;
287 g_return_val_if_fail (stock_id != NULL, NULL);
289 button = g_object_new (GTK_TYPE_TOGGLE_TOOL_BUTTON,
290 "stock_id", stock_id,
293 return GTK_TOOL_ITEM (button);
297 * gtk_toggle_tool_button_set_active:
298 * @button: a #GtkToggleToolButton
299 * @is_active: whether @button should be active
301 * Sets the status of the toggle tool button. Set to %TRUE if you
302 * want the GtkToggleButton to be 'pressed in', and %FALSE to raise it.
303 * This action causes the toggled signal to be emitted.
308 gtk_toggle_tool_button_set_active (GtkToggleToolButton *button,
311 g_return_if_fail (GTK_IS_TOGGLE_TOOL_BUTTON (button));
313 is_active = is_active != FALSE;
315 if (button->priv->active != is_active)
316 gtk_button_clicked (GTK_BUTTON (_gtk_tool_button_get_button (GTK_TOOL_BUTTON (button))));
320 * gtk_toggle_tool_button_get_active:
321 * @button: a #GtkToggleToolButton
323 * Queries a #GtkToggleToolButton and returns its current state.
324 * Returns %TRUE if the toggle button is pressed in and %FALSE if it is raised.
326 * Return value: %TRUE if the toggle tool button is pressed in, %FALSE if not
331 gtk_toggle_tool_button_get_active (GtkToggleToolButton *button)
333 g_return_val_if_fail (GTK_IS_TOGGLE_TOOL_BUTTON (button), FALSE);
335 return button->priv->active;