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.
23 #include "gtktoggletoolbutton.h"
24 #include "gtkcheckmenuitem.h"
26 #include "gtktogglebutton.h"
29 #include "gtkradiotoolbutton.h"
30 #include "gtktoggleaction.h"
31 #include "gtkactivatable.h"
32 #include "gtkprivate.h"
36 * SECTION:gtktoggletoolbutton
37 * @Short_description: A GtkToolItem containing a toggle button
38 * @Title: GtkToggleToolButton
39 * @See_also: #GtkToolbar, #GtkToolButton, #GtkSeparatorToolItem
41 * A #GtkToggleToolButton is a #GtkToolItem that contains a toggle
44 * Use gtk_toggle_tool_button_new() to create a new
45 * #GtkToggleToolButton. Use gtk_toggle_tool_button_new_from_stock() to
46 * create a new #GtkToggleToolButton containing a stock item.
50 #define MENU_ID "gtk-toggle-tool-button-menu-id"
63 struct _GtkToggleToolButtonPrivate
69 static void gtk_toggle_tool_button_set_property (GObject *object,
73 static void gtk_toggle_tool_button_get_property (GObject *object,
78 static gboolean gtk_toggle_tool_button_create_menu_proxy (GtkToolItem *button);
80 static void button_toggled (GtkWidget *widget,
81 GtkToggleToolButton *button);
82 static void menu_item_activated (GtkWidget *widget,
83 GtkToggleToolButton *button);
86 static void gtk_toggle_tool_button_activatable_interface_init (GtkActivatableIface *iface);
87 static void gtk_toggle_tool_button_update (GtkActivatable *activatable,
89 const gchar *property_name);
90 static void gtk_toggle_tool_button_sync_action_properties (GtkActivatable *activatable,
93 static GtkActivatableIface *parent_activatable_iface;
94 static guint toggle_signals[LAST_SIGNAL] = { 0 };
96 G_DEFINE_TYPE_WITH_CODE (GtkToggleToolButton, gtk_toggle_tool_button, GTK_TYPE_TOOL_BUTTON,
97 G_IMPLEMENT_INTERFACE (GTK_TYPE_ACTIVATABLE,
98 gtk_toggle_tool_button_activatable_interface_init))
101 gtk_toggle_tool_button_class_init (GtkToggleToolButtonClass *klass)
103 GObjectClass *object_class;
104 GtkToolItemClass *toolitem_class;
105 GtkToolButtonClass *toolbutton_class;
107 object_class = (GObjectClass *)klass;
108 toolitem_class = (GtkToolItemClass *)klass;
109 toolbutton_class = (GtkToolButtonClass *)klass;
111 object_class->set_property = gtk_toggle_tool_button_set_property;
112 object_class->get_property = gtk_toggle_tool_button_get_property;
114 toolitem_class->create_menu_proxy = gtk_toggle_tool_button_create_menu_proxy;
115 toolbutton_class->button_type = GTK_TYPE_TOGGLE_BUTTON;
118 * GtkToggleToolButton:active:
120 * If the toggle tool button should be pressed in.
124 g_object_class_install_property (object_class,
126 g_param_spec_boolean ("active",
128 P_("If the toggle button should be pressed in"),
130 GTK_PARAM_READWRITE));
133 * GtkToggleToolButton::toggled:
134 * @toggle_tool_button: the object that emitted the signal
136 * Emitted whenever the toggle tool button changes state.
138 toggle_signals[TOGGLED] =
139 g_signal_new (I_("toggled"),
140 G_OBJECT_CLASS_TYPE (klass),
142 G_STRUCT_OFFSET (GtkToggleToolButtonClass, toggled),
144 g_cclosure_marshal_VOID__VOID,
147 g_type_class_add_private (object_class, sizeof (GtkToggleToolButtonPrivate));
151 gtk_toggle_tool_button_init (GtkToggleToolButton *button)
153 GtkToolButton *tool_button = GTK_TOOL_BUTTON (button);
154 GtkToggleButton *toggle_button = GTK_TOGGLE_BUTTON (_gtk_tool_button_get_button (tool_button));
156 button->priv = G_TYPE_INSTANCE_GET_PRIVATE (button,
157 GTK_TYPE_TOGGLE_TOOL_BUTTON,
158 GtkToggleToolButtonPrivate);
160 /* If the real button is a radio button, it may have been
161 * active at the time it was created.
163 button->priv->active = gtk_toggle_button_get_active (toggle_button);
165 g_signal_connect_object (toggle_button,
166 "toggled", G_CALLBACK (button_toggled), button, 0);
170 gtk_toggle_tool_button_set_property (GObject *object,
175 GtkToggleToolButton *button = GTK_TOGGLE_TOOL_BUTTON (object);
180 gtk_toggle_tool_button_set_active (button,
181 g_value_get_boolean (value));
185 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
191 gtk_toggle_tool_button_get_property (GObject *object,
196 GtkToggleToolButton *button = GTK_TOGGLE_TOOL_BUTTON (object);
201 g_value_set_boolean (value, gtk_toggle_tool_button_get_active (button));
205 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
211 gtk_toggle_tool_button_create_menu_proxy (GtkToolItem *item)
213 GtkToolButton *tool_button = GTK_TOOL_BUTTON (item);
214 GtkToggleToolButton *toggle_tool_button = GTK_TOGGLE_TOOL_BUTTON (item);
215 GtkWidget *menu_item = NULL;
216 GtkStockItem stock_item;
217 gboolean use_mnemonic = TRUE;
219 GtkWidget *label_widget;
220 const gchar *label_text;
221 const gchar *stock_id;
223 if (_gtk_tool_item_create_menu_proxy (item))
226 label_widget = gtk_tool_button_get_label_widget (tool_button);
227 label_text = gtk_tool_button_get_label (tool_button);
228 stock_id = gtk_tool_button_get_stock_id (tool_button);
230 if (GTK_IS_LABEL (label_widget))
232 label = gtk_label_get_label (GTK_LABEL (label_widget));
233 use_mnemonic = gtk_label_get_use_underline (GTK_LABEL (label_widget));
238 use_mnemonic = gtk_tool_button_get_use_underline (tool_button);
240 else if (stock_id && gtk_stock_lookup (stock_id, &stock_item))
242 label = stock_item.label;
250 menu_item = gtk_check_menu_item_new_with_mnemonic (label);
252 menu_item = gtk_check_menu_item_new_with_label (label);
254 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (menu_item),
255 toggle_tool_button->priv->active);
257 if (GTK_IS_RADIO_TOOL_BUTTON (toggle_tool_button))
259 gtk_check_menu_item_set_draw_as_radio (GTK_CHECK_MENU_ITEM (menu_item),
263 g_signal_connect_closure_by_id (menu_item,
264 g_signal_lookup ("activate", G_OBJECT_TYPE (menu_item)), 0,
265 g_cclosure_new_object (G_CALLBACK (menu_item_activated),
266 G_OBJECT (toggle_tool_button)),
269 gtk_tool_item_set_proxy_menu_item (item, MENU_ID, menu_item);
274 /* There are two activatable widgets, a toggle button and a menu item.
276 * If a widget is activated and the state of the tool button is the same as
277 * the new state of the activated widget, then the other widget was the one
278 * that was activated by the user and updated the tool button's state.
280 * If the state of the tool button is not the same as the new state of the
281 * activated widget, then the activation was activated by the user, and the
282 * widget needs to make sure the tool button is updated before the other
283 * widget is activated. This will make sure the other widget a tool button
284 * in a state that matches its own new state.
287 menu_item_activated (GtkWidget *menu_item,
288 GtkToggleToolButton *toggle_tool_button)
290 GtkToolButton *tool_button = GTK_TOOL_BUTTON (toggle_tool_button);
291 gboolean menu_active = gtk_check_menu_item_get_active (GTK_CHECK_MENU_ITEM (menu_item));
293 if (toggle_tool_button->priv->active != menu_active)
295 toggle_tool_button->priv->active = menu_active;
297 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (_gtk_tool_button_get_button (tool_button)),
298 toggle_tool_button->priv->active);
300 g_object_notify (G_OBJECT (toggle_tool_button), "active");
301 g_signal_emit (toggle_tool_button, toggle_signals[TOGGLED], 0);
306 button_toggled (GtkWidget *widget,
307 GtkToggleToolButton *toggle_tool_button)
309 gboolean toggle_active;
311 toggle_active = gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (widget));
313 if (toggle_tool_button->priv->active != toggle_active)
315 GtkWidget *menu_item;
317 toggle_tool_button->priv->active = toggle_active;
320 gtk_tool_item_get_proxy_menu_item (GTK_TOOL_ITEM (toggle_tool_button), MENU_ID)))
322 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (menu_item),
323 toggle_tool_button->priv->active);
326 g_object_notify (G_OBJECT (toggle_tool_button), "active");
327 g_signal_emit (toggle_tool_button, toggle_signals[TOGGLED], 0);
332 gtk_toggle_tool_button_activatable_interface_init (GtkActivatableIface *iface)
334 parent_activatable_iface = g_type_interface_peek_parent (iface);
335 iface->update = gtk_toggle_tool_button_update;
336 iface->sync_action_properties = gtk_toggle_tool_button_sync_action_properties;
340 gtk_toggle_tool_button_update (GtkActivatable *activatable,
342 const gchar *property_name)
344 GtkToggleToolButton *button;
346 parent_activatable_iface->update (activatable, action, property_name);
348 button = GTK_TOGGLE_TOOL_BUTTON (activatable);
350 if (strcmp (property_name, "active") == 0)
352 gtk_action_block_activate (action);
353 gtk_toggle_tool_button_set_active (button, gtk_toggle_action_get_active (GTK_TOGGLE_ACTION (action)));
354 gtk_action_unblock_activate (action);
359 gtk_toggle_tool_button_sync_action_properties (GtkActivatable *activatable,
362 GtkToggleToolButton *button;
364 parent_activatable_iface->sync_action_properties (activatable, action);
366 if (!GTK_IS_TOGGLE_ACTION (action))
369 button = GTK_TOGGLE_TOOL_BUTTON (activatable);
371 gtk_action_block_activate (action);
372 gtk_toggle_tool_button_set_active (button, gtk_toggle_action_get_active (GTK_TOGGLE_ACTION (action)));
373 gtk_action_unblock_activate (action);
378 * gtk_toggle_tool_button_new:
380 * Returns a new #GtkToggleToolButton
382 * Return value: a newly created #GtkToggleToolButton
387 gtk_toggle_tool_button_new (void)
389 GtkToolButton *button;
391 button = g_object_new (GTK_TYPE_TOGGLE_TOOL_BUTTON,
394 return GTK_TOOL_ITEM (button);
398 * gtk_toggle_tool_button_new_from_stock:
399 * @stock_id: the name of the stock item
401 * Creates a new #GtkToggleToolButton containing the image and text from a
402 * stock item. Some stock ids have preprocessor macros like #GTK_STOCK_OK
403 * and #GTK_STOCK_APPLY.
405 * It is an error if @stock_id is not a name of a stock item.
407 * Return value: A new #GtkToggleToolButton
412 gtk_toggle_tool_button_new_from_stock (const gchar *stock_id)
414 GtkToolButton *button;
416 g_return_val_if_fail (stock_id != NULL, NULL);
418 button = g_object_new (GTK_TYPE_TOGGLE_TOOL_BUTTON,
419 "stock-id", stock_id,
422 return GTK_TOOL_ITEM (button);
426 * gtk_toggle_tool_button_set_active:
427 * @button: a #GtkToggleToolButton
428 * @is_active: whether @button should be active
430 * Sets the status of the toggle tool button. Set to %TRUE if you
431 * want the GtkToggleButton to be 'pressed in', and %FALSE to raise it.
432 * This action causes the toggled signal to be emitted.
437 gtk_toggle_tool_button_set_active (GtkToggleToolButton *button,
440 g_return_if_fail (GTK_IS_TOGGLE_TOOL_BUTTON (button));
442 is_active = is_active != FALSE;
444 if (button->priv->active != is_active)
445 gtk_button_clicked (GTK_BUTTON (_gtk_tool_button_get_button (GTK_TOOL_BUTTON (button))));
449 * gtk_toggle_tool_button_get_active:
450 * @button: a #GtkToggleToolButton
452 * Queries a #GtkToggleToolButton and returns its current state.
453 * Returns %TRUE if the toggle button is pressed in and %FALSE if it is raised.
455 * Return value: %TRUE if the toggle tool button is pressed in, %FALSE if not
460 gtk_toggle_tool_button_get_active (GtkToggleToolButton *button)
462 g_return_val_if_fail (GTK_IS_TOGGLE_TOOL_BUTTON (button), FALSE);
464 return button->priv->active;