gtkcheckbutton.c 16.3 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
15 16 17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
18
 */
19 20

/*
21
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22 23 24 25 26
 * 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/. 
 */

27
#include "config.h"
28

Elliot Lee's avatar
Elliot Lee committed
29
#include "gtkcheckbutton.h"
30

31
#include "gtkbuttonprivate.h"
Elliot Lee's avatar
Elliot Lee committed
32
#include "gtklabel.h"
33

34 35
#include "gtkprivate.h"
#include "gtkintl.h"
Elliot Lee's avatar
Elliot Lee committed
36 37


38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
/**
 * 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.
 */


53
#define INDICATOR_SIZE     16
Elliot Lee's avatar
Elliot Lee committed
54 55 56
#define INDICATOR_SPACING  2


57 58 59 60 61 62
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
63 64
static void gtk_check_button_size_allocate       (GtkWidget           *widget,
						  GtkAllocation       *allocation);
65 66
static gboolean gtk_check_button_draw            (GtkWidget           *widget,
						  cairo_t             *cr);
67
static void gtk_check_button_paint               (GtkWidget           *widget,
68
						  cairo_t             *cr);
Elliot Lee's avatar
Elliot Lee committed
69
static void gtk_check_button_draw_indicator      (GtkCheckButton      *check_button,
70
						  cairo_t             *cr);
Elliot Lee's avatar
Elliot Lee committed
71
static void gtk_real_check_button_draw_indicator (GtkCheckButton      *check_button,
72
						  cairo_t             *cr);
Elliot Lee's avatar
Elliot Lee committed
73

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

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

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

  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
85
  widget_class->size_allocate = gtk_check_button_size_allocate;
86
  widget_class->draw = gtk_check_button_draw;
87

Elliot Lee's avatar
Elliot Lee committed
88
  class->draw_indicator = gtk_real_check_button_draw_indicator;
89

90 91
  gtk_widget_class_set_accessible_role (widget_class, ATK_ROLE_CHECK_BOX);

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

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

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


132 133 134 135 136 137 138 139
/**
 * 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
140 141 142
GtkWidget*
gtk_check_button_new_with_label (const gchar *label)
{
143
  return g_object_new (GTK_TYPE_CHECK_BUTTON, "label", label, NULL);
Elliot Lee's avatar
Elliot Lee committed
144 145
}

146 147 148
/**
 * gtk_check_button_new_with_mnemonic:
 * @label: The text of the button, with an underscore in front of the
149
 *   mnemonic character
150 151
 * @returns: a new #GtkCheckButton
 *
152 153 154
 * 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.
155 156 157 158
 **/
GtkWidget*
gtk_check_button_new_with_mnemonic (const gchar *label)
{
159 160 161 162
  return g_object_new (GTK_TYPE_CHECK_BUTTON, 
                       "label", label, 
                       "use-underline", TRUE, 
                       NULL);
163 164 165
}


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

175
  gtk_check_button_draw_indicator (check_button, cr);
176

177
  if (gtk_widget_has_visible_focus (widget))
178
    {
179
      GtkWidget *child = gtk_bin_get_child (GTK_BIN (widget));
180 181
      GtkStyleContext *context;
      GtkStateFlags state;
182
      GtkAllocation allocation;
183 184 185 186 187 188 189 190 191 192 193 194
      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);
195

196
      gtk_widget_get_allocation (widget, &allocation);
197 198 199 200
      context = gtk_widget_get_style_context (widget);
      state = gtk_widget_get_state_flags (widget);

      gtk_style_context_set_state (context, state);
201 202 203 204 205 206

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

          gtk_widget_get_allocation (child, &child_allocation);
207 208 209 210 211
          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));
212 213
        }
      else
214 215 216 217
        gtk_render_focus (context, cr,
                          border_width, border_width,
                          allocation.width - 2 * border_width,
                          allocation.height - 2 * border_width);
218 219 220
    }
}

