gtkcheckbutton.c 16.2 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Elliot Lee's avatar
Elliot Lee committed
2 3 4
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10 11
 * 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
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
Javier Jardón's avatar
Javier Jardón committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
Elliot Lee's avatar
Elliot Lee committed
16
 */
17 18

/*
19
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
20 21 22 23 24
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

25
#include "config.h"
26

Elliot Lee's avatar
Elliot Lee committed
27
#include "gtkcheckbutton.h"
28

29
#include "gtkbuttonprivate.h"
Elliot Lee's avatar
Elliot Lee committed
30
#include "gtklabel.h"
31

32 33
#include "gtkprivate.h"
#include "gtkintl.h"
Elliot Lee's avatar
Elliot Lee committed
34 35


36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
/**
 * SECTION:gtkcheckbutton
 * @Short_description: Create widgets with a discrete toggle button
 * @Title: GtkCheckButton
 * @See_also: #GtkCheckMenuItem, #GtkButton, #GtkToggleButton, #GtkRadioButton
 *
 * A #GtkCheckButton places a discrete #GtkToggleButton next to a widget,
 * (usually a #GtkLabel). See the section on #GtkToggleButton widgets for
 * more information about toggle/check buttons.
 *
 * The important signal ( #GtkToggleButton::toggled ) is also inherited from
 * #GtkToggleButton.
 */


51
#define INDICATOR_SIZE     16
Elliot Lee's avatar
Elliot Lee committed
52 53 54
#define INDICATOR_SPACING  2


55 56 57 58 59 60
static void gtk_check_button_get_preferred_width  (GtkWidget          *widget,
                                                   gint               *minimum,
                                                   gint               *natural);
static void gtk_check_button_get_preferred_height (GtkWidget          *widget,
                                                   gint               *minimum,
                                                   gint               *natural);
Elliot Lee's avatar
Elliot Lee committed
61 62
static void gtk_check_button_size_allocate       (GtkWidget           *widget,
						  GtkAllocation       *allocation);
63 64
static gboolean gtk_check_button_draw            (GtkWidget           *widget,
						  cairo_t             *cr);
65
static void gtk_check_button_paint               (GtkWidget           *widget,
66
						  cairo_t             *cr);
Elliot Lee's avatar
Elliot Lee committed
67
static void gtk_check_button_draw_indicator      (GtkCheckButton      *check_button,
68
						  cairo_t             *cr);
Elliot Lee's avatar
Elliot Lee committed
69
static void gtk_real_check_button_draw_indicator (GtkCheckButton      *check_button,
70
						  cairo_t             *cr);
Elliot Lee's avatar
Elliot Lee committed
71

Matthias Clasen's avatar
Matthias Clasen committed
72
G_DEFINE_TYPE (GtkCheckButton, gtk_check_button, GTK_TYPE_TOGGLE_BUTTON)
Elliot Lee's avatar
Elliot Lee committed
73 74 75 76 77

static void
gtk_check_button_class_init (GtkCheckButtonClass *class)
{
  GtkWidgetClass *widget_class;
78

Elliot Lee's avatar
Elliot Lee committed
79
  widget_class = (GtkWidgetClass*) class;
80 81 82

  widget_class->get_preferred_width = gtk_check_button_get_preferred_width;
  widget_class->get_preferred_height = gtk_check_button_get_preferred_height;
Elliot Lee's avatar
Elliot Lee committed
83
  widget_class->size_allocate = gtk_check_button_size_allocate;
84
  widget_class->draw = gtk_check_button_draw;
85

Elliot Lee's avatar
Elliot Lee committed
86
  class->draw_indicator = gtk_real_check_button_draw_indicator;
87

88 89
  gtk_widget_class_set_accessible_role (widget_class, ATK_ROLE_CHECK_BOX);

90
  gtk_widget_class_install_style_property (widget_class,
91
					   g_param_spec_int ("indicator-size",
92 93
							     P_("Indicator Size"),
							     P_("Size of check or radio indicator"),
94 95 96
							     0,
							     G_MAXINT,
							     INDICATOR_SIZE,
97
							     GTK_PARAM_READABLE));
98
  gtk_widget_class_install_style_property (widget_class,
99
					   g_param_spec_int ("indicator-spacing",
100 101
							     P_("Indicator Spacing"),
							     P_("Spacing around check or radio indicator"),
102 103 104
							     0,
							     G_MAXINT,
							     INDICATOR_SPACING,
105
							     GTK_PARAM_READABLE));
Elliot Lee's avatar
Elliot Lee committed
106 107 108 109 110
}

