gtktoggletoolbutton.c 11.1 KB
Newer Older
1 2
/* gtktoggletoolbutton.c
 *
Anders Carlsson's avatar
Anders Carlsson committed
3
 * Copyright (C) 2002 Anders Carlsson <andersca@gnome.org>
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
 * Copyright (C) 2002 James Henstridge <james@daa.com.au>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

22
#include <config.h>
23 24 25 26 27 28
#include "gtktoggletoolbutton.h"
#include "gtkcheckmenuitem.h"
#include "gtklabel.h"
#include "gtktogglebutton.h"
#include "gtkstock.h"
#include "gtkintl.h"
29
#include "gtkradiotoolbutton.h"
30
#include "gtkprivate.h"
31
#include "gtkalias.h"
32 33 34 35 36 37 38 39

#define MENU_ID "gtk-toggle-tool-button-menu-id"

enum {
  TOGGLED,
  LAST_SIGNAL
};

Matthias Clasen's avatar
Matthias Clasen committed
40 41 42 43 44 45
enum {
  PROP_0,
  PROP_ACTIVE
};


Matthias Clasen's avatar
Matthias Clasen committed
46 47
#define GTK_TOGGLE_TOOL_BUTTON_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_TOGGLE_TOOL_BUTTON, GtkToggleToolButtonPrivate))

48 49 50 51 52
struct _GtkToggleToolButtonPrivate
{
  guint active : 1;
};
  
53

Matthias Clasen's avatar
Matthias Clasen committed
54 55 56 57 58 59 60 61 62
static void     gtk_toggle_tool_button_set_property        (GObject      *object,
							    guint         prop_id,
							    const GValue *value,
							    GParamSpec   *pspec);
static void     gtk_toggle_tool_button_get_property        (GObject      *object,
							    guint         prop_id,
							    GValue       *value,
							    GParamSpec   *pspec);

63 64 65 66 67 68 69 70 71
static gboolean gtk_toggle_tool_button_create_menu_proxy (GtkToolItem *button);

static void button_toggled      (GtkWidget           *widget,
				 GtkToggleToolButton *button);
static void menu_item_activated (GtkWidget           *widget,
				 GtkToggleToolButton *button);

static guint         toggle_signals[LAST_SIGNAL] = { 0 };

Matthias Clasen's avatar
Matthias Clasen committed
72
G_DEFINE_TYPE (GtkToggleToolButton, gtk_toggle_tool_button, GTK_TYPE_TOOL_BUTTON)
73 74 75 76 77 78 79 80 81 82 83 84

static void
gtk_toggle_tool_button_class_init (GtkToggleToolButtonClass *klass)
{
  GObjectClass *object_class;
  GtkToolItemClass *toolitem_class;
  GtkToolButtonClass *toolbutton_class;

  object_class = (GObjectClass *)klass;
  toolitem_class = (GtkToolItemClass *)klass;
  toolbutton_class = (GtkToolButtonClass *)klass;

Matthias Clasen's avatar
Matthias Clasen committed
85 86 87
  object_class->set_property = gtk_toggle_tool_button_set_property;
  object_class->get_property = gtk_toggle_tool_button_get_property;

88 89
  toolitem_class->create_menu_proxy = gtk_toggle_tool_button_create_menu_proxy;
  toolbutton_class->button_type = GTK_TYPE_TOGGLE_BUTTON;
Matthias Clasen's avatar
Matthias Clasen committed
90 91 92 93 94 95 96 97

  /**
   * GtkToggleToolButton:active:
   *
   * If the toggle tool button should be pressed in or not.
   *
   * Since: 2.8
   */
98
  g_object_class_install_property (object_class,
Matthias Clasen's avatar
Matthias Clasen committed
99 100 101 102 103 104 105
                                   PROP_ACTIVE,
                                   g_param_spec_boolean ("active",
							 P_("Active"),
							 P_("If the toggle button should be pressed in or not"),
							 FALSE,
							 GTK_PARAM_READWRITE));

106 107 108 109 110 111
/**
 * GtkToggleToolButton::toggled:
 * @toggle_tool_button: the object that emitted the signal
 *
 * Emitted whenever the toggle tool button changes state.
 **/
112
  toggle_signals[TOGGLED] =
Matthias Clasen's avatar
Matthias Clasen committed
113
    g_signal_new (I_("toggled"),
114 115 116 117 118 119
		  G_OBJECT_CLASS_TYPE (klass),
		  G_SIGNAL_RUN_FIRST,
		  G_STRUCT_OFFSET (GtkToggleToolButtonClass, toggled),
		  NULL, NULL,
		  g_cclosure_marshal_VOID__VOID,
		  G_TYPE_NONE, 0);
120 121

  g_type_class_add_private (object_class, sizeof (GtkToggleToolButtonPrivate));
122 123 124 125 126
}

