Pileus Git - ~andy/gtk/blob - gtk/gtktogglebutton.c

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GTK+ Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #include "gtklabel.h"
  28 #include "gtkmain.h"
  29 #include "gtkmarshalers.h"
  30 #include "gtksignal.h"
  31 #include "gtktogglebutton.h"
  32 #include "gtkintl.h"
  33
  34 #define DEFAULT_LEFT_POS  4
  35 #define DEFAULT_TOP_POS   4
  36 #define DEFAULT_SPACING   7
  37
  38 enum {
  39   TOGGLED,
  40   LAST_SIGNAL
  41 };
  42
  43 enum {
  44   PROP_0,
  45   PROP_ACTIVE,
  46   PROP_INCONSISTENT,
  47   PROP_DRAW_INDICATOR
  48 };
  49
  50
  51 static void gtk_toggle_button_class_init    (GtkToggleButtonClass *klass);
  52 static void gtk_toggle_button_init          (GtkToggleButton      *toggle_button);
  53 static gint gtk_toggle_button_expose        (GtkWidget            *widget,
  54                                              GdkEventExpose       *event);
  55 static void gtk_toggle_button_pressed       (GtkButton            *button);
  56 static void gtk_toggle_button_released      (GtkButton            *button);
  57 static void gtk_toggle_button_clicked       (GtkButton            *button);
  58 static void gtk_toggle_button_set_property  (GObject              *object,
  59                                              guint                 prop_id,
  60                                              const GValue         *value,
  61                                              GParamSpec           *pspec);
  62 static void gtk_toggle_button_get_property  (GObject              *object,
  63                                              guint                 prop_id,
  64                                              GValue               *value,
  65                                              GParamSpec           *pspec);
  66 static void gtk_toggle_button_update_state  (GtkButton            *button);
  67
  68 static guint toggle_button_signals[LAST_SIGNAL] = { 0 };
  69 static GtkContainerClass *parent_class = NULL;
  70
  71 GtkType
  72 gtk_toggle_button_get_type (void)
  73 {
  74   static GtkType toggle_button_type = 0;
  75
  76   if (!toggle_button_type)
  77     {
  78       static const GtkTypeInfo toggle_button_info =
  79       {
  80         "GtkToggleButton",
  81         sizeof (GtkToggleButton),
  82         sizeof (GtkToggleButtonClass),
  83         (GtkClassInitFunc) gtk_toggle_button_class_init,
  84         (GtkObjectInitFunc) gtk_toggle_button_init,
  85         /* reserved_1 */ NULL,
  86         /* reserved_2 */ NULL,
  87         (GtkClassInitFunc) NULL,
  88       };
  89
  90       toggle_button_type = gtk_type_unique (GTK_TYPE_BUTTON, &toggle_button_info);
  91     }
  92
  93   return toggle_button_type;
  94 }
  95
  96 static void
  97 gtk_toggle_button_class_init (GtkToggleButtonClass *class)
  98 {
  99   GtkObjectClass *object_class;
 100   GObjectClass   *gobject_class;
 101   GtkWidgetClass *widget_class;
 102   GtkContainerClass *container_class;
 103   GtkButtonClass *button_class;
 104
 105   object_class = (GtkObjectClass*) class;
 106   gobject_class = G_OBJECT_CLASS (class);
 107   widget_class = (GtkWidgetClass*) class;
 108   container_class = (GtkContainerClass*) class;
 109   button_class = (GtkButtonClass*) class;
 110
 111   parent_class = gtk_type_class (GTK_TYPE_BUTTON);
 112
 113
 114   gobject_class->set_property = gtk_toggle_button_set_property;
 115   gobject_class->get_property = gtk_toggle_button_get_property;
 116
 117   widget_class->expose_event = gtk_toggle_button_expose;
 118
 119   button_class->pressed = gtk_toggle_button_pressed;
 120   button_class->released = gtk_toggle_button_released;
 121   button_class->clicked = gtk_toggle_button_clicked;
 122   button_class->enter = gtk_toggle_button_update_state;
 123   button_class->leave = gtk_toggle_button_update_state;
 124
 125   class->toggled = NULL;
 126
 127   g_object_class_install_property (gobject_class,
 128                                    PROP_ACTIVE,
 129                                    g_param_spec_boolean ("active",
 130                                                          _("Active"),
 131                                                          _("If the toggle button should be pressed in or not"),
 132                                                          FALSE,
 133                                                          G_PARAM_READWRITE));
 134
 135   g_object_class_install_property (gobject_class,
 136                                    PROP_INCONSISTENT,
 137                                    g_param_spec_boolean ("inconsistent",
 138                                                          _("Inconsistent"),
 139                                                          _("If the toggle button is in an \"in between\" state."),
 140                                                          FALSE,
 141                                                          G_PARAM_READWRITE));
 142
 143   g_object_class_install_property (gobject_class,
 144                                    PROP_DRAW_INDICATOR,
 145                                    g_param_spec_boolean ("draw_indicator",
 146                                                          _("Draw Indicator"),
 147                                                          _("If the toggle part of the button is displayed"),
 148                                                          FALSE,
 149                                                          G_PARAM_READWRITE));
 150
 151   toggle_button_signals[TOGGLED] =
 152     gtk_signal_new ("toggled",
 153                     GTK_RUN_FIRST,
 154                     GTK_CLASS_TYPE (object_class),
 155                     GTK_SIGNAL_OFFSET (GtkToggleButtonClass, toggled),
 156                     _gtk_marshal_VOID__VOID,
 157                     GTK_TYPE_NONE, 0);
 158 }
 159
 160 static void
 161 gtk_toggle_button_init (GtkToggleButton *toggle_button)
 162 {
 163   toggle_button->active = FALSE;
 164   toggle_button->draw_indicator = FALSE;
 165   GTK_BUTTON (toggle_button)->depress_on_activate = TRUE;
 166 }
 167
 168
 169 GtkWidget*
 170 gtk_toggle_button_new (void)
 171 {
 172   return GTK_WIDGET (gtk_type_new (gtk_toggle_button_get_type ()));
 173 }
 174
 175 GtkWidget*
 176 gtk_toggle_button_new_with_label (const gchar *label)
 177 {
 178   return g_object_new (GTK_TYPE_TOGGLE_BUTTON, "label", label, NULL);
 179 }
 180
 181 /**
 182  * gtk_toggle_button_new_with_mnemonic:
 183  * @label: the text of the button, with an underscore in front of the
 184  *         mnemonic character
 185  * @returns: a new #GtkToggleButton
 186  *
 187  * Creates a new #GtkToggleButton containing a label. The label
 188  * will be created using gtk_label_new_with_mnemonic(), so underscores
 189  * in @label indicate the mnemonic for the button.
 190  **/
 191 GtkWidget*
 192 gtk_toggle_button_new_with_mnemonic (const gchar *label)
 193 {
 194   return g_object_new (GTK_TYPE_TOGGLE_BUTTON, "label", label, "use_underline", TRUE, NULL);
 195 }
 196
 197 static void
 198 gtk_toggle_button_set_property (GObject      *object,
 199                                 guint         prop_id,
 200                                 const GValue *value,
 201                                 GParamSpec   *pspec)
 202 {
 203   GtkToggleButton *tb;
 204
 205   tb = GTK_TOGGLE_BUTTON (object);
 206
 207   switch (prop_id)
 208     {
 209     case PROP_ACTIVE:
 210       gtk_toggle_button_set_active (tb, g_value_get_boolean (value));
 211       break;
 212     case PROP_INCONSISTENT:
 213       gtk_toggle_button_set_inconsistent (tb, g_value_get_boolean (value));
 214       break;
 215     case PROP_DRAW_INDICATOR:
 216       gtk_toggle_button_set_mode (tb, g_value_get_boolean (value));
 217       break;
 218     default:
 219       break;
 220     }
 221 }
 222
 223 static void
 224 gtk_toggle_button_get_property (GObject      *object,
 225                                 guint         prop_id,
 226                                 GValue       *value,
 227                                 GParamSpec   *pspec)
 228 {
 229   GtkToggleButton *tb;
 230
 231   tb = GTK_TOGGLE_BUTTON (object);
 232
 233   switch (prop_id)
 234     {
 235     case PROP_ACTIVE:
 236       g_value_set_boolean (value, tb->active);
 237       break;
 238     case PROP_INCONSISTENT:
 239       g_value_set_boolean (value, tb->inconsistent);
 240       break;
 241     case PROP_DRAW_INDICATOR:
 242       g_value_set_boolean (value, tb->draw_indicator);
 243       break;
 244     default:
 245       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 246       break;
 247     }
 248 }
 249
 250 static void
 251 gtk_toggle_button_update_depress_on_activate (GtkToggleButton *toggle_button)
 252 {
 253   GtkButton *button = GTK_BUTTON (toggle_button);
 254
 255   if (toggle_button->draw_indicator || toggle_button->inconsistent)
 256     button->depress_on_activate = FALSE;
 257   else
 258     button->depress_on_activate = !toggle_button->active;
 259 }
 260
 261 void
 262 gtk_toggle_button_set_mode (GtkToggleButton *toggle_button,
 263                             gboolean         draw_indicator)
 264 {
 265   GtkWidget *widget;
 266
 267   g_return_if_fail (GTK_IS_TOGGLE_BUTTON (toggle_button));
 268
 269   widget = GTK_WIDGET (toggle_button);
 270
 271   draw_indicator = draw_indicator ? TRUE : FALSE;
 272
 273   if (toggle_button->draw_indicator != draw_indicator)
 274     {
 275       toggle_button->draw_indicator = draw_indicator;
 276
 277       gtk_toggle_button_update_depress_on_activate (toggle_button);
 278
 279       if (GTK_WIDGET_VISIBLE (toggle_button))
 280         gtk_widget_queue_resize (GTK_WIDGET (toggle_button));
 281
 282       g_object_notify (G_OBJECT (toggle_button), "draw_indicator");
 283     }
 284 }
 285
 286 /**
 287  * gtk_toggle_button_get_mode:
 288  * @toggle_button: a #GtkToggleButton
 289  *
 290  * Retrieves whether the button is displayed as a separate indicator
 291  * and label. See gtk_toggle_button_set_mode().
 292  *
 293  * Return value: %TRUE if the togglebutton is drawn as a separate indicator
 294  *   and label.
 295  **/
 296 gboolean
 297 gtk_toggle_button_get_mode (GtkToggleButton *toggle_button)
 298 {
 299   g_return_val_if_fail (GTK_IS_TOGGLE_BUTTON (toggle_button), FALSE);
 300
 301   return toggle_button->draw_indicator;
 302 }
 303
 304 void
 305 gtk_toggle_button_set_active (GtkToggleButton *toggle_button,
 306                               gboolean         is_active)
 307 {
 308   g_return_if_fail (GTK_IS_TOGGLE_BUTTON (toggle_button));
 309
 310   is_active = is_active != FALSE;
 311
 312   if (toggle_button->active != is_active)
 313     gtk_button_clicked (GTK_BUTTON (toggle_button));
 314 }
 315
 316
 317 gboolean
 318 gtk_toggle_button_get_active (GtkToggleButton *toggle_button)
 319 {
 320   g_return_val_if_fail (GTK_IS_TOGGLE_BUTTON (toggle_button), FALSE);
 321
 322   return (toggle_button->active) ? TRUE : FALSE;
 323 }
 324
 325
 326 void
 327 gtk_toggle_button_toggled (GtkToggleButton *toggle_button)
 328 {
 329   g_return_if_fail (GTK_IS_TOGGLE_BUTTON (toggle_button));
 330
 331   gtk_signal_emit (GTK_OBJECT (toggle_button), toggle_button_signals[TOGGLED]);
 332 }
 333
 334 /**
 335  * gtk_toggle_button_set_inconsistent:
 336  * @toggle_button: a #GtkToggleButton
 337  * @setting: %TRUE if state is inconsistent
 338  *
 339  * If the user has selected a range of elements (such as some text or
 340  * spreadsheet cells) that are affected by a toggle button, and the
 341  * current values in that range are inconsistent, you may want to
 342  * display the toggle in an "in between" state. This function turns on
 343  * "in between" display.  Normally you would turn off the inconsistent
 344  * state again if the user toggles the toggle button. This has to be
 345  * done manually, gtk_toggle_button_set_inconsistent() only affects
 346  * visual appearance, it doesn't affect the semantics of the button.
 347  *
 348  **/
 349 void
 350 gtk_toggle_button_set_inconsistent (GtkToggleButton *toggle_button,
 351                                     gboolean         setting)
 352 {
 353   g_return_if_fail (GTK_IS_TOGGLE_BUTTON (toggle_button));
 354
 355   setting = setting != FALSE;
 356
 357   if (setting != toggle_button->inconsistent)
 358     {
 359       toggle_button->inconsistent = setting;
 360
 361       gtk_toggle_button_update_depress_on_activate (toggle_button);
 362       gtk_toggle_button_update_state (GTK_BUTTON (toggle_button));
 363       gtk_widget_queue_draw (GTK_WIDGET (toggle_button));
 364
 365       g_object_notify (G_OBJECT (toggle_button), "inconsistent");
 366     }
 367 }
 368
 369 /**
 370  * gtk_toggle_button_get_inconsistent:
 371  * @toggle_button: a #GtkToggleButton
 372  *
 373  * Gets the value set by gtk_toggle_button_set_inconsistent().
 374  *
 375  * Return value: %TRUE if the button is displayed as inconsistent, %FALSE otherwise
 376  **/
 377 gboolean
 378 gtk_toggle_button_get_inconsistent (GtkToggleButton *toggle_button)
 379 {
 380   g_return_val_if_fail (GTK_IS_TOGGLE_BUTTON (toggle_button), FALSE);
 381
 382   return toggle_button->inconsistent;
 383 }
 384
 385 static gint
 386 gtk_toggle_button_expose (GtkWidget      *widget,
 387                           GdkEventExpose *event)
 388 {
 389   if (GTK_WIDGET_DRAWABLE (widget))
 390     {
 391       GtkWidget *child = GTK_BIN (widget)->child;
 392       GtkButton *button = GTK_BUTTON (widget);
 393       GtkStateType state_type;
 394       GtkShadowType shadow_type;
 395
 396       state_type = GTK_WIDGET_STATE (widget);
 397
 398       if (GTK_TOGGLE_BUTTON (widget)->inconsistent)
 399         {
 400           if (state_type == GTK_STATE_ACTIVE)
 401             state_type = GTK_STATE_NORMAL;
 402           shadow_type = GTK_SHADOW_ETCHED_IN;
 403         }
 404       else
 405         shadow_type = button->depressed ? GTK_SHADOW_IN : GTK_SHADOW_OUT;
 406
 407       _gtk_button_paint (button, &event->area, state_type, shadow_type,
 408                          "togglebutton", "togglebuttondefault");
 409
 410       if (child)
 411         gtk_container_propagate_expose (GTK_CONTAINER (widget), child, event);
 412     }
 413
 414   return FALSE;
 415 }
 416
 417 static void
 418 gtk_toggle_button_pressed (GtkButton *button)
 419 {
 420   button->button_down = TRUE;
 421
 422   gtk_toggle_button_update_state (button);
 423   gtk_widget_queue_draw (GTK_WIDGET (button));
 424 }
 425
 426 static void
 427 gtk_toggle_button_released (GtkButton *button)
 428 {
 429   if (button->button_down)
 430     {
 431       button->button_down = FALSE;
 432
 433       if (button->in_button)
 434         gtk_button_clicked (button);
 435
 436       gtk_toggle_button_update_state (button);
 437       gtk_widget_queue_draw (GTK_WIDGET (button));
 438     }
 439 }
 440
 441 static void
 442 gtk_toggle_button_clicked (GtkButton *button)
 443 {
 444   GtkToggleButton *toggle_button = GTK_TOGGLE_BUTTON (button);
 445   toggle_button->active = !toggle_button->active;
 446
 447   gtk_toggle_button_update_depress_on_activate (toggle_button);
 448
 449   gtk_toggle_button_toggled (toggle_button);
 450
 451   gtk_toggle_button_update_state (button);
 452
 453   g_object_notify (G_OBJECT (toggle_button), "active");
 454 }
 455
 456 static void
 457 gtk_toggle_button_update_state (GtkButton *button)
 458 {
 459   GtkToggleButton *toggle_button = GTK_TOGGLE_BUTTON (button);
 460   gboolean depressed;
 461   GtkStateType new_state;
 462
 463   if (toggle_button->inconsistent)
 464     depressed = FALSE;
 465   else if (button->in_button && button->button_down)
 466     depressed = !toggle_button->active;
 467   else
 468     depressed = toggle_button->active;
 469
 470   if (button->in_button && (!button->button_down || toggle_button->draw_indicator))
 471     new_state = GTK_STATE_PRELIGHT;
 472   else
 473     new_state = depressed ? GTK_STATE_ACTIVE : GTK_STATE_NORMAL;
 474
 475   _gtk_button_set_depressed (button, depressed);
 476   gtk_widget_set_state (GTK_WIDGET (toggle_button), new_state);
 477 }