]> Pileus Git - ~andy/gtk/blob - gtk/gtkspinbutton.c
gtk: save/restore the cairo_t around early upchaining in draw()
[~andy/gtk] / gtk / gtkspinbutton.c
1 /* GTK - The GIMP Toolkit
2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3  *
4  * GtkSpinButton widget for GTK+
5  * Copyright (C) 1998 Lars Hamann and Stefan Jeske
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library; if not, write to the
19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20  * Boston, MA 02111-1307, USA.
21  */
22
23 /*
24  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
25  * file for a list of people on the GTK+ Team.  See the ChangeLog
26  * files for a list of changes.  These files are distributed with
27  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
28  */
29
30 #include "config.h"
31
32 #include <stdio.h>
33 #include <stdlib.h>
34 #include <math.h>
35 #include <string.h>
36 #include <locale.h>
37
38 #include "gtkbindings.h"
39 #include "gtkspinbutton.h"
40 #include "gtkentryprivate.h"
41 #include "gtkmainprivate.h"
42 #include "gtkmarshalers.h"
43 #include "gtksettings.h"
44 #include "gtkprivate.h"
45 #include "gtkintl.h"
46 #include "gtktypebuiltins.h"
47
48 #define MIN_SPIN_BUTTON_WIDTH 30
49 #define MAX_TIMER_CALLS       5
50 #define EPSILON               1e-10
51 #define MAX_DIGITS            20
52 #define MIN_ARROW_WIDTH       6
53
54
55 /**
56  * SECTION:gtkspinbutton
57  * @Title: GtkSpinButton
58  * @Short_description: Retrieve an integer or floating-point number from
59  *     the user
60  * @See_also: #GtkEntry
61  *
62  * A #GtkSpinButton is an ideal way to allow the user to set the value of
63  * some attribute. Rather than having to directly type a number into a
64  * #GtkEntry, GtkSpinButton allows the user to click on one of two arrows
65  * to increment or decrement the displayed value. A value can still be
66  * typed in, with the bonus that it can be checked to ensure it is in a
67  * given range.
68  *
69  * The main properties of a GtkSpinButton are through an adjustment.
70  * See the #GtkAdjustment section for more details about an adjustment's
71  * properties.
72  *
73  * <example>
74  * <title>Using a GtkSpinButton to get an integer</title>
75  * <programlisting>
76  * /&ast; Provides a function to retrieve an integer value from a
77  *  &ast; GtkSpinButton and creates a spin button to model percentage
78  *  &ast; values.
79  *  &ast;/
80  *
81  * gint
82  * grab_int_value (GtkSpinButton *button,
83  *                 gpointer       user_data)
84  * {
85  *   return gtk_spin_button_get_value_as_int (button);
86  * }
87  *
88  * void
89  * create_integer_spin_button (void)
90  * {
91  *
92  *   GtkWidget *window, *button;
93  *   GtkAdjustment *adjustment;
94  *
95  *   adjustment = gtk_adjustment_new (50.0, 0.0, 100.0, 1.0, 5.0, 0.0);
96  *
97  *   window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
98  *   gtk_container_set_border_width (GTK_CONTAINER (window), 5);
99  *
100  *   /&ast; creates the spinbutton, with no decimal places &ast;/
101  *   button = gtk_spin_button_new (adjustment, 1.0, 0);
102  *   gtk_container_add (GTK_CONTAINER (window), button);
103  *
104  *   gtk_widget_show_all (window);
105  * }
106  * </programlisting>
107  * </example>
108  *
109  * <example>
110  * <title>Using a GtkSpinButton to get a floating point value</title>
111  * <programlisting>
112  * /&ast; Provides a function to retrieve a floating point value from a
113  *  &ast; GtkSpinButton, and creates a high precision spin button.
114  *  &ast;/
115  *
116  * gfloat
117  * grab_float_value (GtkSpinButton *button,
118  *                   gpointer       user_data)
119  * {
120  *   return gtk_spin_button_get_value (button);
121  * }
122  *
123  * void
124  * create_floating_spin_button (void)
125  * {
126  *   GtkWidget *window, *button;
127  *   GtkAdjustment *adjustment;
128  *
129  *   adjustment = gtk_adjustment_new (2.500, 0.0, 5.0, 0.001, 0.1, 0.0);
130  *
131  *   window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
132  *   gtk_container_set_border_width (GTK_CONTAINER (window), 5);
133  *
134  *   /&ast; creates the spinbutton, with three decimal places &ast;/
135  *   button = gtk_spin_button_new (adjustment, 0.001, 3);
136  *   gtk_container_add (GTK_CONTAINER (window), button);
137  *
138  *   gtk_widget_show_all (window);
139  * }
140  * </programlisting>
141  * </example>
142  */
143
144 struct _GtkSpinButtonPrivate
145 {
146   GtkSpinButtonUpdatePolicy update_policy;
147   GtkAdjustment *adjustment;
148
149   GdkWindow     *panel;
150
151   guint32        timer;
152
153   gdouble        climb_rate;
154   gdouble        timer_step;
155
156   guint          button        : 2;
157   guint          click_child   : 2; /* valid: GTK_ARROW_UP=0, GTK_ARROW_DOWN=1 or 2=NONE/BOTH */
158   guint          digits        : 10;
159   guint          in_child      : 2;
160   guint          need_timer    : 1;
161   guint          numeric       : 1;
162   guint          snap_to_ticks : 1;
163   guint          timer_calls   : 3;
164   guint          wrap          : 1;
165 };
166
167 enum {
168   PROP_0,
169   PROP_ADJUSTMENT,
170   PROP_CLIMB_RATE,
171   PROP_DIGITS,
172   PROP_SNAP_TO_TICKS,
173   PROP_NUMERIC,
174   PROP_WRAP,
175   PROP_UPDATE_POLICY,
176   PROP_VALUE
177 };
178
179 /* Signals */
180 enum
181 {
182   INPUT,
183   OUTPUT,
184   VALUE_CHANGED,
185   CHANGE_VALUE,
186   WRAPPED,
187   LAST_SIGNAL
188 };
189
190 static void gtk_spin_button_editable_init  (GtkEditableInterface *iface);
191 static void gtk_spin_button_finalize       (GObject            *object);
192 static void gtk_spin_button_set_property   (GObject         *object,
193                                             guint            prop_id,
194                                             const GValue    *value,
195                                             GParamSpec      *pspec);
196 static void gtk_spin_button_get_property   (GObject         *object,
197                                             guint            prop_id,
198                                             GValue          *value,
199                                             GParamSpec      *pspec);
200 static void gtk_spin_button_destroy        (GtkWidget          *widget);
201 static void gtk_spin_button_map            (GtkWidget          *widget);
202 static void gtk_spin_button_unmap          (GtkWidget          *widget);
203 static void gtk_spin_button_realize        (GtkWidget          *widget);
204 static void gtk_spin_button_unrealize      (GtkWidget          *widget);
205 static void gtk_spin_button_get_preferred_width  (GtkWidget          *widget,
206                                                   gint               *minimum,
207                                                   gint               *natural);
208
209 static void gtk_spin_button_size_allocate  (GtkWidget          *widget,
210                                             GtkAllocation      *allocation);
211 static gint gtk_spin_button_draw           (GtkWidget          *widget,
212                                             cairo_t            *cr);
213 static gint gtk_spin_button_button_press   (GtkWidget          *widget,
214                                             GdkEventButton     *event);
215 static gint gtk_spin_button_button_release (GtkWidget          *widget,
216                                             GdkEventButton     *event);
217 static gint gtk_spin_button_motion_notify  (GtkWidget          *widget,
218                                             GdkEventMotion     *event);
219 static gint gtk_spin_button_enter_notify   (GtkWidget          *widget,
220                                             GdkEventCrossing   *event);
221 static gint gtk_spin_button_leave_notify   (GtkWidget          *widget,
222                                             GdkEventCrossing   *event);
223 static gint gtk_spin_button_focus_out      (GtkWidget          *widget,
224                                             GdkEventFocus      *event);
225 static void gtk_spin_button_grab_notify    (GtkWidget          *widget,
226                                             gboolean            was_grabbed);
227 static void gtk_spin_button_state_flags_changed  (GtkWidget     *widget,
228                                                   GtkStateFlags  previous_state);
229 static void gtk_spin_button_style_updated  (GtkWidget          *widget);
230 static void gtk_spin_button_draw_arrow     (GtkSpinButton      *spin_button,
231                                             GtkStyleContext    *context,
232                                             cairo_t            *cr,
233                                             GtkArrowType        arrow_type);
234 static gboolean gtk_spin_button_timer          (GtkSpinButton      *spin_button);
235 static void gtk_spin_button_stop_spinning  (GtkSpinButton      *spin);
236 static void gtk_spin_button_value_changed  (GtkAdjustment      *adjustment,
237                                             GtkSpinButton      *spin_button);
238 static gint gtk_spin_button_key_release    (GtkWidget          *widget,
239                                             GdkEventKey        *event);
240 static gint gtk_spin_button_scroll         (GtkWidget          *widget,
241                                             GdkEventScroll     *event);
242 static void gtk_spin_button_activate       (GtkEntry           *entry);
243 static void gtk_spin_button_get_text_area_size (GtkEntry *entry,
244                                                 gint     *x,
245                                                 gint     *y,
246                                                 gint     *width,
247                                                 gint     *height);
248 static void gtk_spin_button_snap           (GtkSpinButton      *spin_button,
249                                             gdouble             val);
250 static void gtk_spin_button_insert_text    (GtkEditable        *editable,
251                                             const gchar        *new_text,
252                                             gint                new_text_length,
253                                             gint               *position);
254 static void gtk_spin_button_real_spin      (GtkSpinButton      *spin_button,
255                                             gdouble             step);
256 static void gtk_spin_button_real_change_value (GtkSpinButton   *spin,
257                                                GtkScrollType    scroll);
258
259 static gint gtk_spin_button_default_input  (GtkSpinButton      *spin_button,
260                                             gdouble            *new_val);
261 static gint gtk_spin_button_default_output (GtkSpinButton      *spin_button);
262
263 static gint spin_button_get_arrow_size     (GtkSpinButton      *spin_button);
264
265 static guint spinbutton_signals[LAST_SIGNAL] = {0};
266
267 #define NO_ARROW 2
268
269 G_DEFINE_TYPE_WITH_CODE (GtkSpinButton, gtk_spin_button, GTK_TYPE_ENTRY,
270                          G_IMPLEMENT_INTERFACE (GTK_TYPE_EDITABLE,
271                                                 gtk_spin_button_editable_init))
272
273 #define add_spin_binding(binding_set, keyval, mask, scroll)            \
274   gtk_binding_entry_add_signal (binding_set, keyval, mask,             \
275                                 "change_value", 1,                     \
276                                 GTK_TYPE_SCROLL_TYPE, scroll)
277
278 static void
279 gtk_spin_button_class_init (GtkSpinButtonClass *class)
280 {
281   GObjectClass     *gobject_class = G_OBJECT_CLASS (class);
282   GtkWidgetClass   *widget_class = GTK_WIDGET_CLASS (class);
283   GtkEntryClass    *entry_class = GTK_ENTRY_CLASS (class);
284   GtkBindingSet    *binding_set;
285
286   gobject_class->finalize = gtk_spin_button_finalize;
287   gobject_class->set_property = gtk_spin_button_set_property;
288   gobject_class->get_property = gtk_spin_button_get_property;
289
290   widget_class->destroy = gtk_spin_button_destroy;
291   widget_class->map = gtk_spin_button_map;
292   widget_class->unmap = gtk_spin_button_unmap;
293   widget_class->realize = gtk_spin_button_realize;
294   widget_class->unrealize = gtk_spin_button_unrealize;
295   widget_class->get_preferred_width = gtk_spin_button_get_preferred_width;
296   widget_class->size_allocate = gtk_spin_button_size_allocate;
297   widget_class->draw = gtk_spin_button_draw;
298   widget_class->scroll_event = gtk_spin_button_scroll;
299   widget_class->button_press_event = gtk_spin_button_button_press;
300   widget_class->button_release_event = gtk_spin_button_button_release;
301   widget_class->motion_notify_event = gtk_spin_button_motion_notify;
302   widget_class->key_release_event = gtk_spin_button_key_release;
303   widget_class->enter_notify_event = gtk_spin_button_enter_notify;
304   widget_class->leave_notify_event = gtk_spin_button_leave_notify;
305   widget_class->focus_out_event = gtk_spin_button_focus_out;
306   widget_class->grab_notify = gtk_spin_button_grab_notify;
307   widget_class->state_flags_changed = gtk_spin_button_state_flags_changed;
308   widget_class->style_updated = gtk_spin_button_style_updated;
309
310   entry_class->activate = gtk_spin_button_activate;
311   entry_class->get_text_area_size = gtk_spin_button_get_text_area_size;
312
313   class->input = NULL;
314   class->output = NULL;
315   class->change_value = gtk_spin_button_real_change_value;
316
317   g_object_class_install_property (gobject_class,
318                                    PROP_ADJUSTMENT,
319                                    g_param_spec_object ("adjustment",
320                                                         P_("Adjustment"),
321                                                         P_("The adjustment that holds the value of the spin button"),
322                                                         GTK_TYPE_ADJUSTMENT,
323                                                         GTK_PARAM_READWRITE));
324
325   g_object_class_install_property (gobject_class,
326                                    PROP_CLIMB_RATE,
327                                    g_param_spec_double ("climb-rate",
328                                                         P_("Climb Rate"),
329                                                         P_("The acceleration rate when you hold down a button"),
330                                                         0.0,
331                                                         G_MAXDOUBLE,
332                                                         0.0,
333                                                         GTK_PARAM_READWRITE));
334
335   g_object_class_install_property (gobject_class,
336                                    PROP_DIGITS,
337                                    g_param_spec_uint ("digits",
338                                                       P_("Digits"),
339                                                       P_("The number of decimal places to display"),
340                                                       0,
341                                                       MAX_DIGITS,
342                                                       0,
343                                                       GTK_PARAM_READWRITE));
344
345   g_object_class_install_property (gobject_class,
346                                    PROP_SNAP_TO_TICKS,
347                                    g_param_spec_boolean ("snap-to-ticks",
348                                                          P_("Snap to Ticks"),
349                                                          P_("Whether erroneous values are automatically changed to a spin button's nearest step increment"),
350                                                          FALSE,
351                                                          GTK_PARAM_READWRITE));
352
353   g_object_class_install_property (gobject_class,
354                                    PROP_NUMERIC,
355                                    g_param_spec_boolean ("numeric",
356                                                          P_("Numeric"),
357                                                          P_("Whether non-numeric characters should be ignored"),
358                                                          FALSE,
359                                                          GTK_PARAM_READWRITE));
360
361   g_object_class_install_property (gobject_class,
362                                    PROP_WRAP,
363                                    g_param_spec_boolean ("wrap",
364                                                          P_("Wrap"),
365                                                          P_("Whether a spin button should wrap upon reaching its limits"),
366                                                          FALSE,
367                                                          GTK_PARAM_READWRITE));
368
369   g_object_class_install_property (gobject_class,
370                                    PROP_UPDATE_POLICY,
371                                    g_param_spec_enum ("update-policy",
372                                                       P_("Update Policy"),
373                                                       P_("Whether the spin button should update always, or only when the value is legal"),
374                                                       GTK_TYPE_SPIN_BUTTON_UPDATE_POLICY,
375                                                       GTK_UPDATE_ALWAYS,
376                                                       GTK_PARAM_READWRITE));
377
378   g_object_class_install_property (gobject_class,
379                                    PROP_VALUE,
380                                    g_param_spec_double ("value",
381                                                         P_("Value"),
382                                                         P_("Reads the current value, or sets a new value"),
383                                                         -G_MAXDOUBLE,
384                                                         G_MAXDOUBLE,
385                                                         0.0,
386                                                         GTK_PARAM_READWRITE));
387
388   gtk_widget_class_install_style_property_parser (widget_class,
389                                                   g_param_spec_enum ("shadow-type",
390                                                                      "Shadow Type",
391                                                                      P_("Style of bevel around the spin button"),
392                                                                      GTK_TYPE_SHADOW_TYPE,
393                                                                      GTK_SHADOW_IN,
394                                                                      GTK_PARAM_READABLE),
395                                                   gtk_rc_property_parse_enum);
396
397   /**
398    * GtkSpinButton::input:
399    * @spin_button: the object on which the signal was emitted
400    * @new_value: (out) (type double): return location for the new value
401    *
402    * The ::input signal can be used to influence the conversion of
403    * the users input into a double value. The signal handler is
404    * expected to use gtk_entry_get_text() to retrieve the text of
405    * the entry and set @new_value to the new value.
406    *
407    * The default conversion uses g_strtod().
408    *
409    * Returns: %TRUE for a successful conversion, %FALSE if the input
410    *     was not handled, and %GTK_INPUT_ERROR if the conversion failed.
411    */
412   spinbutton_signals[INPUT] =
413     g_signal_new (I_("input"),
414                   G_TYPE_FROM_CLASS (gobject_class),
415                   G_SIGNAL_RUN_LAST,
416                   G_STRUCT_OFFSET (GtkSpinButtonClass, input),
417                   NULL, NULL,
418                   _gtk_marshal_INT__POINTER,
419                   G_TYPE_INT, 1,
420                   G_TYPE_POINTER);
421
422   /**
423    * GtkSpinButton::output:
424    * @spin_button: the object which received the signal
425    *
426    * The ::output signal can be used to change to formatting
427    * of the value that is displayed in the spin buttons entry.
428    * |[
429    * /&ast; show leading zeros &ast;/
430    * static gboolean
431    * on_output (GtkSpinButton *spin,
432    *            gpointer       data)
433    * {
434    *    GtkAdjustment *adjustment;
435    *    gchar *text;
436    *    int value;
437    *
438    *    adjustment = gtk_spin_button_get_adjustment (spin);
439    *    value = (int)gtk_adjustment_get_value (adjustment);
440    *    text = g_strdup_printf ("%02d", value);
441    *    gtk_entry_set_text (GTK_ENTRY (spin), text);
442    *    g_free (text);
443    *
444    *    return TRUE;
445    * }
446    * ]|
447    *
448    * Returns: %TRUE if the value has been displayed
449    */
450   spinbutton_signals[OUTPUT] =
451     g_signal_new (I_("output"),
452                   G_TYPE_FROM_CLASS (gobject_class),
453                   G_SIGNAL_RUN_LAST,
454                   G_STRUCT_OFFSET (GtkSpinButtonClass, output),
455                   _gtk_boolean_handled_accumulator, NULL,
456                   _gtk_marshal_BOOLEAN__VOID,
457                   G_TYPE_BOOLEAN, 0);
458
459   spinbutton_signals[VALUE_CHANGED] =
460     g_signal_new (I_("value-changed"),
461                   G_TYPE_FROM_CLASS (gobject_class),
462                   G_SIGNAL_RUN_LAST,
463                   G_STRUCT_OFFSET (GtkSpinButtonClass, value_changed),
464                   NULL, NULL,
465                   _gtk_marshal_VOID__VOID,
466                   G_TYPE_NONE, 0);
467
468   /**
469    * GtkSpinButton::wrapped:
470    * @spinbutton: the object which received the signal
471    *
472    * The wrapped signal is emitted right after the spinbutton wraps
473    * from its maximum to minimum value or vice-versa.
474    *
475    * Since: 2.10
476    */
477   spinbutton_signals[WRAPPED] =
478     g_signal_new (I_("wrapped"),
479                   G_TYPE_FROM_CLASS (gobject_class),
480                   G_SIGNAL_RUN_LAST,
481                   G_STRUCT_OFFSET (GtkSpinButtonClass, wrapped),
482                   NULL, NULL,
483                   _gtk_marshal_VOID__VOID,
484                   G_TYPE_NONE, 0);
485
486   /* Action signals */
487   spinbutton_signals[CHANGE_VALUE] =
488     g_signal_new (I_("change-value"),
489                   G_TYPE_FROM_CLASS (gobject_class),
490                   G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
491                   G_STRUCT_OFFSET (GtkSpinButtonClass, change_value),
492                   NULL, NULL,
493                   _gtk_marshal_VOID__ENUM,
494                   G_TYPE_NONE, 1,
495                   GTK_TYPE_SCROLL_TYPE);
496
497   binding_set = gtk_binding_set_by_class (class);
498
499   add_spin_binding (binding_set, GDK_KEY_Up, 0, GTK_SCROLL_STEP_UP);
500   add_spin_binding (binding_set, GDK_KEY_KP_Up, 0, GTK_SCROLL_STEP_UP);
501   add_spin_binding (binding_set, GDK_KEY_Down, 0, GTK_SCROLL_STEP_DOWN);
502   add_spin_binding (binding_set, GDK_KEY_KP_Down, 0, GTK_SCROLL_STEP_DOWN);
503   add_spin_binding (binding_set, GDK_KEY_Page_Up, 0, GTK_SCROLL_PAGE_UP);
504   add_spin_binding (binding_set, GDK_KEY_Page_Down, 0, GTK_SCROLL_PAGE_DOWN);
505   add_spin_binding (binding_set, GDK_KEY_Page_Up, GDK_CONTROL_MASK, GTK_SCROLL_END);
506   add_spin_binding (binding_set, GDK_KEY_Page_Down, GDK_CONTROL_MASK, GTK_SCROLL_START);
507
508   g_type_class_add_private (class, sizeof (GtkSpinButtonPrivate));
509 }
510
511 static void
512 gtk_spin_button_editable_init (GtkEditableInterface *iface)
513 {
514   iface->insert_text = gtk_spin_button_insert_text;
515 }
516
517 static void
518 gtk_spin_button_set_property (GObject      *object,
519                               guint         prop_id,
520                               const GValue *value,
521                               GParamSpec   *pspec)
522 {
523   GtkSpinButton *spin_button = GTK_SPIN_BUTTON (object);
524   GtkSpinButtonPrivate *priv = spin_button->priv;
525
526   switch (prop_id)
527     {
528       GtkAdjustment *adjustment;
529
530     case PROP_ADJUSTMENT:
531       adjustment = GTK_ADJUSTMENT (g_value_get_object (value));
532       if (!adjustment)
533         adjustment = gtk_adjustment_new (0.0, 0.0, 0.0, 0.0, 0.0, 0.0);
534       gtk_spin_button_set_adjustment (spin_button, adjustment);
535       break;
536     case PROP_CLIMB_RATE:
537       gtk_spin_button_configure (spin_button,
538                                  priv->adjustment,
539                                  g_value_get_double (value),
540                                  priv->digits);
541       break;
542     case PROP_DIGITS:
543       gtk_spin_button_configure (spin_button,
544                                  priv->adjustment,
545                                  priv->climb_rate,
546                                  g_value_get_uint (value));
547       break;
548     case PROP_SNAP_TO_TICKS:
549       gtk_spin_button_set_snap_to_ticks (spin_button, g_value_get_boolean (value));
550       break;
551     case PROP_NUMERIC:
552       gtk_spin_button_set_numeric (spin_button, g_value_get_boolean (value));
553       break;
554     case PROP_WRAP:
555       gtk_spin_button_set_wrap (spin_button, g_value_get_boolean (value));
556       break;
557     case PROP_UPDATE_POLICY:
558       gtk_spin_button_set_update_policy (spin_button, g_value_get_enum (value));
559       break;
560     case PROP_VALUE:
561       gtk_spin_button_set_value (spin_button, g_value_get_double (value));
562       break;
563     default:
564       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
565       break;
566     }
567 }
568
569 static void
570 gtk_spin_button_get_property (GObject      *object,
571                               guint         prop_id,
572                               GValue       *value,
573                               GParamSpec   *pspec)
574 {
575   GtkSpinButton *spin_button = GTK_SPIN_BUTTON (object);
576   GtkSpinButtonPrivate *priv = spin_button->priv;
577
578   switch (prop_id)
579     {
580     case PROP_ADJUSTMENT:
581       g_value_set_object (value, priv->adjustment);
582       break;
583     case PROP_CLIMB_RATE:
584       g_value_set_double (value, priv->climb_rate);
585       break;
586     case PROP_DIGITS:
587       g_value_set_uint (value, priv->digits);
588       break;
589     case PROP_SNAP_TO_TICKS:
590       g_value_set_boolean (value, priv->snap_to_ticks);
591       break;
592     case PROP_NUMERIC:
593       g_value_set_boolean (value, priv->numeric);
594       break;
595     case PROP_WRAP:
596       g_value_set_boolean (value, priv->wrap);
597       break;
598     case PROP_UPDATE_POLICY:
599       g_value_set_enum (value, priv->update_policy);
600       break;
601      case PROP_VALUE:
602        g_value_set_double (value, gtk_adjustment_get_value (priv->adjustment));
603       break;
604     default:
605       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
606       break;
607     }
608 }
609
610 static void
611 gtk_spin_button_init (GtkSpinButton *spin_button)
612 {
613   GtkSpinButtonPrivate *priv;
614   GtkStyleContext *context;
615
616   spin_button->priv = G_TYPE_INSTANCE_GET_PRIVATE (spin_button,
617                                                    GTK_TYPE_SPIN_BUTTON,
618                                                    GtkSpinButtonPrivate);
619   priv = spin_button->priv;
620
621   priv->adjustment = NULL;
622   priv->panel = NULL;
623   priv->timer = 0;
624   priv->climb_rate = 0.0;
625   priv->timer_step = 0.0;
626   priv->update_policy = GTK_UPDATE_ALWAYS;
627   priv->in_child = NO_ARROW;
628   priv->click_child = NO_ARROW;
629   priv->button = 0;
630   priv->need_timer = FALSE;
631   priv->timer_calls = 0;
632   priv->digits = 0;
633   priv->numeric = FALSE;
634   priv->wrap = FALSE;
635   priv->snap_to_ticks = FALSE;
636
637   gtk_spin_button_set_adjustment (spin_button,
638                                   gtk_adjustment_new (0, 0, 0, 0, 0, 0));
639
640   context = gtk_widget_get_style_context (GTK_WIDGET (spin_button));
641   gtk_style_context_add_class (context, GTK_STYLE_CLASS_SPINBUTTON);
642 }
643
644 static void
645 gtk_spin_button_finalize (GObject *object)
646 {
647   gtk_spin_button_set_adjustment (GTK_SPIN_BUTTON (object), NULL);
648
649   G_OBJECT_CLASS (gtk_spin_button_parent_class)->finalize (object);
650 }
651
652 static void
653 gtk_spin_button_destroy (GtkWidget *widget)
654 {
655   gtk_spin_button_stop_spinning (GTK_SPIN_BUTTON (widget));
656
657   GTK_WIDGET_CLASS (gtk_spin_button_parent_class)->destroy (widget);
658 }
659
660 static void
661 gtk_spin_button_map (GtkWidget *widget)
662 {
663   GtkSpinButton *spin_button = GTK_SPIN_BUTTON (widget);
664   GtkSpinButtonPrivate *priv = spin_button->priv;
665
666   if (gtk_widget_get_realized (widget) && !gtk_widget_get_mapped (widget))
667     {
668       GTK_WIDGET_CLASS (gtk_spin_button_parent_class)->map (widget);
669       gdk_window_show (priv->panel);
670     }
671 }
672
673 static void
674 gtk_spin_button_unmap (GtkWidget *widget)
675 {
676   GtkSpinButton *spin_button = GTK_SPIN_BUTTON (widget);
677   GtkSpinButtonPrivate *priv = spin_button->priv;
678
679   if (gtk_widget_get_mapped (widget))
680     {
681       gtk_spin_button_stop_spinning (GTK_SPIN_BUTTON (widget));
682
683       gdk_window_hide (priv->panel);
684       GTK_WIDGET_CLASS (gtk_spin_button_parent_class)->unmap (widget);
685     }
686 }
687
688 static void
689 gtk_spin_button_realize (GtkWidget *widget)
690 {
691   GtkSpinButton *spin_button = GTK_SPIN_BUTTON (widget);
692   GtkSpinButtonPrivate *priv = spin_button->priv;
693   GtkStyleContext *context;
694   GtkStateFlags state;
695   GtkAllocation allocation;
696   GtkRequisition requisition;
697   GdkWindowAttr attributes;
698   gint attributes_mask;
699   gboolean return_val;
700   gint arrow_size;
701   GtkBorder padding;
702
703   arrow_size = spin_button_get_arrow_size (spin_button);
704
705   gtk_widget_get_preferred_size (widget, &requisition, NULL);
706   gtk_widget_get_allocation (widget, &allocation);
707
708   gtk_widget_set_events (widget, gtk_widget_get_events (widget) |
709                          GDK_KEY_RELEASE_MASK);
710   GTK_WIDGET_CLASS (gtk_spin_button_parent_class)->realize (widget);
711
712   attributes.window_type = GDK_WINDOW_CHILD;
713   attributes.wclass = GDK_INPUT_ONLY;
714   attributes.visual = gtk_widget_get_visual (widget);
715   attributes.event_mask = gtk_widget_get_events (widget);
716   attributes.event_mask |= GDK_EXPOSURE_MASK | GDK_BUTTON_PRESS_MASK
717     | GDK_BUTTON_RELEASE_MASK | GDK_LEAVE_NOTIFY_MASK | GDK_ENTER_NOTIFY_MASK
718     | GDK_POINTER_MOTION_MASK | GDK_POINTER_MOTION_HINT_MASK;
719
720   attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL;
721
722   state = gtk_widget_get_state_flags (widget);
723   context = gtk_widget_get_style_context (widget);
724   gtk_style_context_get_padding (context, state, &padding);
725
726   attributes.x = allocation.x + allocation.width - arrow_size - (padding.left + padding.right);
727   attributes.y = allocation.y + (allocation.height - requisition.height) / 2;
728   attributes.width = arrow_size + padding.left + padding.right;
729   attributes.height = requisition.height;
730
731   priv->panel = gdk_window_new (gtk_widget_get_window (widget),
732                                 &attributes, attributes_mask);
733   gdk_window_set_user_data (priv->panel, widget);
734
735   return_val = FALSE;
736   g_signal_emit (spin_button, spinbutton_signals[OUTPUT], 0, &return_val);
737   if (return_val == FALSE)
738     gtk_spin_button_default_output (spin_button);
739
740   gtk_widget_queue_resize (GTK_WIDGET (spin_button));
741 }
742
743 static void
744 gtk_spin_button_unrealize (GtkWidget *widget)
745 {
746   GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
747   GtkSpinButtonPrivate *priv = spin->priv;
748
749   GTK_WIDGET_CLASS (gtk_spin_button_parent_class)->unrealize (widget);
750
751   if (priv->panel)
752     {
753       gdk_window_set_user_data (priv->panel, NULL);
754       gdk_window_destroy (priv->panel);
755       priv->panel = NULL;
756     }
757 }
758
759 static int
760 compute_double_length (double val, int digits)
761 {
762   int a;
763   int extra;
764
765   a = 1;
766   if (fabs (val) > 1.0)
767     a = floor (log10 (fabs (val))) + 1;
768
769   extra = 0;
770
771   /* The dot: */
772   if (digits > 0)
773     extra++;
774
775   /* The sign: */
776   if (val < 0)
777     extra++;
778
779   return a + digits + extra;
780 }
781
782 static void
783 gtk_spin_button_get_preferred_width (GtkWidget *widget,
784                                      gint      *minimum,
785                                      gint      *natural)
786 {
787   GtkSpinButton *spin_button = GTK_SPIN_BUTTON (widget);
788   GtkSpinButtonPrivate *priv = spin_button->priv;
789   GtkEntry *entry = GTK_ENTRY (widget);
790   GtkStyleContext *style_context;
791   GtkBorder padding;
792   gint arrow_size;
793
794   style_context = gtk_widget_get_style_context (widget);
795
796   arrow_size = spin_button_get_arrow_size (spin_button);
797
798   GTK_WIDGET_CLASS (gtk_spin_button_parent_class)->get_preferred_width (widget, minimum, natural);
799
800   if (gtk_entry_get_width_chars (entry) < 0)
801     {
802       PangoContext *context;
803       const PangoFontDescription *font_desc;
804       PangoFontMetrics *metrics;
805       gint width;
806       gint w;
807       gint string_len;
808       gint max_string_len;
809       gint digit_width;
810       gboolean interior_focus;
811       gint focus_width;
812       gint xborder, yborder;
813       GtkBorder inner_border;
814
815       gtk_widget_style_get (widget,
816                             "interior-focus", &interior_focus,
817                             "focus-line-width", &focus_width,
818                             NULL);
819
820       font_desc = gtk_style_context_get_font (style_context, 0);
821
822       context = gtk_widget_get_pango_context (widget);
823       metrics = pango_context_get_metrics (context, font_desc,
824                                            pango_context_get_language (context));
825
826       digit_width = pango_font_metrics_get_approximate_digit_width (metrics);
827       digit_width = PANGO_SCALE *
828         ((digit_width + PANGO_SCALE - 1) / PANGO_SCALE);
829
830       pango_font_metrics_unref (metrics);
831
832       /* Get max of MIN_SPIN_BUTTON_WIDTH, size of upper, size of lower */
833       width = MIN_SPIN_BUTTON_WIDTH;
834       max_string_len = MAX (10, compute_double_length (1e9 * gtk_adjustment_get_step_increment (priv->adjustment),
835                                                        priv->digits));
836
837       string_len = compute_double_length (gtk_adjustment_get_upper (priv->adjustment),
838                                           priv->digits);
839       w = PANGO_PIXELS (MIN (string_len, max_string_len) * digit_width);
840       width = MAX (width, w);
841       string_len = compute_double_length (gtk_adjustment_get_lower (priv->adjustment), priv->digits);
842       w = PANGO_PIXELS (MIN (string_len, max_string_len) * digit_width);
843       width = MAX (width, w);
844
845       _gtk_entry_get_borders (entry, &xborder, &yborder);
846       _gtk_entry_effective_inner_border (entry, &inner_border);
847
848       width += xborder * 2 + inner_border.left + inner_border.right;
849
850       *minimum = width;
851       *natural = width;
852     }
853
854   gtk_style_context_get_padding (style_context,
855                                  gtk_widget_get_state_flags (widget),
856                                  &padding);
857
858   *minimum += arrow_size + padding.left + padding.right;
859   *natural += arrow_size + padding.left + padding.right;
860 }
861
862 static void
863 gtk_spin_button_size_allocate (GtkWidget     *widget,
864                                GtkAllocation *allocation)
865 {
866   GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
867   GtkSpinButtonPrivate *priv = spin->priv;
868   GtkAllocation panel_allocation;
869   GtkRequisition requisition;
870   GtkStyleContext *context;
871   GtkStateFlags state;
872   GtkBorder padding;
873   gint arrow_size;
874   gint panel_width;
875
876   arrow_size = spin_button_get_arrow_size (spin);
877   context = gtk_widget_get_style_context (widget);
878   state = gtk_widget_get_state_flags (widget);
879
880   gtk_style_context_get_padding (context, state, &padding);
881   panel_width = arrow_size + padding.left + padding.right;
882
883   gtk_widget_get_preferred_size (widget, &requisition, NULL);
884
885   gtk_widget_set_allocation (widget, allocation);
886
887   if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL)
888     panel_allocation.x = allocation->x;
889   else
890     panel_allocation.x = allocation->x + allocation->width - panel_width;
891
892   panel_allocation.width = panel_width;
893   panel_allocation.height = MIN (requisition.height, allocation->height);
894
895   panel_allocation.y = allocation->y +
896                        (allocation->height - requisition.height) / 2;
897
898   GTK_WIDGET_CLASS (gtk_spin_button_parent_class)->size_allocate (widget, allocation);
899
900   if (gtk_widget_get_realized (widget))
901     {
902       gdk_window_move_resize (priv->panel,
903                               panel_allocation.x,
904                               panel_allocation.y,
905                               panel_allocation.width,
906                               panel_allocation.height);
907     }
908
909   gtk_widget_queue_draw (GTK_WIDGET (spin));
910 }
911
912 static gint
913 gtk_spin_button_draw (GtkWidget      *widget,
914                       cairo_t        *cr)
915 {
916   GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
917   GtkSpinButtonPrivate *priv = spin->priv;
918   GtkStyleContext *context;
919   GtkStateFlags state = 0;
920   gboolean is_rtl;
921
922   is_rtl = (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL);
923   context = gtk_widget_get_style_context (widget);
924
925   cairo_save (cr);
926   GTK_WIDGET_CLASS (gtk_spin_button_parent_class)->draw (widget, cr);
927   cairo_restore (cr);
928
929   state = gtk_widget_get_state_flags (widget);
930
931   if (gtk_widget_has_focus (widget))
932     state |= GTK_STATE_FLAG_FOCUSED;
933
934   gtk_style_context_save (context);
935   gtk_style_context_set_state (context, state);
936   gtk_style_context_remove_class (context, GTK_STYLE_CLASS_ENTRY);
937
938   if (is_rtl)
939     gtk_style_context_set_junction_sides (context, GTK_JUNCTION_RIGHT);
940   else
941     gtk_style_context_set_junction_sides (context, GTK_JUNCTION_LEFT);
942
943   gtk_cairo_transform_to_window (cr, widget, priv->panel);
944
945   if (gtk_entry_get_has_frame (GTK_ENTRY (widget)))
946     gtk_render_background (context, cr, 0, 0,
947                            gdk_window_get_width (priv->panel),
948                            gdk_window_get_height (priv->panel));
949
950   gtk_spin_button_draw_arrow (spin, context, cr, GTK_ARROW_UP);
951   gtk_spin_button_draw_arrow (spin, context, cr, GTK_ARROW_DOWN);
952
953   gtk_style_context_restore (context);
954
955   return FALSE;
956 }
957
958 static gboolean
959 spin_button_at_limit (GtkSpinButton *spin_button,
960                      GtkArrowType   arrow)
961 {
962   GtkSpinButtonPrivate *priv = spin_button->priv;
963   GtkArrowType effective_arrow;
964
965   if (priv->wrap)
966     return FALSE;
967
968   if (gtk_adjustment_get_step_increment (priv->adjustment) > 0)
969     effective_arrow = arrow;
970   else
971     effective_arrow = arrow == GTK_ARROW_UP ? GTK_ARROW_DOWN : GTK_ARROW_UP;
972
973   if (effective_arrow == GTK_ARROW_UP &&
974       (gtk_adjustment_get_upper (priv->adjustment) - gtk_adjustment_get_value (priv->adjustment) <= EPSILON))
975     return TRUE;
976
977   if (effective_arrow == GTK_ARROW_DOWN &&
978       (gtk_adjustment_get_value (priv->adjustment) - gtk_adjustment_get_lower (priv->adjustment) <= EPSILON))
979     return TRUE;
980
981   return FALSE;
982 }
983
984 static void
985 gtk_spin_button_draw_arrow (GtkSpinButton   *spin_button,
986                             GtkStyleContext *context,
987                             cairo_t         *cr,
988                             GtkArrowType     arrow_type)
989 {
990   GtkSpinButtonPrivate *priv;
991   GtkJunctionSides junction;
992   GtkStateFlags state;
993   GtkWidget *widget;
994   GtkBorder padding;
995   gdouble angle;
996   gint x;
997   gint y;
998   gint panel_height;
999   gint height;
1000   gint width;
1001   gint h, w;
1002
1003   g_return_if_fail (arrow_type == GTK_ARROW_UP || arrow_type == GTK_ARROW_DOWN);
1004
1005   gtk_style_context_save (context);
1006   gtk_style_context_add_class (context, GTK_STYLE_CLASS_BUTTON);
1007
1008   priv = spin_button->priv;
1009   widget = GTK_WIDGET (spin_button);
1010   junction = gtk_style_context_get_junction_sides (context);
1011
1012   panel_height = gdk_window_get_height (priv->panel);
1013
1014   if (arrow_type == GTK_ARROW_UP)
1015     {
1016       x = 0;
1017       y = 0;
1018
1019       height = panel_height / 2;
1020       angle = 0;
1021       junction |= GTK_JUNCTION_BOTTOM;
1022     }
1023   else
1024     {
1025       x = 0;
1026       y = panel_height / 2;
1027
1028       height = (panel_height + 1) / 2;
1029       angle = G_PI;
1030       junction |= GTK_JUNCTION_TOP;
1031     }
1032
1033   if (spin_button_at_limit (spin_button, arrow_type))
1034     state = GTK_STATE_FLAG_INSENSITIVE;
1035   else
1036     {
1037       if (priv->click_child == arrow_type)
1038         state = GTK_STATE_ACTIVE;
1039       else
1040         {
1041           if (priv->in_child == arrow_type &&
1042               priv->click_child == NO_ARROW)
1043             state = GTK_STATE_FLAG_PRELIGHT;
1044           else
1045             state = gtk_widget_get_state_flags (widget);
1046         }
1047     }
1048
1049   gtk_style_context_get_padding (context, state, &padding);
1050   gtk_style_context_set_junction_sides (context, junction);
1051   gtk_style_context_set_state (context, state);
1052
1053   width = spin_button_get_arrow_size (spin_button) + padding.left + padding.right;
1054
1055   gtk_render_background (context, cr, x, y, width, height);
1056   gtk_render_frame (context, cr, x, y, width, height);
1057
1058   height = panel_height;
1059
1060   if (arrow_type == GTK_ARROW_DOWN)
1061     {
1062       y = height / 2;
1063       height = height - y - 2;
1064     }
1065   else
1066     {
1067       y = 2;
1068       height = height / 2 - 2;
1069     }
1070
1071   width -= 3;
1072
1073   if (widget && gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL)
1074     x = 2;
1075   else
1076     x = 1;
1077
1078   w = width / 2;
1079   w -= w % 2 - 1; /* force odd */
1080   h = (w + 1) / 2;
1081
1082   x += (width - w) / 2;
1083   y += (height - h) / 2;
1084
1085   height = h;
1086   width = w;
1087
1088   gtk_render_arrow (context, cr,
1089                     angle, x, y, width);
1090
1091   gtk_style_context_restore (context);
1092 }
1093
1094 static gint
1095 gtk_spin_button_enter_notify (GtkWidget        *widget,
1096                               GdkEventCrossing *event)
1097 {
1098   GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1099   GtkSpinButtonPrivate *priv = spin->priv;
1100   GtkRequisition requisition;
1101
1102   if (event->window == priv->panel)
1103     {
1104       GdkDevice *device;
1105       gint x;
1106       gint y;
1107
1108       device = gdk_event_get_device ((GdkEvent *) event);
1109       gdk_window_get_device_position (priv->panel, device, &x, &y, NULL);
1110
1111       gtk_widget_get_preferred_size (widget, &requisition, NULL);
1112
1113       if (y <= requisition.height / 2)
1114         priv->in_child = GTK_ARROW_UP;
1115       else
1116         priv->in_child = GTK_ARROW_DOWN;
1117
1118       gtk_widget_queue_draw (GTK_WIDGET (spin));
1119     }
1120
1121   if (GTK_WIDGET_CLASS (gtk_spin_button_parent_class)->enter_notify_event)
1122     return GTK_WIDGET_CLASS (gtk_spin_button_parent_class)->enter_notify_event (widget, event);
1123
1124   return FALSE;
1125 }
1126
1127 static gint
1128 gtk_spin_button_leave_notify (GtkWidget        *widget,
1129                               GdkEventCrossing *event)
1130 {
1131   GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1132   GtkSpinButtonPrivate *priv = spin->priv;
1133
1134   priv->in_child = NO_ARROW;
1135   gtk_widget_queue_draw (GTK_WIDGET (spin));
1136
1137   if (GTK_WIDGET_CLASS (gtk_spin_button_parent_class)->leave_notify_event)
1138     return GTK_WIDGET_CLASS (gtk_spin_button_parent_class)->leave_notify_event (widget, event);
1139
1140   return FALSE;
1141 }
1142
1143 static gint
1144 gtk_spin_button_focus_out (GtkWidget     *widget,
1145                            GdkEventFocus *event)
1146 {
1147   if (gtk_editable_get_editable (GTK_EDITABLE (widget)))
1148     gtk_spin_button_update (GTK_SPIN_BUTTON (widget));
1149
1150   return GTK_WIDGET_CLASS (gtk_spin_button_parent_class)->focus_out_event (widget, event);
1151 }
1152
1153 static void
1154 gtk_spin_button_grab_notify (GtkWidget *widget,
1155                              gboolean   was_grabbed)
1156 {
1157   GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1158
1159   if (!was_grabbed)
1160     {
1161       gtk_spin_button_stop_spinning (spin);
1162       gtk_widget_queue_draw (GTK_WIDGET (spin));
1163     }
1164 }
1165
1166 static void
1167 gtk_spin_button_state_flags_changed (GtkWidget     *widget,
1168                                      GtkStateFlags  previous_state)
1169 {
1170   GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1171
1172   if (!gtk_widget_is_sensitive (widget))
1173     {
1174       gtk_spin_button_stop_spinning (spin);
1175       gtk_widget_queue_draw (GTK_WIDGET (spin));
1176     }
1177 }
1178
1179 static void
1180 gtk_spin_button_style_updated (GtkWidget *widget)
1181 {
1182   GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1183   GtkSpinButtonPrivate *priv = spin->priv;
1184
1185   if (gtk_widget_get_realized (widget))
1186     {
1187       GtkStyleContext *context;
1188
1189       context = gtk_widget_get_style_context (widget);
1190       gtk_style_context_set_background (context, priv->panel);
1191     }
1192
1193   GTK_WIDGET_CLASS (gtk_spin_button_parent_class)->style_updated (widget);
1194 }
1195
1196
1197 static gint
1198 gtk_spin_button_scroll (GtkWidget      *widget,
1199                         GdkEventScroll *event)
1200 {
1201   GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1202   GtkSpinButtonPrivate *priv = spin->priv;
1203
1204   if (event->direction == GDK_SCROLL_UP)
1205     {
1206       if (!gtk_widget_has_focus (widget))
1207         gtk_widget_grab_focus (widget);
1208       gtk_spin_button_real_spin (spin, gtk_adjustment_get_step_increment (priv->adjustment));
1209     }
1210   else if (event->direction == GDK_SCROLL_DOWN)
1211     {
1212       if (!gtk_widget_has_focus (widget))
1213         gtk_widget_grab_focus (widget);
1214       gtk_spin_button_real_spin (spin, -gtk_adjustment_get_step_increment (priv->adjustment));
1215     }
1216   else
1217     return FALSE;
1218
1219   return TRUE;
1220 }
1221
1222 static void
1223 gtk_spin_button_stop_spinning (GtkSpinButton *spin)
1224 {
1225   GtkSpinButtonPrivate *priv = spin->priv;
1226
1227   if (priv->timer)
1228     {
1229       g_source_remove (priv->timer);
1230       priv->timer = 0;
1231       priv->timer_calls = 0;
1232       priv->need_timer = FALSE;
1233     }
1234
1235   priv->button = 0;
1236   priv->timer = 0;
1237   priv->timer_step = gtk_adjustment_get_step_increment (priv->adjustment);
1238   priv->timer_calls = 0;
1239
1240   priv->click_child = NO_ARROW;
1241   priv->button = 0;
1242 }
1243
1244 static void
1245 start_spinning (GtkSpinButton *spin,
1246                 GtkArrowType   click_child,
1247                 gdouble        step)
1248 {
1249   GtkSpinButtonPrivate *priv;
1250
1251   g_return_if_fail (click_child == GTK_ARROW_UP || click_child == GTK_ARROW_DOWN);
1252
1253   priv = spin->priv;
1254
1255   priv->click_child = click_child;
1256
1257   if (!priv->timer)
1258     {
1259       GtkSettings *settings = gtk_widget_get_settings (GTK_WIDGET (spin));
1260       guint        timeout;
1261
1262       g_object_get (settings, "gtk-timeout-initial", &timeout, NULL);
1263
1264       priv->timer_step = step;
1265       priv->need_timer = TRUE;
1266       priv->timer = gdk_threads_add_timeout (timeout,
1267                                    (GSourceFunc) gtk_spin_button_timer,
1268                                    (gpointer) spin);
1269     }
1270   gtk_spin_button_real_spin (spin, click_child == GTK_ARROW_UP ? step : -step);
1271
1272   gtk_widget_queue_draw (GTK_WIDGET (spin));
1273 }
1274
1275 static gint
1276 gtk_spin_button_button_press (GtkWidget      *widget,
1277                               GdkEventButton *event)
1278 {
1279   GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1280   GtkSpinButtonPrivate *priv = spin->priv;
1281
1282   if (!priv->button)
1283     {
1284       if (event->window == priv->panel)
1285         {
1286           GtkRequisition requisition;
1287
1288           if (!gtk_widget_has_focus (widget))
1289             gtk_widget_grab_focus (widget);
1290           priv->button = event->button;
1291
1292           if (gtk_editable_get_editable (GTK_EDITABLE (widget)))
1293             gtk_spin_button_update (spin);
1294
1295           gtk_widget_get_preferred_size (widget, &requisition, NULL);
1296
1297           if (event->y <= requisition.height / 2)
1298             {
1299               if (event->button == 1)
1300                 start_spinning (spin, GTK_ARROW_UP, gtk_adjustment_get_step_increment (priv->adjustment));
1301               else if (event->button == 2)
1302                 start_spinning (spin, GTK_ARROW_UP, gtk_adjustment_get_page_increment (priv->adjustment));
1303               else
1304                 priv->click_child = GTK_ARROW_UP;
1305             }
1306           else
1307             {
1308               if (event->button == 1)
1309                 start_spinning (spin, GTK_ARROW_DOWN, gtk_adjustment_get_step_increment (priv->adjustment));
1310               else if (event->button == 2)
1311                 start_spinning (spin, GTK_ARROW_DOWN, gtk_adjustment_get_page_increment (priv->adjustment));
1312               else
1313                 priv->click_child = GTK_ARROW_DOWN;
1314             }
1315           return TRUE;
1316         }
1317       else
1318         return GTK_WIDGET_CLASS (gtk_spin_button_parent_class)->button_press_event (widget, event);
1319     }
1320   return FALSE;
1321 }
1322
1323 static gint
1324 gtk_spin_button_button_release (GtkWidget      *widget,
1325                                 GdkEventButton *event)
1326 {
1327   GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1328   GtkSpinButtonPrivate *priv = spin->priv;
1329   gint arrow_size;
1330
1331   arrow_size = spin_button_get_arrow_size (spin);
1332
1333   if (event->button == priv->button)
1334     {
1335       int click_child = priv->click_child;
1336
1337       gtk_spin_button_stop_spinning (spin);
1338
1339       if (event->button == 3)
1340         {
1341           GtkRequisition requisition;
1342           GtkStyleContext *context;
1343           GtkStateFlags state;
1344           GtkBorder padding;
1345
1346           gtk_widget_get_preferred_size (widget, &requisition, NULL);
1347
1348           context = gtk_widget_get_style_context (widget);
1349           state = gtk_widget_get_state_flags (widget);
1350           gtk_style_context_get_padding (context, state, &padding);
1351
1352           if (event->y >= 0 && event->x >= 0 &&
1353               event->y <= requisition.height &&
1354               event->x <= arrow_size + padding.left + padding.right)
1355             {
1356               if (click_child == GTK_ARROW_UP &&
1357                   event->y <= requisition.height / 2)
1358                 {
1359                   gdouble diff;
1360
1361                   diff = gtk_adjustment_get_upper (priv->adjustment) - gtk_adjustment_get_value (priv->adjustment);
1362                   if (diff > EPSILON)
1363                     gtk_spin_button_real_spin (spin, diff);
1364                 }
1365               else if (click_child == GTK_ARROW_DOWN &&
1366                        event->y > requisition.height / 2)
1367                 {
1368                   gdouble diff;
1369
1370                   diff = gtk_adjustment_get_value (priv->adjustment) - gtk_adjustment_get_lower (priv->adjustment);
1371                   if (diff > EPSILON)
1372                     gtk_spin_button_real_spin (spin, -diff);
1373                 }
1374             }
1375         }
1376       gtk_widget_queue_draw (GTK_WIDGET (spin));
1377
1378       return TRUE;
1379     }
1380   else
1381     return GTK_WIDGET_CLASS (gtk_spin_button_parent_class)->button_release_event (widget, event);
1382 }
1383
1384 static gint
1385 gtk_spin_button_motion_notify (GtkWidget      *widget,
1386                                GdkEventMotion *event)
1387 {
1388   GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1389   GtkSpinButtonPrivate *priv = spin->priv;
1390
1391   if (priv->button)
1392     return FALSE;
1393
1394   if (event->window == priv->panel)
1395     {
1396       GtkRequisition requisition;
1397       gint y = event->y;
1398
1399       gdk_event_request_motions (event);
1400
1401       gtk_widget_get_preferred_size (widget, &requisition, NULL);
1402
1403       if (y <= requisition.height / 2 &&
1404           priv->in_child == GTK_ARROW_DOWN)
1405         {
1406           priv->in_child = GTK_ARROW_UP;
1407           gtk_widget_queue_draw (GTK_WIDGET (spin));
1408         }
1409       else if (y > requisition.height / 2 &&
1410           priv->in_child == GTK_ARROW_UP)
1411         {
1412           priv->in_child = GTK_ARROW_DOWN;
1413           gtk_widget_queue_draw (GTK_WIDGET (spin));
1414         }
1415
1416       return FALSE;
1417     }
1418
1419   return GTK_WIDGET_CLASS (gtk_spin_button_parent_class)->motion_notify_event (widget, event);
1420 }
1421
1422 static gint
1423 gtk_spin_button_timer (GtkSpinButton *spin_button)
1424 {
1425   GtkSpinButtonPrivate *priv = spin_button->priv;
1426   gboolean retval = FALSE;
1427
1428   if (priv->timer)
1429     {
1430       if (priv->click_child == GTK_ARROW_UP)
1431         gtk_spin_button_real_spin (spin_button, priv->timer_step);
1432       else
1433         gtk_spin_button_real_spin (spin_button, -priv->timer_step);
1434
1435       if (priv->need_timer)
1436         {
1437           GtkSettings *settings = gtk_widget_get_settings (GTK_WIDGET (spin_button));
1438           guint        timeout;
1439
1440           g_object_get (settings, "gtk-timeout-repeat", &timeout, NULL);
1441
1442           priv->need_timer = FALSE;
1443           priv->timer = gdk_threads_add_timeout (timeout,
1444                                               (GSourceFunc) gtk_spin_button_timer,
1445                                               (gpointer) spin_button);
1446         }
1447       else
1448         {
1449           if (priv->climb_rate > 0.0 && priv->timer_step
1450               < gtk_adjustment_get_page_increment (priv->adjustment))
1451             {
1452               if (priv->timer_calls < MAX_TIMER_CALLS)
1453                 priv->timer_calls++;
1454               else
1455                 {
1456                   priv->timer_calls = 0;
1457                   priv->timer_step += priv->climb_rate;
1458                 }
1459             }
1460           retval = TRUE;
1461         }
1462     }
1463
1464   return retval;
1465 }
1466
1467 static void
1468 gtk_spin_button_value_changed (GtkAdjustment *adjustment,
1469                                GtkSpinButton *spin_button)
1470 {
1471   gboolean return_val;
1472
1473   g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
1474
1475   return_val = FALSE;
1476   g_signal_emit (spin_button, spinbutton_signals[OUTPUT], 0, &return_val);
1477   if (return_val == FALSE)
1478     gtk_spin_button_default_output (spin_button);
1479
1480   g_signal_emit (spin_button, spinbutton_signals[VALUE_CHANGED], 0);
1481
1482   gtk_widget_queue_draw (GTK_WIDGET (spin_button));
1483
1484   g_object_notify (G_OBJECT (spin_button), "value");
1485 }
1486
1487 static void
1488 gtk_spin_button_real_change_value (GtkSpinButton *spin,
1489                                    GtkScrollType  scroll)
1490 {
1491   GtkSpinButtonPrivate *priv = spin->priv;
1492   gdouble old_value;
1493
1494   /* When the key binding is activated, there may be an outstanding
1495    * value, so we first have to commit what is currently written in
1496    * the spin buttons text entry. See #106574
1497    */
1498   gtk_spin_button_update (spin);
1499
1500   old_value = gtk_adjustment_get_value (priv->adjustment);
1501
1502   /* We don't test whether the entry is editable, since
1503    * this key binding conceptually corresponds to changing
1504    * the value with the buttons using the mouse, which
1505    * we allow for non-editable spin buttons.
1506    */
1507   switch (scroll)
1508     {
1509     case GTK_SCROLL_STEP_BACKWARD:
1510     case GTK_SCROLL_STEP_DOWN:
1511     case GTK_SCROLL_STEP_LEFT:
1512       gtk_spin_button_real_spin (spin, -priv->timer_step);
1513
1514       if (priv->climb_rate > 0.0 && priv->timer_step
1515           < gtk_adjustment_get_page_increment (priv->adjustment))
1516         {
1517           if (priv->timer_calls < MAX_TIMER_CALLS)
1518             priv->timer_calls++;
1519           else
1520             {
1521               priv->timer_calls = 0;
1522               priv->timer_step += priv->climb_rate;
1523             }
1524         }
1525       break;
1526
1527     case GTK_SCROLL_STEP_FORWARD:
1528     case GTK_SCROLL_STEP_UP:
1529     case GTK_SCROLL_STEP_RIGHT:
1530       gtk_spin_button_real_spin (spin, priv->timer_step);
1531
1532       if (priv->climb_rate > 0.0 && priv->timer_step
1533           < gtk_adjustment_get_page_increment (priv->adjustment))
1534         {
1535           if (priv->timer_calls < MAX_TIMER_CALLS)
1536             priv->timer_calls++;
1537           else
1538             {
1539               priv->timer_calls = 0;
1540               priv->timer_step += priv->climb_rate;
1541             }
1542         }
1543       break;
1544
1545     case GTK_SCROLL_PAGE_BACKWARD:
1546     case GTK_SCROLL_PAGE_DOWN:
1547     case GTK_SCROLL_PAGE_LEFT:
1548       gtk_spin_button_real_spin (spin, -gtk_adjustment_get_page_increment (priv->adjustment));
1549       break;
1550
1551     case GTK_SCROLL_PAGE_FORWARD:
1552     case GTK_SCROLL_PAGE_UP:
1553     case GTK_SCROLL_PAGE_RIGHT:
1554       gtk_spin_button_real_spin (spin, gtk_adjustment_get_page_increment (priv->adjustment));
1555       break;
1556
1557     case GTK_SCROLL_START:
1558       {
1559         gdouble diff = gtk_adjustment_get_value (priv->adjustment) - gtk_adjustment_get_lower (priv->adjustment);
1560         if (diff > EPSILON)
1561           gtk_spin_button_real_spin (spin, -diff);
1562         break;
1563       }
1564
1565     case GTK_SCROLL_END:
1566       {
1567         gdouble diff = gtk_adjustment_get_upper (priv->adjustment) - gtk_adjustment_get_value (priv->adjustment);
1568         if (diff > EPSILON)
1569           gtk_spin_button_real_spin (spin, diff);
1570         break;
1571       }
1572
1573     default:
1574       g_warning ("Invalid scroll type %d for GtkSpinButton::change-value", scroll);
1575       break;
1576     }
1577
1578   gtk_spin_button_update (spin);
1579
1580   if (gtk_adjustment_get_value (priv->adjustment) == old_value)
1581     gtk_widget_error_bell (GTK_WIDGET (spin));
1582 }
1583
1584 static gint
1585 gtk_spin_button_key_release (GtkWidget   *widget,
1586                              GdkEventKey *event)
1587 {
1588   GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1589   GtkSpinButtonPrivate *priv = spin->priv;
1590
1591   /* We only get a release at the end of a key repeat run, so reset the timer_step */
1592   priv->timer_step = gtk_adjustment_get_step_increment (priv->adjustment);
1593   priv->timer_calls = 0;
1594
1595   return TRUE;
1596 }
1597
1598 static void
1599 gtk_spin_button_snap (GtkSpinButton *spin_button,
1600                       gdouble        val)
1601 {
1602   GtkSpinButtonPrivate *priv = spin_button->priv;
1603   gdouble inc;
1604   gdouble tmp;
1605
1606   inc = gtk_adjustment_get_step_increment (priv->adjustment);
1607   if (inc == 0)
1608     return;
1609
1610   tmp = (val - gtk_adjustment_get_lower (priv->adjustment)) / inc;
1611   if (tmp - floor (tmp) < ceil (tmp) - tmp)
1612     val = gtk_adjustment_get_lower (priv->adjustment) + floor (tmp) * inc;
1613   else
1614     val = gtk_adjustment_get_lower (priv->adjustment) + ceil (tmp) * inc;
1615
1616   gtk_spin_button_set_value (spin_button, val);
1617 }
1618
1619 static void
1620 gtk_spin_button_activate (GtkEntry *entry)
1621 {
1622   if (gtk_editable_get_editable (GTK_EDITABLE (entry)))
1623     gtk_spin_button_update (GTK_SPIN_BUTTON (entry));
1624
1625   /* Chain up so that entry->activates_default is honored */
1626   GTK_ENTRY_CLASS (gtk_spin_button_parent_class)->activate (entry);
1627 }
1628
1629 static void
1630 gtk_spin_button_get_text_area_size (GtkEntry *entry,
1631                                     gint     *x,
1632                                     gint     *y,
1633                                     gint     *width,
1634                                     gint     *height)
1635 {
1636   GtkStyleContext *context;
1637   GtkStateFlags state;
1638   GtkWidget *widget;
1639   GtkBorder padding;
1640   gint arrow_size;
1641   gint panel_width;
1642
1643   GTK_ENTRY_CLASS (gtk_spin_button_parent_class)->get_text_area_size (entry, x, y, width, height);
1644
1645   widget = GTK_WIDGET (entry);
1646   state = gtk_widget_get_state_flags (widget);
1647   context = gtk_widget_get_style_context (widget);
1648   gtk_style_context_get_padding (context, state, &padding);
1649
1650   arrow_size = spin_button_get_arrow_size (GTK_SPIN_BUTTON (entry));
1651   panel_width = arrow_size + padding.left + padding.right;
1652
1653   if (width)
1654     *width -= panel_width;
1655
1656   if (gtk_widget_get_direction (GTK_WIDGET (entry)) == GTK_TEXT_DIR_RTL && x)
1657     *x += panel_width;
1658 }
1659
1660 static void
1661 gtk_spin_button_insert_text (GtkEditable *editable,
1662                              const gchar *new_text,
1663                              gint         new_text_length,
1664                              gint        *position)
1665 {
1666   GtkEntry *entry = GTK_ENTRY (editable);
1667   GtkSpinButton *spin = GTK_SPIN_BUTTON (editable);
1668   GtkSpinButtonPrivate *priv = spin->priv;
1669   GtkEditableInterface *parent_editable_iface;
1670
1671   parent_editable_iface = g_type_interface_peek (gtk_spin_button_parent_class,
1672                                                  GTK_TYPE_EDITABLE);
1673
1674   if (priv->numeric)
1675     {
1676       struct lconv *lc;
1677       gboolean sign;
1678       gint dotpos = -1;
1679       gint i;
1680       guint32 pos_sign;
1681       guint32 neg_sign;
1682       gint entry_length;
1683       const gchar *entry_text;
1684
1685       entry_length = gtk_entry_get_text_length (entry);
1686       entry_text = gtk_entry_get_text (entry);
1687
1688       lc = localeconv ();
1689
1690       if (*(lc->negative_sign))
1691         neg_sign = *(lc->negative_sign);
1692       else
1693         neg_sign = '-';
1694
1695       if (*(lc->positive_sign))
1696         pos_sign = *(lc->positive_sign);
1697       else
1698         pos_sign = '+';
1699
1700 #ifdef G_OS_WIN32
1701       /* Workaround for bug caused by some Windows application messing
1702        * up the positive sign of the current locale, more specifically
1703        * HKEY_CURRENT_USER\Control Panel\International\sPositiveSign.
1704        * See bug #330743 and for instance
1705        * http://www.msnewsgroups.net/group/microsoft.public.dotnet.languages.csharp/topic36024.aspx
1706        *
1707        * I don't know if the positive sign always gets bogusly set to
1708        * a digit when the above Registry value is corrupted as
1709        * described. (In my test case, it got set to "8", and in the
1710        * bug report above it presumably was set ot "0".) Probably it
1711        * might get set to almost anything? So how to distinguish a
1712        * bogus value from some correct one for some locale? That is
1713        * probably hard, but at least we should filter out the
1714        * digits...
1715        */
1716       if (pos_sign >= '0' && pos_sign <= '9')
1717         pos_sign = '+';
1718 #endif
1719
1720       for (sign=0, i=0; i<entry_length; i++)
1721         if ((entry_text[i] == neg_sign) ||
1722             (entry_text[i] == pos_sign))
1723           {
1724             sign = 1;
1725             break;
1726           }
1727
1728       if (sign && !(*position))
1729         return;
1730
1731       for (dotpos=-1, i=0; i<entry_length; i++)
1732         if (entry_text[i] == *(lc->decimal_point))
1733           {
1734             dotpos = i;
1735             break;
1736           }
1737
1738       if (dotpos > -1 && *position > dotpos &&
1739           (gint)priv->digits - entry_length
1740             + dotpos - new_text_length + 1 < 0)
1741         return;
1742
1743       for (i = 0; i < new_text_length; i++)
1744         {
1745           if (new_text[i] == neg_sign || new_text[i] == pos_sign)
1746             {
1747               if (sign || (*position) || i)
1748                 return;
1749               sign = TRUE;
1750             }
1751           else if (new_text[i] == *(lc->decimal_point))
1752             {
1753               if (!priv->digits || dotpos > -1 ||
1754                   (new_text_length - 1 - i + entry_length
1755                     - *position > (gint)priv->digits))
1756                 return;
1757               dotpos = *position + i;
1758             }
1759           else if (new_text[i] < 0x30 || new_text[i] > 0x39)
1760             return;
1761         }
1762     }
1763
1764   parent_editable_iface->insert_text (editable, new_text,
1765                                       new_text_length, position);
1766 }
1767
1768 static void
1769 gtk_spin_button_real_spin (GtkSpinButton *spin_button,
1770                            gdouble        increment)
1771 {
1772   GtkSpinButtonPrivate *priv = spin_button->priv;
1773   GtkAdjustment *adjustment;
1774   gdouble new_value = 0.0;
1775   gboolean wrapped = FALSE;
1776
1777   adjustment = priv->adjustment;
1778
1779   new_value = gtk_adjustment_get_value (adjustment) + increment;
1780
1781   if (increment > 0)
1782     {
1783       if (priv->wrap)
1784         {
1785           if (fabs (gtk_adjustment_get_value (adjustment) - gtk_adjustment_get_upper (adjustment)) < EPSILON)
1786             {
1787               new_value = gtk_adjustment_get_lower (adjustment);
1788               wrapped = TRUE;
1789             }
1790           else if (new_value > gtk_adjustment_get_upper (adjustment))
1791             new_value = gtk_adjustment_get_upper (adjustment);
1792         }
1793       else
1794         new_value = MIN (new_value, gtk_adjustment_get_upper (adjustment));
1795     }
1796   else if (increment < 0)
1797     {
1798       if (priv->wrap)
1799         {
1800           if (fabs (gtk_adjustment_get_value (adjustment) - gtk_adjustment_get_lower (adjustment)) < EPSILON)
1801             {
1802               new_value = gtk_adjustment_get_upper (adjustment);
1803               wrapped = TRUE;
1804             }
1805           else if (new_value < gtk_adjustment_get_lower (adjustment))
1806             new_value = gtk_adjustment_get_lower (adjustment);
1807         }
1808       else
1809         new_value = MAX (new_value, gtk_adjustment_get_lower (adjustment));
1810     }
1811
1812   if (fabs (new_value - gtk_adjustment_get_value (adjustment)) > EPSILON)
1813     gtk_adjustment_set_value (adjustment, new_value);
1814
1815   if (wrapped)
1816     g_signal_emit (spin_button, spinbutton_signals[WRAPPED], 0);
1817
1818   gtk_widget_queue_draw (GTK_WIDGET (spin_button));
1819 }
1820
1821 static gint
1822 gtk_spin_button_default_input (GtkSpinButton *spin_button,
1823                                gdouble       *new_val)
1824 {
1825   gchar *err = NULL;
1826
1827   *new_val = g_strtod (gtk_entry_get_text (GTK_ENTRY (spin_button)), &err);
1828   if (*err)
1829     return GTK_INPUT_ERROR;
1830   else
1831     return FALSE;
1832 }
1833
1834 static gint
1835 gtk_spin_button_default_output (GtkSpinButton *spin_button)
1836 {
1837   GtkSpinButtonPrivate *priv = spin_button->priv;
1838
1839   gchar *buf = g_strdup_printf ("%0.*f", priv->digits, gtk_adjustment_get_value (priv->adjustment));
1840
1841   if (strcmp (buf, gtk_entry_get_text (GTK_ENTRY (spin_button))))
1842     gtk_entry_set_text (GTK_ENTRY (spin_button), buf);
1843   g_free (buf);
1844   return FALSE;
1845 }
1846
1847
1848 /***********************************************************
1849  ***********************************************************
1850  ***                  Public interface                   ***
1851  ***********************************************************
1852  ***********************************************************/
1853
1854
1855 /**
1856  * gtk_spin_button_configure:
1857  * @spin_button: a #GtkSpinButton
1858  * @adjustment: (allow-none):  a #GtkAdjustment
1859  * @climb_rate: the new climb rate
1860  * @digits: the number of decimal places to display in the spin button
1861  *
1862  * Changes the properties of an existing spin button. The adjustment,
1863  * climb rate, and number of decimal places are all changed accordingly,
1864  * after this function call.
1865  */
1866 void
1867 gtk_spin_button_configure (GtkSpinButton *spin_button,
1868                            GtkAdjustment *adjustment,
1869                            gdouble        climb_rate,
1870                            guint          digits)
1871 {
1872   GtkSpinButtonPrivate *priv;
1873
1874   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
1875
1876   priv = spin_button->priv;
1877
1878   if (adjustment)
1879     gtk_spin_button_set_adjustment (spin_button, adjustment);
1880   else
1881     adjustment = priv->adjustment;
1882
1883   g_object_freeze_notify (G_OBJECT (spin_button));
1884   if (priv->digits != digits)
1885     {
1886       priv->digits = digits;
1887       g_object_notify (G_OBJECT (spin_button), "digits");
1888     }
1889
1890   if (priv->climb_rate != climb_rate)
1891     {
1892       priv->climb_rate = climb_rate;
1893       g_object_notify (G_OBJECT (spin_button), "climb-rate");
1894     }
1895   g_object_thaw_notify (G_OBJECT (spin_button));
1896
1897   gtk_adjustment_value_changed (adjustment);
1898 }
1899
1900 /**
1901  * gtk_spin_button_new:
1902  * @adjustment: (allow-none): the #GtkAdjustment object that this spin
1903  *     button should use, or %NULL
1904  * @climb_rate: specifies how much the spin button changes when an arrow
1905  *     is clicked on
1906  * @digits: the number of decimal places to display
1907  *
1908  * Creates a new #GtkSpinButton.
1909  *
1910  * Returns: The new spin button as a #GtkWidget
1911  */
1912 GtkWidget *
1913 gtk_spin_button_new (GtkAdjustment *adjustment,
1914                      gdouble        climb_rate,
1915                      guint          digits)
1916 {
1917   GtkSpinButton *spin;
1918
1919   if (adjustment)
1920     g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), NULL);
1921
1922   spin = g_object_new (GTK_TYPE_SPIN_BUTTON, NULL);
1923
1924   gtk_spin_button_configure (spin, adjustment, climb_rate, digits);
1925
1926   return GTK_WIDGET (spin);
1927 }
1928
1929 /**
1930  * gtk_spin_button_new_with_range:
1931  * @min: Minimum allowable value
1932  * @max: Maximum allowable value
1933  * @step: Increment added or subtracted by spinning the widget
1934  *
1935  * This is a convenience constructor that allows creation of a numeric
1936  * #GtkSpinButton without manually creating an adjustment. The value is
1937  * initially set to the minimum value and a page increment of 10 * @step
1938  * is the default. The precision of the spin button is equivalent to the
1939  * precision of @step.
1940  *
1941  * Note that the way in which the precision is derived works best if @step
1942  * is a power of ten. If the resulting precision is not suitable for your
1943  * needs, use gtk_spin_button_set_digits() to correct it.
1944  *
1945  * Return value: The new spin button as a #GtkWidget
1946  */
1947 GtkWidget *
1948 gtk_spin_button_new_with_range (gdouble min,
1949                                 gdouble max,
1950                                 gdouble step)
1951 {
1952   GtkAdjustment *adjustment;
1953   GtkSpinButton *spin;
1954   gint digits;
1955
1956   g_return_val_if_fail (min <= max, NULL);
1957   g_return_val_if_fail (step != 0.0, NULL);
1958
1959   spin = g_object_new (GTK_TYPE_SPIN_BUTTON, NULL);
1960
1961   adjustment = gtk_adjustment_new (min, min, max, step, 10 * step, 0);
1962
1963   if (fabs (step) >= 1.0 || step == 0.0)
1964     digits = 0;
1965   else {
1966     digits = abs ((gint) floor (log10 (fabs (step))));
1967     if (digits > MAX_DIGITS)
1968       digits = MAX_DIGITS;
1969   }
1970
1971   gtk_spin_button_configure (spin, adjustment, step, digits);
1972
1973   gtk_spin_button_set_numeric (spin, TRUE);
1974
1975   return GTK_WIDGET (spin);
1976 }
1977
1978 /* Callback used when the spin button's adjustment changes.
1979  * We need to redraw the arrows when the adjustment's range
1980  * changes, and reevaluate our size request.
1981  */
1982 static void
1983 adjustment_changed_cb (GtkAdjustment *adjustment, gpointer data)
1984 {
1985   GtkSpinButton *spin_button = GTK_SPIN_BUTTON (data);
1986   GtkSpinButtonPrivate *priv = spin_button->priv;
1987
1988   priv->timer_step = gtk_adjustment_get_step_increment (priv->adjustment);
1989   gtk_widget_queue_resize (GTK_WIDGET (spin_button));
1990 }
1991
1992 /**
1993  * gtk_spin_button_set_adjustment:
1994  * @spin_button: a #GtkSpinButton
1995  * @adjustment: a #GtkAdjustment to replace the existing adjustment
1996  *
1997  * Replaces the #GtkAdjustment associated with @spin_button.
1998  */
1999 void
2000 gtk_spin_button_set_adjustment (GtkSpinButton *spin_button,
2001                                 GtkAdjustment *adjustment)
2002 {
2003   GtkSpinButtonPrivate *priv;
2004
2005   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2006
2007   priv = spin_button->priv;
2008
2009   if (priv->adjustment != adjustment)
2010     {
2011       if (priv->adjustment)
2012         {
2013           g_signal_handlers_disconnect_by_func (priv->adjustment,
2014                                                 gtk_spin_button_value_changed,
2015                                                 spin_button);
2016           g_signal_handlers_disconnect_by_func (priv->adjustment,
2017                                                 adjustment_changed_cb,
2018                                                 spin_button);
2019           g_object_unref (priv->adjustment);
2020         }
2021       priv->adjustment = adjustment;
2022       if (adjustment)
2023         {
2024           g_object_ref_sink (adjustment);
2025           g_signal_connect (adjustment, "value-changed",
2026                             G_CALLBACK (gtk_spin_button_value_changed),
2027                             spin_button);
2028           g_signal_connect (adjustment, "changed",
2029                             G_CALLBACK (adjustment_changed_cb),
2030                             spin_button);
2031           priv->timer_step = gtk_adjustment_get_step_increment (priv->adjustment);
2032         }
2033
2034       gtk_widget_queue_resize (GTK_WIDGET (spin_button));
2035     }
2036
2037   g_object_notify (G_OBJECT (spin_button), "adjustment");
2038 }
2039
2040 /**
2041  * gtk_spin_button_get_adjustment:
2042  * @spin_button: a #GtkSpinButton
2043  *
2044  * Get the adjustment associated with a #GtkSpinButton
2045  *
2046  * Return value: (transfer none): the #GtkAdjustment of @spin_button
2047  **/
2048 GtkAdjustment *
2049 gtk_spin_button_get_adjustment (GtkSpinButton *spin_button)
2050 {
2051   g_return_val_if_fail (GTK_IS_SPIN_BUTTON (spin_button), NULL);
2052
2053   return spin_button->priv->adjustment;
2054 }
2055
2056 /**
2057  * gtk_spin_button_set_digits:
2058  * @spin_button: a #GtkSpinButton
2059  * @digits: the number of digits after the decimal point to be displayed for the spin button's value
2060  *
2061  * Set the precision to be displayed by @spin_button. Up to 20 digit precision
2062  * is allowed.
2063  **/
2064 void
2065 gtk_spin_button_set_digits (GtkSpinButton *spin_button,
2066                             guint          digits)
2067 {
2068   GtkSpinButtonPrivate *priv;
2069
2070   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2071
2072   priv = spin_button->priv;
2073
2074   if (priv->digits != digits)
2075     {
2076       priv->digits = digits;
2077       gtk_spin_button_value_changed (priv->adjustment, spin_button);
2078       g_object_notify (G_OBJECT (spin_button), "digits");
2079
2080       /* since lower/upper may have changed */
2081       gtk_widget_queue_resize (GTK_WIDGET (spin_button));
2082     }
2083 }
2084
2085 /**
2086  * gtk_spin_button_get_digits:
2087  * @spin_button: a #GtkSpinButton
2088  *
2089  * Fetches the precision of @spin_button. See gtk_spin_button_set_digits().
2090  *
2091  * Returns: the current precision
2092  **/
2093 guint
2094 gtk_spin_button_get_digits (GtkSpinButton *spin_button)
2095 {
2096   g_return_val_if_fail (GTK_IS_SPIN_BUTTON (spin_button), 0);
2097
2098   return spin_button->priv->digits;
2099 }
2100
2101 /**
2102  * gtk_spin_button_set_increments:
2103  * @spin_button: a #GtkSpinButton
2104  * @step: increment applied for a button 1 press.
2105  * @page: increment applied for a button 2 press.
2106  *
2107  * Sets the step and page increments for spin_button.  This affects how
2108  * quickly the value changes when the spin button's arrows are activated.
2109  **/
2110 void
2111 gtk_spin_button_set_increments (GtkSpinButton *spin_button,
2112                                 gdouble        step,
2113                                 gdouble        page)
2114 {
2115   GtkSpinButtonPrivate *priv;
2116
2117   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2118
2119   priv = spin_button->priv;
2120
2121   gtk_adjustment_configure (priv->adjustment,
2122                             gtk_adjustment_get_value (priv->adjustment),
2123                             gtk_adjustment_get_lower (priv->adjustment),
2124                             gtk_adjustment_get_upper (priv->adjustment),
2125                             step,
2126                             page,
2127                             gtk_adjustment_get_page_size (priv->adjustment));
2128 }
2129
2130 /**
2131  * gtk_spin_button_get_increments:
2132  * @spin_button: a #GtkSpinButton
2133  * @step: (out) (allow-none): location to store step increment, or %NULL
2134  * @page: (out) (allow-none): location to store page increment, or %NULL
2135  *
2136  * Gets the current step and page the increments used by @spin_button. See
2137  * gtk_spin_button_set_increments().
2138  **/
2139 void
2140 gtk_spin_button_get_increments (GtkSpinButton *spin_button,
2141                                 gdouble       *step,
2142                                 gdouble       *page)
2143 {
2144   GtkSpinButtonPrivate *priv;
2145
2146   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2147
2148   priv = spin_button->priv;
2149
2150   if (step)
2151     *step = gtk_adjustment_get_step_increment (priv->adjustment);
2152   if (page)
2153     *page = gtk_adjustment_get_page_increment (priv->adjustment);
2154 }
2155
2156 /**
2157  * gtk_spin_button_set_range:
2158  * @spin_button: a #GtkSpinButton
2159  * @min: minimum allowable value
2160  * @max: maximum allowable value
2161  *
2162  * Sets the minimum and maximum allowable values for @spin_button.
2163  */
2164 void
2165 gtk_spin_button_set_range (GtkSpinButton *spin_button,
2166                            gdouble        min,
2167                            gdouble        max)
2168 {
2169   GtkAdjustment *adjustment;
2170
2171   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2172
2173   adjustment = spin_button->priv->adjustment;
2174
2175   gtk_adjustment_configure (adjustment,
2176                             CLAMP (gtk_adjustment_get_value (adjustment), min, max),
2177                             min,
2178                             max,
2179                             gtk_adjustment_get_step_increment (adjustment),
2180                             gtk_adjustment_get_page_increment (adjustment),
2181                             gtk_adjustment_get_page_size (adjustment));
2182 }
2183
2184 /**
2185  * gtk_spin_button_get_range:
2186  * @spin_button: a #GtkSpinButton
2187  * @min: (out) (allow-none): location to store minimum allowed value, or %NULL
2188  * @max: (out) (allow-none): location to store maximum allowed value, or %NULL
2189  *
2190  * Gets the range allowed for @spin_button.
2191  * See gtk_spin_button_set_range().
2192  */
2193 void
2194 gtk_spin_button_get_range (GtkSpinButton *spin_button,
2195                            gdouble       *min,
2196                            gdouble       *max)
2197 {
2198   GtkSpinButtonPrivate *priv;
2199
2200   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2201
2202   priv = spin_button->priv;
2203
2204   if (min)
2205     *min = gtk_adjustment_get_lower (priv->adjustment);
2206   if (max)
2207     *max = gtk_adjustment_get_upper (priv->adjustment);
2208 }
2209
2210 /**
2211  * gtk_spin_button_get_value:
2212  * @spin_button: a #GtkSpinButton
2213  *
2214  * Get the value in the @spin_button.
2215  *
2216  * Return value: the value of @spin_button
2217  */
2218 gdouble
2219 gtk_spin_button_get_value (GtkSpinButton *spin_button)
2220 {
2221   g_return_val_if_fail (GTK_IS_SPIN_BUTTON (spin_button), 0.0);
2222
2223   return gtk_adjustment_get_value (spin_button->priv->adjustment);
2224 }
2225
2226 /**
2227  * gtk_spin_button_get_value_as_int:
2228  * @spin_button: a #GtkSpinButton
2229  *
2230  * Get the value @spin_button represented as an integer.
2231  *
2232  * Return value: the value of @spin_button
2233  */
2234 gint
2235 gtk_spin_button_get_value_as_int (GtkSpinButton *spin_button)
2236 {
2237   GtkSpinButtonPrivate *priv;
2238   gdouble val;
2239
2240   g_return_val_if_fail (GTK_IS_SPIN_BUTTON (spin_button), 0);
2241
2242   priv = spin_button->priv;
2243
2244   val = gtk_adjustment_get_value (priv->adjustment);
2245   if (val - floor (val) < ceil (val) - val)
2246     return floor (val);
2247   else
2248     return ceil (val);
2249 }
2250
2251 /**
2252  * gtk_spin_button_set_value:
2253  * @spin_button: a #GtkSpinButton
2254  * @value: the new value
2255  *
2256  * Sets the value of @spin_button.
2257  */
2258 void
2259 gtk_spin_button_set_value (GtkSpinButton *spin_button,
2260                            gdouble        value)
2261 {
2262   GtkSpinButtonPrivate *priv;
2263
2264   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2265
2266   priv = spin_button->priv;
2267
2268   if (fabs (value - gtk_adjustment_get_value (priv->adjustment)) > EPSILON)
2269     gtk_adjustment_set_value (priv->adjustment, value);
2270   else
2271     {
2272       gint return_val = FALSE;
2273       g_signal_emit (spin_button, spinbutton_signals[OUTPUT], 0, &return_val);
2274       if (return_val == FALSE)
2275         gtk_spin_button_default_output (spin_button);
2276     }
2277 }
2278
2279 /**
2280  * gtk_spin_button_set_update_policy:
2281  * @spin_button: a #GtkSpinButton
2282  * @policy: a #GtkSpinButtonUpdatePolicy value
2283  *
2284  * Sets the update behavior of a spin button.
2285  * This determines wether the spin button is always updated
2286  * or only when a valid value is set.
2287  */
2288 void
2289 gtk_spin_button_set_update_policy (GtkSpinButton             *spin_button,
2290                                    GtkSpinButtonUpdatePolicy  policy)
2291 {
2292   GtkSpinButtonPrivate *priv;
2293
2294   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2295
2296   priv = spin_button->priv;
2297
2298   if (priv->update_policy != policy)
2299     {
2300       priv->update_policy = policy;
2301       g_object_notify (G_OBJECT (spin_button), "update-policy");
2302     }
2303 }
2304
2305 /**
2306  * gtk_spin_button_get_update_policy:
2307  * @spin_button: a #GtkSpinButton
2308  *
2309  * Gets the update behavior of a spin button.
2310  * See gtk_spin_button_set_update_policy().
2311  *
2312  * Return value: the current update policy
2313  */
2314 GtkSpinButtonUpdatePolicy
2315 gtk_spin_button_get_update_policy (GtkSpinButton *spin_button)
2316 {
2317   g_return_val_if_fail (GTK_IS_SPIN_BUTTON (spin_button), GTK_UPDATE_ALWAYS);
2318
2319   return spin_button->priv->update_policy;
2320 }
2321
2322 /**
2323  * gtk_spin_button_set_numeric:
2324  * @spin_button: a #GtkSpinButton
2325  * @numeric: flag indicating if only numeric entry is allowed
2326  *
2327  * Sets the flag that determines if non-numeric text can be typed
2328  * into the spin button.
2329  */
2330 void
2331 gtk_spin_button_set_numeric (GtkSpinButton *spin_button,
2332                              gboolean       numeric)
2333 {
2334   GtkSpinButtonPrivate *priv;
2335
2336   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2337
2338   priv = spin_button->priv;
2339
2340   numeric = numeric != FALSE;
2341
2342   if (priv->numeric != numeric)
2343     {
2344        priv->numeric = numeric;
2345        g_object_notify (G_OBJECT (spin_button), "numeric");
2346     }
2347 }
2348
2349 /**
2350  * gtk_spin_button_get_numeric:
2351  * @spin_button: a #GtkSpinButton
2352  *
2353  * Returns whether non-numeric text can be typed into the spin button.
2354  * See gtk_spin_button_set_numeric().
2355  *
2356  * Return value: %TRUE if only numeric text can be entered
2357  */
2358 gboolean
2359 gtk_spin_button_get_numeric (GtkSpinButton *spin_button)
2360 {
2361   g_return_val_if_fail (GTK_IS_SPIN_BUTTON (spin_button), FALSE);
2362
2363   return spin_button->priv->numeric;
2364 }
2365
2366 /**
2367  * gtk_spin_button_set_wrap:
2368  * @spin_button: a #GtkSpinButton
2369  * @wrap: a flag indicating if wrapping behavior is performed
2370  *
2371  * Sets the flag that determines if a spin button value wraps
2372  * around to the opposite limit when the upper or lower limit
2373  * of the range is exceeded.
2374  */
2375 void
2376 gtk_spin_button_set_wrap (GtkSpinButton  *spin_button,
2377                           gboolean        wrap)
2378 {
2379   GtkSpinButtonPrivate *priv;
2380
2381   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2382
2383   priv = spin_button->priv;
2384
2385   wrap = wrap != FALSE;
2386
2387   if (priv->wrap != wrap)
2388     {
2389        priv->wrap = wrap;
2390
2391        g_object_notify (G_OBJECT (spin_button), "wrap");
2392     }
2393 }
2394
2395 /**
2396  * gtk_spin_button_get_wrap:
2397  * @spin_button: a #GtkSpinButton
2398  *
2399  * Returns whether the spin button's value wraps around to the
2400  * opposite limit when the upper or lower limit of the range is
2401  * exceeded. See gtk_spin_button_set_wrap().
2402  *
2403  * Return value: %TRUE if the spin button wraps around
2404  */
2405 gboolean
2406 gtk_spin_button_get_wrap (GtkSpinButton *spin_button)
2407 {
2408   g_return_val_if_fail (GTK_IS_SPIN_BUTTON (spin_button), FALSE);
2409
2410   return spin_button->priv->wrap;
2411 }
2412
2413 static gint
2414 spin_button_get_arrow_size (GtkSpinButton *spin_button)
2415 {
2416   const PangoFontDescription *font_desc;
2417   GtkStyleContext *context;
2418   gint size;
2419   gint arrow_size;
2420
2421   /* FIXME: use getter */
2422   context = gtk_widget_get_style_context (GTK_WIDGET (spin_button));
2423   font_desc = gtk_style_context_get_font (context, 0);
2424
2425   size = pango_font_description_get_size (font_desc);
2426   arrow_size = MAX (PANGO_PIXELS (size), MIN_ARROW_WIDTH);
2427
2428   return arrow_size - arrow_size % 2; /* force even */
2429 }
2430
2431 /**
2432  * gtk_spin_button_set_snap_to_ticks:
2433  * @spin_button: a #GtkSpinButton
2434  * @snap_to_ticks: a flag indicating if invalid values should be corrected
2435  *
2436  * Sets the policy as to whether values are corrected to the
2437  * nearest step increment when a spin button is activated after
2438  * providing an invalid value.
2439  */
2440 void
2441 gtk_spin_button_set_snap_to_ticks (GtkSpinButton *spin_button,
2442                                    gboolean       snap_to_ticks)
2443 {
2444   GtkSpinButtonPrivate *priv;
2445   guint new_val;
2446
2447   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2448
2449   priv = spin_button->priv;
2450
2451   new_val = (snap_to_ticks != 0);
2452
2453   if (new_val != priv->snap_to_ticks)
2454     {
2455       priv->snap_to_ticks = new_val;
2456       if (new_val && gtk_editable_get_editable (GTK_EDITABLE (spin_button)))
2457         gtk_spin_button_update (spin_button);
2458
2459       g_object_notify (G_OBJECT (spin_button), "snap-to-ticks");
2460     }
2461 }
2462
2463 /**
2464  * gtk_spin_button_get_snap_to_ticks:
2465  * @spin_button: a #GtkSpinButton
2466  *
2467  * Returns whether the values are corrected to the nearest step.
2468  * See gtk_spin_button_set_snap_to_ticks().
2469  *
2470  * Return value: %TRUE if values are snapped to the nearest step
2471  */
2472 gboolean
2473 gtk_spin_button_get_snap_to_ticks (GtkSpinButton *spin_button)
2474 {
2475   g_return_val_if_fail (GTK_IS_SPIN_BUTTON (spin_button), FALSE);
2476
2477   return spin_button->priv->snap_to_ticks;
2478 }
2479
2480 /**
2481  * gtk_spin_button_spin:
2482  * @spin_button: a #GtkSpinButton
2483  * @direction: a #GtkSpinType indicating the direction to spin
2484  * @increment: step increment to apply in the specified direction
2485  *
2486  * Increment or decrement a spin button's value in a specified
2487  * direction by a specified amount.
2488  */
2489 void
2490 gtk_spin_button_spin (GtkSpinButton *spin_button,
2491                       GtkSpinType    direction,
2492                       gdouble        increment)
2493 {
2494   GtkSpinButtonPrivate *priv;
2495   GtkAdjustment *adjustment;
2496   gdouble diff;
2497
2498   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2499
2500   priv = spin_button->priv;
2501
2502   adjustment = priv->adjustment;
2503
2504   /* for compatibility with the 1.0.x version of this function */
2505   if (increment != 0 && increment != gtk_adjustment_get_step_increment (adjustment) &&
2506       (direction == GTK_SPIN_STEP_FORWARD ||
2507        direction == GTK_SPIN_STEP_BACKWARD))
2508     {
2509       if (direction == GTK_SPIN_STEP_BACKWARD && increment > 0)
2510         increment = -increment;
2511       direction = GTK_SPIN_USER_DEFINED;
2512     }
2513
2514   switch (direction)
2515     {
2516     case GTK_SPIN_STEP_FORWARD:
2517
2518       gtk_spin_button_real_spin (spin_button, gtk_adjustment_get_step_increment (adjustment));
2519       break;
2520
2521     case GTK_SPIN_STEP_BACKWARD:
2522
2523       gtk_spin_button_real_spin (spin_button, -gtk_adjustment_get_step_increment (adjustment));
2524       break;
2525
2526     case GTK_SPIN_PAGE_FORWARD:
2527
2528       gtk_spin_button_real_spin (spin_button, gtk_adjustment_get_page_increment (adjustment));
2529       break;
2530
2531     case GTK_SPIN_PAGE_BACKWARD:
2532
2533       gtk_spin_button_real_spin (spin_button, -gtk_adjustment_get_page_increment (adjustment));
2534       break;
2535
2536     case GTK_SPIN_HOME:
2537
2538       diff = gtk_adjustment_get_value (adjustment) - gtk_adjustment_get_lower (adjustment);
2539       if (diff > EPSILON)
2540         gtk_spin_button_real_spin (spin_button, -diff);
2541       break;
2542
2543     case GTK_SPIN_END:
2544
2545       diff = gtk_adjustment_get_upper (adjustment) - gtk_adjustment_get_value (adjustment);
2546       if (diff > EPSILON)
2547         gtk_spin_button_real_spin (spin_button, diff);
2548       break;
2549
2550     case GTK_SPIN_USER_DEFINED:
2551
2552       if (increment != 0)
2553         gtk_spin_button_real_spin (spin_button, increment);
2554       break;
2555
2556     default:
2557       break;
2558     }
2559 }
2560
2561 /**
2562  * gtk_spin_button_update:
2563  * @spin_button: a #GtkSpinButton
2564  *
2565  * Manually force an update of the spin button.
2566  */
2567 void
2568 gtk_spin_button_update (GtkSpinButton *spin_button)
2569 {
2570   GtkSpinButtonPrivate *priv;
2571   gdouble val;
2572   gint error = 0;
2573   gint return_val;
2574
2575   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2576
2577   priv = spin_button->priv;
2578
2579   return_val = FALSE;
2580   g_signal_emit (spin_button, spinbutton_signals[INPUT], 0, &val, &return_val);
2581   if (return_val == FALSE)
2582     {
2583       return_val = gtk_spin_button_default_input (spin_button, &val);
2584       error = (return_val == GTK_INPUT_ERROR);
2585     }
2586   else if (return_val == GTK_INPUT_ERROR)
2587     error = 1;
2588
2589   gtk_widget_queue_draw (GTK_WIDGET (spin_button));
2590
2591   if (priv->update_policy == GTK_UPDATE_ALWAYS)
2592     {
2593       if (val < gtk_adjustment_get_lower (priv->adjustment))
2594         val = gtk_adjustment_get_lower (priv->adjustment);
2595       else if (val > gtk_adjustment_get_upper (priv->adjustment))
2596         val = gtk_adjustment_get_upper (priv->adjustment);
2597     }
2598   else if ((priv->update_policy == GTK_UPDATE_IF_VALID) &&
2599            (error ||
2600             val < gtk_adjustment_get_lower (priv->adjustment) ||
2601             val > gtk_adjustment_get_upper (priv->adjustment)))
2602     {
2603       gtk_spin_button_value_changed (priv->adjustment, spin_button);
2604       return;
2605     }
2606
2607   if (priv->snap_to_ticks)
2608     gtk_spin_button_snap (spin_button, val);
2609   else
2610     gtk_spin_button_set_value (spin_button, val);
2611 }
2612
2613 GdkWindow *
2614 _gtk_spin_button_get_panel (GtkSpinButton *spin_button)
2615 {
2616   return spin_button->priv->panel;
2617 }