static void
gtk_toggle_tool_button_init (GtkToggleToolButton *button)
{
127 128 129
  GtkToolButton *tool_button = GTK_TOOL_BUTTON (button);
  GtkToggleButton *toggle_button = GTK_TOGGLE_BUTTON (_gtk_tool_button_get_button (tool_button));

130
  button->priv = GTK_TOGGLE_TOOL_BUTTON_GET_PRIVATE (button);
131 132 133 134 135 136 137

  /* If the real button is a radio button, it may have been
   * active at the time it was created.
   */
  button->priv->active = gtk_toggle_button_get_active (toggle_button);
    
  g_signal_connect_object (toggle_button,
138
			   "toggled", G_CALLBACK (button_toggled), button, 0);
139 140
}

Matthias Clasen's avatar
Matthias Clasen committed
141 142 143 144 145 146 147 148 149 150 151
static void
gtk_toggle_tool_button_set_property (GObject      *object,
				     guint         prop_id,
				     const GValue *value,
				     GParamSpec   *pspec)
{
  GtkToggleToolButton *button = GTK_TOGGLE_TOOL_BUTTON (object);

  switch (prop_id)
    {
      case PROP_ACTIVE:
152 153
	gtk_toggle_tool_button_set_active (button, 
					   g_value_get_boolean (value));
Matthias Clasen's avatar
Matthias Clasen committed
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
        break;

      default:
        G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
        break;
    }
}

static void
gtk_toggle_tool_button_get_property (GObject    *object,
				     guint       prop_id,
				     GValue     *value,
				     GParamSpec *pspec)
{
  GtkToggleToolButton *button = GTK_TOGGLE_TOOL_BUTTON (object);

  switch (prop_id)
    {
      case PROP_ACTIVE:
        g_value_set_boolean (value, gtk_toggle_tool_button_get_active (button));
        break;

      default:
        G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
        break;
    }
}

182 183 184 185 186 187 188 189
static gboolean
gtk_toggle_tool_button_create_menu_proxy (GtkToolItem *item)
{
  GtkToolButton *tool_button = GTK_TOOL_BUTTON (item);
  GtkToggleToolButton *toggle_tool_button = GTK_TOGGLE_TOOL_BUTTON (item);
  GtkWidget *menu_item = NULL;
  GtkStockItem stock_item;
  gboolean use_mnemonic = TRUE;
190
  const char *label;
191

192 193 194 195
  GtkWidget *label_widget = gtk_tool_button_get_label_widget (tool_button);
  const gchar *label_text = gtk_tool_button_get_label (tool_button);
  const gchar *stock_id = gtk_tool_button_get_stock_id (tool_button);

196
  if (GTK_IS_LABEL (label_widget))
197 198
    {
      label = gtk_label_get_label (GTK_LABEL (label_widget));
199
      use_mnemonic = gtk_label_get_use_underline (GTK_LABEL (label_widget));
200 201
    }
  else if (label_text)
202
    {
203
      label = label_text;
204
      use_mnemonic = gtk_tool_button_get_use_underline (tool_button);
205
    }
206
  else if (stock_id && gtk_stock_lookup (stock_id, &stock_item))
207 208 209 210 211 212 213
    {
      label = stock_item.label;
    }
  else
    {
      label = "";
    }
214 215 216 217 218 219 220
  
  if (use_mnemonic)
    menu_item = gtk_check_menu_item_new_with_mnemonic (label);
  else
    menu_item = gtk_check_menu_item_new_with_label (label);

  gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (menu_item),
221
				  toggle_tool_button->priv->active);
222

223 224 225 226 227 228
  if (GTK_IS_RADIO_TOOL_BUTTON (toggle_tool_button))
    {
      gtk_check_menu_item_set_draw_as_radio (GTK_CHECK_MENU_ITEM (menu_item),
					     TRUE);
    }

229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
  g_signal_connect_closure_by_id (menu_item,
				  g_signal_lookup ("activate", G_OBJECT_TYPE (menu_item)), 0,
				  g_cclosure_new_object (G_CALLBACK (menu_item_activated),
							 G_OBJECT (toggle_tool_button)),
				  FALSE);

  gtk_tool_item_set_proxy_menu_item (item, MENU_ID, menu_item);
  
  return TRUE;
}

/* There are two activatable widgets, a toggle button and a menu item.
 *
 * If a widget is activated and the state of the tool button is the same as
 * the new state of the activated widget, then the other widget was the one
 * that was activated by the user and updated the tool button's state.
 *
 * If the state of the tool button is not the same as the new state of the
 * activated widget, then the activation was activated by the user, and the
 * widget needs to make sure the tool button is updated before the other
 * widget is activated. This will make sure the other widget a tool button
 * in a state that matches its own new state.
 */
