1 /* gtkcellrenderertoggle.c
2 * Copyright (C) 2000 Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library 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.
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 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
20 #include "gtkcellrenderertoggle.h"
22 #include "gtkmarshalers.h"
23 #include "gtkprivate.h"
24 #include "gtktreeprivate.h"
25 #include "a11y/gtkbooleancellaccessible.h"
29 * SECTION:gtkcellrenderertoggle
30 * @Short_description: Renders a toggle button in a cell
31 * @Title: GtkCellRendererToggle
33 * #GtkCellRendererToggle renders a toggle button in a cell. The
34 * button is drawn as a radio or a checkbutton, depending on the
35 * #GtkCellRendererToggle:radio property.
36 * When activated, it emits the #GtkCellRendererToggle::toggled signal.
40 static void gtk_cell_renderer_toggle_get_property (GObject *object,
44 static void gtk_cell_renderer_toggle_set_property (GObject *object,
48 static void gtk_cell_renderer_toggle_get_size (GtkCellRenderer *cell,
50 const GdkRectangle *cell_area,
55 static void gtk_cell_renderer_toggle_render (GtkCellRenderer *cell,
58 const GdkRectangle *background_area,
59 const GdkRectangle *cell_area,
60 GtkCellRendererState flags);
61 static gboolean gtk_cell_renderer_toggle_activate (GtkCellRenderer *cell,
65 const GdkRectangle *background_area,
66 const GdkRectangle *cell_area,
67 GtkCellRendererState flags);
84 #define TOGGLE_WIDTH 16
86 static guint toggle_cell_signals[LAST_SIGNAL] = { 0 };
88 struct _GtkCellRendererTogglePrivate
93 guint activatable : 1;
94 guint inconsistent : 1;
99 G_DEFINE_TYPE (GtkCellRendererToggle, gtk_cell_renderer_toggle, GTK_TYPE_CELL_RENDERER)
103 gtk_cell_renderer_toggle_init (GtkCellRendererToggle *celltoggle)
105 GtkCellRendererTogglePrivate *priv;
107 celltoggle->priv = G_TYPE_INSTANCE_GET_PRIVATE (celltoggle,
108 GTK_TYPE_CELL_RENDERER_TOGGLE,
109 GtkCellRendererTogglePrivate);
110 priv = celltoggle->priv;
112 priv->activatable = TRUE;
113 priv->active = FALSE;
116 g_object_set (celltoggle, "mode", GTK_CELL_RENDERER_MODE_ACTIVATABLE, NULL);
117 gtk_cell_renderer_set_padding (GTK_CELL_RENDERER (celltoggle), 2, 2);
119 priv->indicator_size = TOGGLE_WIDTH;
120 priv->inconsistent = FALSE;
124 gtk_cell_renderer_toggle_class_init (GtkCellRendererToggleClass *class)
126 GObjectClass *object_class = G_OBJECT_CLASS (class);
127 GtkCellRendererClass *cell_class = GTK_CELL_RENDERER_CLASS (class);
129 object_class->get_property = gtk_cell_renderer_toggle_get_property;
130 object_class->set_property = gtk_cell_renderer_toggle_set_property;
132 cell_class->get_size = gtk_cell_renderer_toggle_get_size;
133 cell_class->render = gtk_cell_renderer_toggle_render;
134 cell_class->activate = gtk_cell_renderer_toggle_activate;
136 g_object_class_install_property (object_class,
138 g_param_spec_boolean ("active",
140 P_("The toggle state of the button"),
142 GTK_PARAM_READWRITE));
144 g_object_class_install_property (object_class,
146 g_param_spec_boolean ("inconsistent",
147 P_("Inconsistent state"),
148 P_("The inconsistent state of the button"),
150 GTK_PARAM_READWRITE));
152 g_object_class_install_property (object_class,
154 g_param_spec_boolean ("activatable",
156 P_("The toggle button can be activated"),
158 GTK_PARAM_READWRITE));
160 g_object_class_install_property (object_class,
162 g_param_spec_boolean ("radio",
164 P_("Draw the toggle button as a radio button"),
166 GTK_PARAM_READWRITE));
168 g_object_class_install_property (object_class,
170 g_param_spec_int ("indicator-size",
171 P_("Indicator size"),
172 P_("Size of check or radio indicator"),
176 GTK_PARAM_READWRITE));
180 * GtkCellRendererToggle::toggled:
181 * @cell_renderer: the object which received the signal
182 * @path: string representation of #GtkTreePath describing the
185 * The ::toggled signal is emitted when the cell is toggled.
187 toggle_cell_signals[TOGGLED] =
188 g_signal_new (I_("toggled"),
189 G_OBJECT_CLASS_TYPE (object_class),
191 G_STRUCT_OFFSET (GtkCellRendererToggleClass, toggled),
193 _gtk_marshal_VOID__STRING,
197 g_type_class_add_private (object_class, sizeof (GtkCellRendererTogglePrivate));
199 gtk_cell_renderer_class_set_accessible_type (cell_class, GTK_TYPE_BOOLEAN_CELL_ACCESSIBLE);
203 gtk_cell_renderer_toggle_get_property (GObject *object,
208 GtkCellRendererToggle *celltoggle = GTK_CELL_RENDERER_TOGGLE (object);
209 GtkCellRendererTogglePrivate *priv = celltoggle->priv;
214 g_value_set_boolean (value, priv->active);
216 case PROP_INCONSISTENT:
217 g_value_set_boolean (value, priv->inconsistent);
219 case PROP_ACTIVATABLE:
220 g_value_set_boolean (value, priv->activatable);
223 g_value_set_boolean (value, priv->radio);
225 case PROP_INDICATOR_SIZE:
226 g_value_set_int (value, priv->indicator_size);
229 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
236 gtk_cell_renderer_toggle_set_property (GObject *object,
241 GtkCellRendererToggle *celltoggle = GTK_CELL_RENDERER_TOGGLE (object);
242 GtkCellRendererTogglePrivate *priv = celltoggle->priv;
247 priv->active = g_value_get_boolean (value);
249 case PROP_INCONSISTENT:
250 priv->inconsistent = g_value_get_boolean (value);
252 case PROP_ACTIVATABLE:
253 priv->activatable = g_value_get_boolean (value);
256 priv->radio = g_value_get_boolean (value);
258 case PROP_INDICATOR_SIZE:
259 priv->indicator_size = g_value_get_int (value);
262 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
268 * gtk_cell_renderer_toggle_new:
270 * Creates a new #GtkCellRendererToggle. Adjust rendering
271 * parameters using object properties. Object properties can be set
272 * globally (with g_object_set()). Also, with #GtkTreeViewColumn, you
273 * can bind a property to a value in a #GtkTreeModel. For example, you
274 * can bind the "active" property on the cell renderer to a boolean value
275 * in the model, thus causing the check button to reflect the state of
278 * Return value: the new cell renderer
281 gtk_cell_renderer_toggle_new (void)
283 return g_object_new (GTK_TYPE_CELL_RENDERER_TOGGLE, NULL);
287 gtk_cell_renderer_toggle_get_size (GtkCellRenderer *cell,
289 const GdkRectangle *cell_area,
295 GtkCellRendererTogglePrivate *priv;
300 priv = GTK_CELL_RENDERER_TOGGLE (cell)->priv;
302 gtk_cell_renderer_get_padding (cell, &xpad, &ypad);
303 calc_width = xpad * 2 + priv->indicator_size;
304 calc_height = ypad * 2 + priv->indicator_size;
310 *height = calc_height;
314 gfloat xalign, yalign;
316 gtk_cell_renderer_get_alignment (cell, &xalign, &yalign);
320 *x_offset = ((gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL) ?
321 (1.0 - xalign) : xalign) * (cell_area->width - calc_width);
322 *x_offset = MAX (*x_offset, 0);
326 *y_offset = yalign * (cell_area->height - calc_height);
327 *y_offset = MAX (*y_offset, 0);
332 if (x_offset) *x_offset = 0;
333 if (y_offset) *y_offset = 0;
338 gtk_cell_renderer_toggle_render (GtkCellRenderer *cell,
341 const GdkRectangle *background_area,
342 const GdkRectangle *cell_area,
343 GtkCellRendererState flags)
345 GtkCellRendererToggle *celltoggle = GTK_CELL_RENDERER_TOGGLE (cell);
346 GtkCellRendererTogglePrivate *priv = celltoggle->priv;
347 GtkStyleContext *context;
349 gint x_offset, y_offset;
353 context = gtk_widget_get_style_context (widget);
354 gtk_cell_renderer_toggle_get_size (cell, widget, cell_area,
355 &x_offset, &y_offset,
357 gtk_cell_renderer_get_padding (cell, &xpad, &ypad);
361 if (width <= 0 || height <= 0)
364 state = gtk_cell_renderer_get_state (cell, widget, flags);
366 if (!priv->activatable)
367 state |= GTK_STATE_FLAG_INSENSITIVE;
369 state &= ~(GTK_STATE_FLAG_INCONSISTENT | GTK_STATE_FLAG_ACTIVE);
371 if (priv->inconsistent)
372 state |= GTK_STATE_FLAG_INCONSISTENT;
373 else if (priv->active)
374 state |= GTK_STATE_FLAG_ACTIVE;
378 gdk_cairo_rectangle (cr, cell_area);
381 gtk_style_context_save (context);
382 gtk_style_context_set_state (context, state);
386 gtk_style_context_add_class (context, GTK_STYLE_CLASS_RADIO);
387 gtk_render_option (context, cr,
388 cell_area->x + x_offset + xpad,
389 cell_area->y + y_offset + ypad,
394 gtk_style_context_add_class (context, GTK_STYLE_CLASS_CHECK);
395 gtk_render_check (context, cr,
396 cell_area->x + x_offset + xpad,
397 cell_area->y + y_offset + ypad,
401 gtk_style_context_restore (context);
406 gtk_cell_renderer_toggle_activate (GtkCellRenderer *cell,
410 const GdkRectangle *background_area,
411 const GdkRectangle *cell_area,
412 GtkCellRendererState flags)
414 GtkCellRendererTogglePrivate *priv;
415 GtkCellRendererToggle *celltoggle;
417 celltoggle = GTK_CELL_RENDERER_TOGGLE (cell);
418 priv = celltoggle->priv;
420 if (priv->activatable)
422 g_signal_emit (cell, toggle_cell_signals[TOGGLED], 0, path);
430 * gtk_cell_renderer_toggle_set_radio:
431 * @toggle: a #GtkCellRendererToggle
432 * @radio: %TRUE to make the toggle look like a radio button
434 * If @radio is %TRUE, the cell renderer renders a radio toggle
435 * (i.e. a toggle in a group of mutually-exclusive toggles).
436 * If %FALSE, it renders a check toggle (a standalone boolean option).
437 * This can be set globally for the cell renderer, or changed just
438 * before rendering each cell in the model (for #GtkTreeView, you set
439 * up a per-row setting using #GtkTreeViewColumn to associate model
440 * columns with cell renderer properties).
443 gtk_cell_renderer_toggle_set_radio (GtkCellRendererToggle *toggle,
446 GtkCellRendererTogglePrivate *priv;
448 g_return_if_fail (GTK_IS_CELL_RENDERER_TOGGLE (toggle));
456 * gtk_cell_renderer_toggle_get_radio:
457 * @toggle: a #GtkCellRendererToggle
459 * Returns whether we're rendering radio toggles rather than checkboxes.
461 * Return value: %TRUE if we're rendering radio toggles rather than checkboxes
464 gtk_cell_renderer_toggle_get_radio (GtkCellRendererToggle *toggle)
466 g_return_val_if_fail (GTK_IS_CELL_RENDERER_TOGGLE (toggle), FALSE);
468 return toggle->priv->radio;
472 * gtk_cell_renderer_toggle_get_active:
473 * @toggle: a #GtkCellRendererToggle
475 * Returns whether the cell renderer is active. See
476 * gtk_cell_renderer_toggle_set_active().
478 * Return value: %TRUE if the cell renderer is active.
481 gtk_cell_renderer_toggle_get_active (GtkCellRendererToggle *toggle)
483 g_return_val_if_fail (GTK_IS_CELL_RENDERER_TOGGLE (toggle), FALSE);
485 return toggle->priv->active;
489 * gtk_cell_renderer_toggle_set_active:
490 * @toggle: a #GtkCellRendererToggle.
491 * @setting: the value to set.
493 * Activates or deactivates a cell renderer.
496 gtk_cell_renderer_toggle_set_active (GtkCellRendererToggle *toggle,
499 g_return_if_fail (GTK_IS_CELL_RENDERER_TOGGLE (toggle));
501 g_object_set (toggle, "active", setting ? TRUE : FALSE, NULL);
505 * gtk_cell_renderer_toggle_get_activatable:
506 * @toggle: a #GtkCellRendererToggle
508 * Returns whether the cell renderer is activatable. See
509 * gtk_cell_renderer_toggle_set_activatable().
511 * Return value: %TRUE if the cell renderer is activatable.
516 gtk_cell_renderer_toggle_get_activatable (GtkCellRendererToggle *toggle)
518 g_return_val_if_fail (GTK_IS_CELL_RENDERER_TOGGLE (toggle), FALSE);
520 return toggle->priv->activatable;
524 * gtk_cell_renderer_toggle_set_activatable:
525 * @toggle: a #GtkCellRendererToggle.
526 * @setting: the value to set.
528 * Makes the cell renderer activatable.
533 gtk_cell_renderer_toggle_set_activatable (GtkCellRendererToggle *toggle,
536 GtkCellRendererTogglePrivate *priv;
538 g_return_if_fail (GTK_IS_CELL_RENDERER_TOGGLE (toggle));
542 if (priv->activatable != setting)
544 priv->activatable = setting ? TRUE : FALSE;
545 g_object_notify (G_OBJECT (toggle), "activatable");