static void
gtk_check_button_init (GtkCheckButton *check_button)
{
111
  gtk_widget_set_receives_default (GTK_WIDGET (check_button), FALSE);
112
  gtk_toggle_button_set_mode (GTK_TOGGLE_BUTTON (check_button), TRUE);
113
  gtk_button_set_alignment (GTK_BUTTON (check_button), 0.0, 0.5);
Elliot Lee's avatar
Elliot Lee committed
114 115
}

116 117 118 119 120 121 122
/**
 * gtk_check_button_new:
 *
 * Creates a new #GtkCheckButton.
 *
 * Returns: a #GtkWidget.
 */
Elliot Lee's avatar
Elliot Lee committed
123
GtkWidget*
124
gtk_check_button_new (void)
Elliot Lee's avatar
Elliot Lee committed
125
{
Manish Singh's avatar
Manish Singh committed
126
  return g_object_new (GTK_TYPE_CHECK_BUTTON, NULL);
Elliot Lee's avatar
Elliot Lee committed
127 128 129
}


130 131 132 133 134 135 136 137
/**
 * gtk_check_button_new_with_label:
 * @label: the text for the check button.
 *
 * Creates a new #GtkCheckButton with a #GtkLabel to the right of it.
 *
 * Returns: a #GtkWidget.
 */
Elliot Lee's avatar
Elliot Lee committed
138 139 140
GtkWidget*
gtk_check_button_new_with_label (const gchar *label)
{
141
  return g_object_new (GTK_TYPE_CHECK_BUTTON, "label", label, NULL);
Elliot Lee's avatar
Elliot Lee committed
142 143
}

144 145 146
/**
 * gtk_check_button_new_with_mnemonic:
 * @label: The text of the button, with an underscore in front of the
147
 *   mnemonic character
148
 *
149 150 151
 * Creates a new #GtkCheckButton containing a label. The label
 * will be created using gtk_label_new_with_mnemonic(), so underscores
 * in @label indicate the mnemonic for the check button.
Matthias Clasen's avatar
Matthias Clasen committed
152 153 154
 *
 * Returns: a new #GtkCheckButton
 */
155 156 157
GtkWidget*
gtk_check_button_new_with_mnemonic (const gchar *label)
{
158 159 160 161
  return g_object_new (GTK_TYPE_CHECK_BUTTON, 
                       "label", label, 
                       "use-underline", TRUE, 
                       NULL);
162 163 164
}


165 166 167 168 169
/* This should only be called when toggle_button->draw_indicator
 * is true.
 */
static void
gtk_check_button_paint (GtkWidget    *widget,
170
			cairo_t      *cr)
171
{
172
  GtkCheckButton *check_button = GTK_CHECK_BUTTON (widget);
173

174
  gtk_check_button_draw_indicator (check_button, cr);
175

176
  if (gtk_widget_has_visible_focus (widget))
177
    {
178
      GtkWidget *child = gtk_bin_get_child (GTK_BIN (widget));
179
      GtkStyleContext *context;
180
      GtkAllocation allocation;
181 182 183 184 185 186 187 188 189 190 191 192
      gint border_width;
      gint interior_focus;
      gint focus_width;
      gint focus_pad;

      border_width = gtk_container_get_border_width (GTK_CONTAINER (widget));

      gtk_widget_style_get (widget,
                            "interior-focus", &interior_focus,
                            "focus-line-width", &focus_width,
                            "focus-padding", &focus_pad,
                            NULL);
193

194
      gtk_widget_get_allocation (widget, &allocation);
195
      context = gtk_widget_get_style_context (widget);
196 197 198 199 200 201

      if (interior_focus && child && gtk_widget_get_visible (child))
        {
          GtkAllocation child_allocation;

          gtk_widget_get_allocation (child, &child_allocation);
202 203 204 205 206
          gtk_render_focus (context, cr,
                            child_allocation.x - allocation.x - focus_width - focus_pad,
                            child_allocation.y - allocation.y - focus_width - focus_pad,
                            child_allocation.width + 2 * (focus_width + focus_pad),
                            child_allocation.height + 2 * (focus_width + focus_pad));
207 208
        }
      else
209 210 211 212
        gtk_render_focus (context, cr,
                          border_width, border_width,
                          allocation.width - 2 * border_width,
                          allocation.height - 2 * border_width);
213 214 215
    }
}