static void
menu_item_activated (GtkWidget           *menu_item,
		     GtkToggleToolButton *toggle_tool_button)
{
  GtkToolButton *tool_button = GTK_TOOL_BUTTON (toggle_tool_button);
  gboolean menu_active = gtk_check_menu_item_get_active (GTK_CHECK_MENU_ITEM (menu_item));

259
  if (toggle_tool_button->priv->active != menu_active)
260
    {
261
      toggle_tool_button->priv->active = menu_active;
262

263 264
      gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (_gtk_tool_button_get_button (tool_button)),
				    toggle_tool_button->priv->active);
265

Matthias Clasen's avatar
Matthias Clasen committed
266
      g_object_notify (G_OBJECT (toggle_tool_button), "active");
267
      g_signal_emit (toggle_tool_button, toggle_signals[TOGGLED], 0);
268 269 270 271 272 273 274 275 276
    }
}

static void
button_toggled (GtkWidget           *widget,
		GtkToggleToolButton *toggle_tool_button)
{
  gboolean toggle_active = GTK_TOGGLE_BUTTON (widget)->active;

277
  if (toggle_tool_button->priv->active != toggle_active)
278 279 280
    {
      GtkWidget *menu_item;
      
281
      toggle_tool_button->priv->active = toggle_active;
282 283 284 285 286
       
      if ((menu_item =
	   gtk_tool_item_get_proxy_menu_item (GTK_TOOL_ITEM (toggle_tool_button), MENU_ID)))
	{
	  gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (menu_item),
287
					  toggle_tool_button->priv->active);
288 289
	}

Matthias Clasen's avatar
Matthias Clasen committed
290
      g_object_notify (G_OBJECT (toggle_tool_button), "active");
291
      g_signal_emit (toggle_tool_button, toggle_signals[TOGGLED], 0);
292 293 294
    }
}

295 296 297 298 299 300 301 302 303
/**
 * gtk_toggle_tool_button_new:
 * 
 * Returns a new #GtkToggleToolButton
 * 
 * Return value: a newly created #GtkToggleToolButton
 * 
 * Since: 2.4
 **/
304 305 306 307 308 309 310 311 312 313 314
GtkToolItem *
gtk_toggle_tool_button_new (void)
{
  GtkToolButton *button;

  button = g_object_new (GTK_TYPE_TOGGLE_TOOL_BUTTON,
			 NULL);
  
  return GTK_TOOL_ITEM (button);
}

315 316 317 318 319 320 321 322 323 324 325 326 327 328
/**
 * gtk_toggle_tool_button_new_from_stock:
 * @stock_id: the name of the stock item 
 *
 * Creates a new #GtkToggleToolButton containing the image and text from a
 * stock item. Some stock ids have preprocessor macros like #GTK_STOCK_OK
 * and #GTK_STOCK_APPLY.
 *
 * It is an error if @stock_id is not a name of a stock item.
 * 
 * Return value: A new #GtkToggleToolButton
 * 
 * Since: 2.4
 **/
329 330 331 332 333 334 335 336
GtkToolItem *
gtk_toggle_tool_button_new_from_stock (const gchar *stock_id)
{
  GtkToolButton *button;

  g_return_val_if_fail (stock_id != NULL, NULL);
  
  button = g_object_new (GTK_TYPE_TOGGLE_TOOL_BUTTON,
337
			 "stock-id", stock_id,
338 339 340 341 342
			 NULL);
  
  return GTK_TOOL_ITEM (button);
}

343 344 345 346 347 348 349 350 351 352 353
/**
 * gtk_toggle_tool_button_set_active:
 * @button: a #GtkToggleToolButton
 * @is_active: whether @button should be active
 * 
 * Sets the status of the toggle tool button. Set to %TRUE if you
 * want the GtkToggleButton to be 'pressed in', and %FALSE to raise it.
 * This action causes the toggled signal to be emitted.
 * 
 * Since: 2.4
 **/
354 355 356 357 358 359 360 361
void
gtk_toggle_tool_button_set_active (GtkToggleToolButton *button,
				   gboolean is_active)
{
  g_return_if_fail (GTK_IS_TOGGLE_TOOL_BUTTON (button));

  is_active = is_active != FALSE;

362 363
  if (button->priv->active != is_active)
    gtk_button_clicked (GTK_BUTTON (_gtk_tool_button_get_button (GTK_TOOL_BUTTON (button))));
364 365
}

366 367 368 369 370 371 372 373 374 375 376
/**
 * gtk_toggle_tool_button_get_active:
 * @button: a #GtkToggleToolButton
 * 
 * Queries a #GtkToggleToolButton and returns its current state.
 * Returns %TRUE if the toggle button is pressed in and %FALSE if it is raised.
 * 
 * Return value: %TRUE if the toggle tool button is pressed in, %FALSE if not
 * 
 * Since: 2.4
 **/
377 378 379 380 381
gboolean
gtk_toggle_tool_button_get_active (GtkToggleToolButton *button)
{
  g_return_val_if_fail (GTK_IS_TOGGLE_TOOL_BUTTON (button), FALSE);

382
  return button->priv->active;
383
}
384 385 386

#define __GTK_TOGGLE_TOOL_BUTTON_C__
#include "gtkaliasdef.c"