221 222 223 224 225 226 227 228
void
_gtk_check_button_get_props (GtkCheckButton *check_button,
			     gint           *indicator_size,
			     gint           *indicator_spacing)
{
  GtkWidget *widget =  GTK_WIDGET (check_button);

  if (indicator_size)
229
    gtk_widget_style_get (widget, "indicator-size", indicator_size, NULL);
230 231

  if (indicator_spacing)
232
    gtk_widget_style_get (widget, "indicator-spacing", indicator_spacing, NULL);
233 234
}

Elliot Lee's avatar
Elliot Lee committed
235
static void
236 237 238
gtk_check_button_get_preferred_width (GtkWidget *widget,
                                      gint      *minimum,
                                      gint      *natural)
Elliot Lee's avatar
Elliot Lee committed
239
{
240
  GtkToggleButton *toggle_button = GTK_TOGGLE_BUTTON (widget);
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 283 284 285 286 287
  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);

288
  if (gtk_toggle_button_get_mode (toggle_button))
Elliot Lee's avatar
Elliot Lee committed
289
    {
290 291 292 293
      GtkWidget *child;
      gint temp;
      gint indicator_size;
      gint indicator_spacing;
294 295
      gint focus_width;
      gint focus_pad;
296 297 298
      guint border_width;

      border_width = gtk_container_get_border_width (GTK_CONTAINER (widget));
299 300

      gtk_widget_style_get (GTK_WIDGET (widget),
301 302 303 304 305 306
                            "focus-line-width", &focus_width,
                            "focus-padding", &focus_pad,
                            NULL);

      *minimum = border_width * 2;
      *natural = border_width * 2;
307

308
      _gtk_check_button_get_props (GTK_CHECK_BUTTON (widget),
309 310
                                   &indicator_size, &indicator_spacing);

Javier Jardón's avatar
Javier Jardón committed
311
      child = gtk_bin_get_child (GTK_BIN (widget));
312
      if (child && gtk_widget_get_visible (child))
313 314
        {
          gint child_min, child_nat;
315

316 317 318 319 320
          gtk_widget_get_preferred_height (child, &child_min, &child_nat);

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

322
      temp = indicator_size + indicator_spacing * 2;
323 324
      *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
325
    }
326
  else
327
    GTK_WIDGET_CLASS (gtk_check_button_parent_class)->get_preferred_height (widget, minimum, natural);
Elliot Lee's avatar
Elliot Lee committed
328 329 330 331 332 333 334
}

static void
gtk_check_button_size_allocate (GtkWidget     *widget,
				GtkAllocation *allocation)
{
  GtkCheckButton *check_button;
335
  GtkToggleButton *toggle_button;
Elliot Lee's avatar
Elliot Lee committed
336 337
  GtkButton *button;
  GtkAllocation child_allocation;
338

339
  button = GTK_BUTTON (widget);
Elliot Lee's avatar
Elliot Lee committed
340
  check_button = GTK_CHECK_BUTTON (widget);
341
  toggle_button = GTK_TOGGLE_BUTTON (widget);
342

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

      gtk_widget_set_allocation (widget, allocation);

359
      if (gtk_widget_get_realized (widget))
360
	gdk_window_move_resize (gtk_button_get_event_window (button),
Elliot Lee's avatar
Elliot Lee committed
361 362
				allocation->x, allocation->y,
				allocation->width, allocation->height);
Javier Jardón's avatar
Javier Jardón committed
363 364 365

      child = gtk_bin_get_child (GTK_BIN (button));
      if (child && gtk_widget_get_visible (child))
Elliot Lee's avatar
Elliot Lee committed
366
	{
367
          guint border_width = gtk_container_get_border_width (GTK_CONTAINER (widget));
368

369 370
	  child_allocation.width = allocation->width -
	    ((border_width + focus_width + focus_pad) * 2 + indicator_size + indicator_spacing * 3);
371
	  child_allocation.width = MAX (child_allocation.width, 1);
372

373
	  child_allocation.height = allocation->height - (border_width + focus_width + focus_pad) * 2;
374 375
	  child_allocation.height = MAX (child_allocation.height, 1);
	  
376
	  child_allocation.x = (border_width + indicator_size + indicator_spacing * 3 +
377 378
                                allocation->x + focus_width + focus_pad);
          child_allocation.y = allocation->y + (allocation->height - child_allocation.height) / 2;
379

380 381 382 383
	  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
384
	  gtk_widget_size_allocate (child, &child_allocation);
Elliot Lee's avatar
Elliot Lee committed
385 386 387
	}
    }
  else