216 217 218 219 220 221 222 223
void
_gtk_check_button_get_props (GtkCheckButton *check_button,
			     gint           *indicator_size,
			     gint           *indicator_spacing)
{
  GtkWidget *widget =  GTK_WIDGET (check_button);

  if (indicator_size)
224
    gtk_widget_style_get (widget, "indicator-size", indicator_size, NULL);
225 226

  if (indicator_spacing)
227
    gtk_widget_style_get (widget, "indicator-spacing", indicator_spacing, NULL);
228 229
}

Elliot Lee's avatar
Elliot Lee committed
230
static void
231 232 233
gtk_check_button_get_preferred_width (GtkWidget *widget,
                                      gint      *minimum,
                                      gint      *natural)
Elliot Lee's avatar
Elliot Lee committed
234
{
235
  GtkToggleButton *toggle_button = GTK_TOGGLE_BUTTON (widget);
236
  
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
  if (gtk_toggle_button_get_mode (toggle_button))
    {
      GtkWidget *child;
      gint indicator_size;
      gint indicator_spacing;
      gint focus_width;
      gint focus_pad;
      guint border_width;

      border_width = gtk_container_get_border_width (GTK_CONTAINER (widget));

      gtk_widget_style_get (GTK_WIDGET (widget),
                            "focus-line-width", &focus_width,
                            "focus-padding", &focus_pad,
                            NULL);
      *minimum = 2 * border_width;
      *natural = 2 * border_width;

      _gtk_check_button_get_props (GTK_CHECK_BUTTON (widget),
                                   &indicator_size, &indicator_spacing);

      child = gtk_bin_get_child (GTK_BIN (widget));
      if (child && gtk_widget_get_visible (child))
        {
          gint child_min, child_nat;

          gtk_widget_get_preferred_width (child, &child_min, &child_nat);

          *minimum += child_min + indicator_spacing;
          *natural += child_nat + indicator_spacing;
        }

      *minimum += (indicator_size + indicator_spacing * 2 + 2 * (focus_width + focus_pad));
      *natural += (indicator_size + indicator_spacing * 2 + 2 * (focus_width + focus_pad));
    }
  else
    GTK_WIDGET_CLASS (gtk_check_button_parent_class)->get_preferred_width (widget, minimum, natural);
}

static void
gtk_check_button_get_preferred_height (GtkWidget *widget,
                                       gint      *minimum,
                                       gint      *natural)
{
  GtkToggleButton *toggle_button = GTK_TOGGLE_BUTTON (widget);

283
  if (gtk_toggle_button_get_mode (toggle_button))
Elliot Lee's avatar
Elliot Lee committed
284
    {
285 286 287 288
      GtkWidget *child;
      gint temp;
      gint indicator_size;
      gint indicator_spacing;
289 290
      gint focus_width;
      gint focus_pad;
291 292 293
      guint border_width;

      border_width = gtk_container_get_border_width (GTK_CONTAINER (widget));
294 295

      gtk_widget_style_get (GTK_WIDGET (widget),
296 297 298 299 300 301
                            "focus-line-width", &focus_width,
                            "focus-padding", &focus_pad,
                            NULL);

      *minimum = border_width * 2;
      *natural = border_width * 2;
302

303
      _gtk_check_button_get_props (GTK_CHECK_BUTTON (widget),
304 305
                                   &indicator_size, &indicator_spacing);

Javier Jardón's avatar
Javier Jardón committed
306
      child = gtk_bin_get_child (GTK_BIN (widget));
307
      if (child && gtk_widget_get_visible (child))
308 309
        {
          gint child_min, child_nat;
310

311 312 313 314 315
          gtk_widget_get_preferred_height (child, &child_min, &child_nat);

          *minimum += child_min;
          *natural += child_nat;
        }
Havoc Pennington's avatar
Havoc Pennington committed
316

317
      temp = indicator_size + indicator_spacing * 2;
318 319
      *minimum = MAX (*minimum, temp) + 2 * (focus_width + focus_pad);
      *natural = MAX (*natural, temp) + 2 * (focus_width + focus_pad);
Elliot Lee's avatar
Elliot Lee committed
320
    }
321
  else
322
    GTK_WIDGET_CLASS (gtk_check_button_parent_class)->get_preferred_height (widget, minimum, natural);
Elliot Lee's avatar
Elliot Lee committed
323 324 325 326 327 328 329
}

