2 * Copyright (C) 2004 Lorenzo Gil Sanchez
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.
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.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
17 * Authors: Lorenzo Gil Sanchez <lgs@sicem.biz>
18 * Carlos Garnacho Parro <carlosg@gnome.org>
23 #include "gtkcellrendererspin.h"
25 #include "gtkadjustment.h"
27 #include "gtkprivate.h"
28 #include "gtkspinbutton.h"
32 * SECTION:gtkcellrendererspin
33 * @Short_description: Renders a spin button in a cell
34 * @Title: GtkCellRendererSpin
35 * @See_also: #GtkCellRendererText, #GtkSpinButton
37 * #GtkCellRendererSpin renders text in a cell like #GtkCellRendererText from
38 * which it is derived. But while #GtkCellRendererText offers a simple entry to
39 * edit the text, #GtkCellRendererSpin offers a #GtkSpinButton widget. Of course,
40 * that means that the text has to be parseable as a floating point number.
42 * The range of the spinbutton is taken from the adjustment property of the
43 * cell renderer, which can be set explicitly or mapped to a column in the
44 * tree model, like all properties of cell renders. #GtkCellRendererSpin
45 * also has properties for the #GtkCellRendererSpin:climb-rate and the number
46 * of #GtkCellRendererSpin:digits to display. Other #GtkSpinButton properties
47 * can be set in a handler for the #GtkCellRenderer::editing-started signal.
49 * The #GtkCellRendererSpin cell renderer was added in GTK+ 2.10.
53 struct _GtkCellRendererSpinPrivate
55 GtkAdjustment *adjustment;
60 static void gtk_cell_renderer_spin_finalize (GObject *object);
62 static void gtk_cell_renderer_spin_get_property (GObject *object,
66 static void gtk_cell_renderer_spin_set_property (GObject *object,
71 static GtkCellEditable * gtk_cell_renderer_spin_start_editing (GtkCellRenderer *cell,
75 const GdkRectangle *background_area,
76 const GdkRectangle *cell_area,
77 GtkCellRendererState flags);
85 #define GTK_CELL_RENDERER_SPIN_PATH "gtk-cell-renderer-spin-path"
87 G_DEFINE_TYPE (GtkCellRendererSpin, gtk_cell_renderer_spin, GTK_TYPE_CELL_RENDERER_TEXT)
91 gtk_cell_renderer_spin_class_init (GtkCellRendererSpinClass *klass)
93 GObjectClass *object_class = G_OBJECT_CLASS (klass);
94 GtkCellRendererClass *cell_class = GTK_CELL_RENDERER_CLASS (klass);
96 object_class->finalize = gtk_cell_renderer_spin_finalize;
97 object_class->get_property = gtk_cell_renderer_spin_get_property;
98 object_class->set_property = gtk_cell_renderer_spin_set_property;
100 cell_class->start_editing = gtk_cell_renderer_spin_start_editing;
103 * GtkCellRendererSpin:adjustment:
105 * The adjustment that holds the value of the spinbutton.
106 * This must be non-%NULL for the cell renderer to be editable.
110 g_object_class_install_property (object_class,
112 g_param_spec_object ("adjustment",
114 P_("The adjustment that holds the value of the spin button"),
116 GTK_PARAM_READWRITE));
120 * GtkCellRendererSpin:climb-rate:
122 * The acceleration rate when you hold down a button.
126 g_object_class_install_property (object_class,
128 g_param_spec_double ("climb-rate",
130 P_("The acceleration rate when you hold down a button"),
131 0.0, G_MAXDOUBLE, 0.0,
132 GTK_PARAM_READWRITE));
134 * GtkCellRendererSpin:digits:
136 * The number of decimal places to display.
140 g_object_class_install_property (object_class,
142 g_param_spec_uint ("digits",
144 P_("The number of decimal places to display"),
146 GTK_PARAM_READWRITE));
148 g_type_class_add_private (object_class, sizeof (GtkCellRendererSpinPrivate));
152 gtk_cell_renderer_spin_init (GtkCellRendererSpin *self)
154 GtkCellRendererSpinPrivate *priv;
156 self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
157 GTK_TYPE_CELL_RENDERER_SPIN,
158 GtkCellRendererSpinPrivate);
161 priv->adjustment = NULL;
162 priv->climb_rate = 0.0;
167 gtk_cell_renderer_spin_finalize (GObject *object)
169 GtkCellRendererSpinPrivate *priv;
171 priv = GTK_CELL_RENDERER_SPIN (object)->priv;
173 if (priv && priv->adjustment)
174 g_object_unref (priv->adjustment);
176 G_OBJECT_CLASS (gtk_cell_renderer_spin_parent_class)->finalize (object);
180 gtk_cell_renderer_spin_get_property (GObject *object,
185 GtkCellRendererSpin *renderer;
186 GtkCellRendererSpinPrivate *priv;
188 renderer = GTK_CELL_RENDERER_SPIN (object);
189 priv = renderer->priv;
193 case PROP_ADJUSTMENT:
194 g_value_set_object (value, priv->adjustment);
196 case PROP_CLIMB_RATE:
197 g_value_set_double (value, priv->climb_rate);
200 g_value_set_uint (value, priv->digits);
203 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
209 gtk_cell_renderer_spin_set_property (GObject *object,
214 GtkCellRendererSpin *renderer;
215 GtkCellRendererSpinPrivate *priv;
218 renderer = GTK_CELL_RENDERER_SPIN (object);
219 priv = renderer->priv;
223 case PROP_ADJUSTMENT:
224 obj = g_value_get_object (value);
226 if (priv->adjustment)
228 g_object_unref (priv->adjustment);
229 priv->adjustment = NULL;
233 priv->adjustment = g_object_ref_sink (obj);
235 case PROP_CLIMB_RATE:
236 priv->climb_rate = g_value_get_double (value);
239 priv->digits = g_value_get_uint (value);
242 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
248 gtk_cell_renderer_spin_focus_out_event (GtkWidget *widget,
253 const gchar *new_text;
256 g_object_get (widget,
257 "editing-canceled", &canceled,
260 g_signal_handlers_disconnect_by_func (widget,
261 gtk_cell_renderer_spin_focus_out_event,
264 gtk_cell_renderer_stop_editing (GTK_CELL_RENDERER (data), canceled);
268 path = g_object_get_data (G_OBJECT (widget), GTK_CELL_RENDERER_SPIN_PATH);
270 new_text = gtk_entry_get_text (GTK_ENTRY (widget));
271 g_signal_emit_by_name (data, "edited", path, new_text);
278 gtk_cell_renderer_spin_key_press_event (GtkWidget *widget,
282 if (event->state == 0)
284 if (event->keyval == GDK_KEY_Up)
286 gtk_spin_button_spin (GTK_SPIN_BUTTON (widget), GTK_SPIN_STEP_FORWARD, 1);
289 else if (event->keyval == GDK_KEY_Down)
291 gtk_spin_button_spin (GTK_SPIN_BUTTON (widget), GTK_SPIN_STEP_BACKWARD, 1);
300 gtk_cell_renderer_spin_button_press_event (GtkWidget *widget,
301 GdkEventButton *event,
304 /* Block 2BUTTON and 3BUTTON here, so that they won't be eaten
307 if (event->type == GDK_2BUTTON_PRESS
308 || event->type == GDK_3BUTTON_PRESS)
314 static GtkCellEditable *
315 gtk_cell_renderer_spin_start_editing (GtkCellRenderer *cell,
319 const GdkRectangle *background_area,
320 const GdkRectangle *cell_area,
321 GtkCellRendererState flags)
323 GtkCellRendererSpinPrivate *priv;
324 GtkCellRendererText *cell_text;
329 cell_text = GTK_CELL_RENDERER_TEXT (cell);
330 priv = GTK_CELL_RENDERER_SPIN (cell)->priv;
332 g_object_get (cell_text, "editable", &editable, NULL);
336 if (!priv->adjustment)
339 spin = gtk_spin_button_new (priv->adjustment,
340 priv->climb_rate, priv->digits);
342 g_signal_connect (spin, "button-press-event",
343 G_CALLBACK (gtk_cell_renderer_spin_button_press_event),
346 g_object_get (cell_text, "text", &text, NULL);
349 gtk_spin_button_set_value (GTK_SPIN_BUTTON (spin),
350 g_strtod (text, NULL));
354 g_object_set_data_full (G_OBJECT (spin), GTK_CELL_RENDERER_SPIN_PATH,
355 g_strdup (path), g_free);
357 g_signal_connect (G_OBJECT (spin), "focus-out-event",
358 G_CALLBACK (gtk_cell_renderer_spin_focus_out_event),
360 g_signal_connect (G_OBJECT (spin), "key-press-event",
361 G_CALLBACK (gtk_cell_renderer_spin_key_press_event),
364 gtk_widget_show (spin);
366 return GTK_CELL_EDITABLE (spin);
370 * gtk_cell_renderer_spin_new:
372 * Creates a new #GtkCellRendererSpin.
374 * Returns: a new #GtkCellRendererSpin
379 gtk_cell_renderer_spin_new (void)
381 return g_object_new (GTK_TYPE_CELL_RENDERER_SPIN, NULL);