388
    GTK_WIDGET_CLASS (gtk_check_button_parent_class)->size_allocate (widget, allocation);
Elliot Lee's avatar
Elliot Lee committed
389 390 391
}

static gint
392 393
gtk_check_button_draw (GtkWidget *widget,
                       cairo_t   *cr)
Elliot Lee's avatar
Elliot Lee committed
394
{
395 396
  GtkToggleButton *toggle_button;
  GtkBin *bin;
Javier Jardón's avatar
Javier Jardón committed
397
  GtkWidget *child;
398 399 400
  
  toggle_button = GTK_TOGGLE_BUTTON (widget);
  bin = GTK_BIN (widget);
401 402

  if (gtk_toggle_button_get_mode (toggle_button))
Elliot Lee's avatar
Elliot Lee committed
403
    {
404
      gtk_check_button_paint (widget, cr);
Javier Jardón's avatar
Javier Jardón committed
405

406 407 408 409 410
      child = gtk_bin_get_child (bin);
      if (child)
        gtk_container_propagate_draw (GTK_CONTAINER (widget),
                                      child,
                                      cr);
Elliot Lee's avatar
Elliot Lee committed
411
    }
412 413 414
  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
415 416 417 418 419 420
  return FALSE;
}


static void
gtk_check_button_draw_indicator (GtkCheckButton *check_button,
421
				 cairo_t        *cr)
Elliot Lee's avatar
Elliot Lee committed
422
{
423
  GtkCheckButtonClass *class = GTK_CHECK_BUTTON_GET_CLASS (check_button);
424

Elliot Lee's avatar
Elliot Lee committed
425
  if (class->draw_indicator)
426
    class->draw_indicator (check_button, cr);
Elliot Lee's avatar
Elliot Lee committed
427 428 429 430
}

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

  widget = GTK_WIDGET (check_button);
449 450
  button = GTK_BUTTON (check_button);
  toggle_button = GTK_TOGGLE_BUTTON (check_button);
451

452
  gtk_widget_get_allocation (widget, &allocation);
453
  context = gtk_widget_get_style_context (widget);
454

455 456 457 458 459
  gtk_widget_style_get (widget, 
                        "interior-focus", &interior_focus,
                        "focus-line-width", &focus_width, 
                        "focus-padding", &focus_pad, 
                        NULL);
460

461
  _gtk_check_button_get_props (check_button, &indicator_size, &indicator_spacing);
462

463
  border_width = gtk_container_get_border_width (GTK_CONTAINER (widget));
464

465 466
  x = indicator_spacing + border_width;
  y = (allocation.height - indicator_size) / 2;
467

468 469 470
  child = gtk_bin_get_child (GTK_BIN (check_button));
  if (!interior_focus || !(child && gtk_widget_get_visible (child)))
    x += focus_width + focus_pad;      
471

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

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

  if (button->priv->in_button)
    state |= GTK_STATE_FLAG_PRELIGHT;
483
  else if (!gtk_widget_is_sensitive (widget))
484 485
    state |= GTK_STATE_FLAG_INSENSITIVE;

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

489
  gtk_style_context_set_state (context, state);
490

491 492 493 494 495 496 497 498 499 500 501
  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_save (context);
  gtk_style_context_add_class (context, GTK_STYLE_CLASS_CHECK);

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

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