static void
gtk_check_button_size_allocate (GtkWidget     *widget,
				GtkAllocation *allocation)
{
  GtkCheckButton *check_button;
330
  GtkToggleButton *toggle_button;
Elliot Lee's avatar
Elliot Lee committed
331 332
  GtkButton *button;
  GtkAllocation child_allocation;
333

334
  button = GTK_BUTTON (widget);
Elliot Lee's avatar
Elliot Lee committed
335
  check_button = GTK_CHECK_BUTTON (widget);
336
  toggle_button = GTK_TOGGLE_BUTTON (widget);
337

338
  if (gtk_toggle_button_get_mode (toggle_button))
Elliot Lee's avatar
Elliot Lee committed
339
    {
Javier Jardón's avatar
Javier Jardón committed
340
      GtkWidget *child;
341 342
      gint indicator_size;
      gint indicator_spacing;
343 344
      gint focus_width;
      gint focus_pad;
345 346
      
      _gtk_check_button_get_props (check_button, &indicator_size, &indicator_spacing);
347 348 349 350
      gtk_widget_style_get (widget,
			    "focus-line-width", &focus_width,
			    "focus-padding", &focus_pad,
			    NULL);
351 352 353

      gtk_widget_set_allocation (widget, allocation);

354
      if (gtk_widget_get_realized (widget))
355
	gdk_window_move_resize (gtk_button_get_event_window (button),
Elliot Lee's avatar
Elliot Lee committed
356 357
				allocation->x, allocation->y,
				allocation->width, allocation->height);
Javier Jardón's avatar
Javier Jardón committed
358 359 360

      child = gtk_bin_get_child (GTK_BIN (button));
      if (child && gtk_widget_get_visible (child))
Elliot Lee's avatar
Elliot Lee committed
361
	{
362
          guint border_width = gtk_container_get_border_width (GTK_CONTAINER (widget));
363

364 365
	  child_allocation.width = allocation->width -
	    ((border_width + focus_width + focus_pad) * 2 + indicator_size + indicator_spacing * 3);
366
	  child_allocation.width = MAX (child_allocation.width, 1);
367

368
	  child_allocation.height = allocation->height - (border_width + focus_width + focus_pad) * 2;
369 370
	  child_allocation.height = MAX (child_allocation.height, 1);
	  
371
	  child_allocation.x = (border_width + indicator_size + indicator_spacing * 3 +
372 373
                                allocation->x + focus_width + focus_pad);
          child_allocation.y = allocation->y + (allocation->height - child_allocation.height) / 2;
374

375 376 377 378
	  if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL)
	    child_allocation.x = allocation->x + allocation->width
	      - (child_allocation.x - allocation->x + child_allocation.width);
	  
Javier Jardón's avatar
Javier Jardón committed
379
	  gtk_widget_size_allocate (child, &child_allocation);
Elliot Lee's avatar
Elliot Lee committed
380 381 382
	}
    }
  else
383
    GTK_WIDGET_CLASS (gtk_check_button_parent_class)->size_allocate (widget, allocation);
Elliot Lee's avatar
Elliot Lee committed
384 385 386
}

static gint
387 388
gtk_check_button_draw (GtkWidget *widget,
                       cairo_t   *cr)
Elliot Lee's avatar
Elliot Lee committed
389
{
390 391
  GtkToggleButton *toggle_button;
  GtkBin *bin;
Javier Jardón's avatar
Javier Jardón committed
392
  GtkWidget *child;
393 394 395
  
  toggle_button = GTK_TOGGLE_BUTTON (widget);
  bin = GTK_BIN (widget);
396 397

  if (gtk_toggle_button_get_mode (toggle_button))
Elliot Lee's avatar
Elliot Lee committed
398
    {
399
      gtk_check_button_paint (widget, cr);
Javier Jardón's avatar
Javier Jardón committed
400

401 402 403 404 405
      child = gtk_bin_get_child (bin);
      if (child)
        gtk_container_propagate_draw (GTK_CONTAINER (widget),
                                      child,
                                      cr);
Elliot Lee's avatar
Elliot Lee committed
406
    }
407 408 409
  else if (GTK_WIDGET_CLASS (gtk_check_button_parent_class)->draw)
    GTK_WIDGET_CLASS (gtk_check_button_parent_class)->draw (widget, cr);

Elliot Lee's avatar
Elliot Lee committed
410 411 412 413 414 415
  return FALSE;
}


static void
gtk_check_button_draw_indicator (GtkCheckButton *check_button,
416
				 cairo_t        *cr)
Elliot Lee's avatar
Elliot Lee committed
417
{
418
  GtkCheckButtonClass *class = GTK_CHECK_BUTTON_GET_CLASS (check_button);
419

Elliot Lee's avatar
Elliot Lee committed
420
  if (class->draw_indicator)
421
    class->draw_indicator (check_button, cr);
Elliot Lee's avatar
Elliot Lee committed
422 423 424 425
}

static void
gtk_real_check_button_draw_indicator (GtkCheckButton *check_button,
426
				      cairo_t        *cr)
Elliot Lee's avatar
Elliot Lee committed
427 428
{
  GtkWidget *widget;
429
  GtkWidget *child;
430
  GtkButton *button;
Elliot Lee's avatar
Elliot Lee committed
431
  GtkToggleButton *toggle_button;
432
  GtkStateFlags state = 0;
Elliot Lee's avatar
Elliot Lee committed
433
  gint x, y;
434 435
  gint indicator_size;
  gint indicator_spacing;
436 437
  gint focus_width;
  gint focus_pad;
438
  guint border_width;
439
  gboolean interior_focus;
440
  GtkAllocation allocation;
441
  GtkStyleContext *context;
442 443

  widget = GTK_WIDGET (check_button);
444 445
  button = GTK_BUTTON (check_button);
  toggle_button = GTK_TOGGLE_BUTTON (check_button);
446

447
  gtk_widget_get_allocation (widget, &allocation);
448
  context = gtk_widget_get_style_context (widget);
449
  state = gtk_widget_get_state_flags (widget);
450

451 452 453 454 455
  gtk_widget_style_get (widget, 
                        "interior-focus", &interior_focus,
                        "focus-line-width", &focus_width, 
                        "focus-padding", &focus_pad, 
                        NULL);
456

457
  _gtk_check_button_get_props (check_button, &indicator_size, &indicator_spacing);
458

459
  border_width = gtk_container_get_border_width (GTK_CONTAINER (widget));
460

461 462
  x = indicator_spacing + border_width;
  y = (allocation.height - indicator_size) / 2;
463

464 465 466
  child = gtk_bin_get_child (GTK_BIN (check_button));
  if (!interior_focus || !(child && gtk_widget_get_visible (child)))
    x += focus_width + focus_pad;      
467

468 469 470 471 472
  state &= ~(GTK_STATE_FLAG_INCONSISTENT |
             GTK_STATE_FLAG_ACTIVE |
             GTK_STATE_FLAG_SELECTED |
             GTK_STATE_FLAG_PRELIGHT);

473
  if (gtk_toggle_button_get_inconsistent (toggle_button))
474
    state |= GTK_STATE_FLAG_INCONSISTENT;
475 476
  else if (gtk_toggle_button_get_active (toggle_button) ||
           (button->priv->button_down && button->priv->in_button))
477
    state |= GTK_STATE_FLAG_ACTIVE;
478

479
  if (button->priv->activate_timeout || (button->priv->button_down && button->priv->in_button))
480 481 482 483 484
    state |= GTK_STATE_FLAG_SELECTED;

  if (button->priv->in_button)
    state |= GTK_STATE_FLAG_PRELIGHT;

485
  if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL)
486
    x = allocation.width - (indicator_size + x);
487

488
  gtk_style_context_save (context);
489
  gtk_style_context_set_state (context, state);
490

491 492 493 494 495 496 497 498 499 500
  if (state & GTK_STATE_FLAG_PRELIGHT)
    gtk_render_background (context, cr,
                           border_width, border_width,
                           allocation.width - (2 * border_width),
                           allocation.height - (2 * border_width));

  gtk_style_context_add_class (context, GTK_STYLE_CLASS_CHECK);

  gtk_render_check (context, cr,
		    x, y, indicator_size, indicator_size);
501

502
  gtk_style_context_restore (context);
Elliot Lee's avatar
Elliot Lee committed
503
}