]> Pileus Git - ~andy/gtk/blob - gtk/gtkspinbutton.c
gtk: don't always invalidate spinbuttons on each leave_notify()
[~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 gboolean 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   gtk_style_context_save (context);
932   gtk_style_context_set_state (context, state);
933   gtk_style_context_remove_class (context, GTK_STYLE_CLASS_ENTRY);
934
935   if (is_rtl)
936     gtk_style_context_set_junction_sides (context, GTK_JUNCTION_RIGHT);
937   else
938     gtk_style_context_set_junction_sides (context, GTK_JUNCTION_LEFT);
939
940   gtk_cairo_transform_to_window (cr, widget, priv->panel);
941
942   if (gtk_entry_get_has_frame (GTK_ENTRY (widget)))
943     gtk_render_background (context, cr, 0, 0,
944                            gdk_window_get_width (priv->panel),
945                            gdk_window_get_height (priv->panel));
946
947   gtk_spin_button_draw_arrow (spin, context, cr, GTK_ARROW_UP);
948   gtk_spin_button_draw_arrow (spin, context, cr, GTK_ARROW_DOWN);
949
950   gtk_style_context_restore (context);
951
952   return FALSE;
953 }
954
955 static gboolean
956 spin_button_at_limit (GtkSpinButton *spin_button,
957                      GtkArrowType   arrow)
958 {
959   GtkSpinButtonPrivate *priv = spin_button->priv;
960   GtkArrowType effective_arrow;
961
962   if (priv->wrap)
963     return FALSE;
964
965   if (gtk_adjustment_get_step_increment (priv->adjustment) > 0)
966     effective_arrow = arrow;
967   else
968     effective_arrow = arrow == GTK_ARROW_UP ? GTK_ARROW_DOWN : GTK_ARROW_UP;
969
970   if (effective_arrow == GTK_ARROW_UP &&
971       (gtk_adjustment_get_upper (priv->adjustment) - gtk_adjustment_get_value (priv->adjustment) <= EPSILON))
972     return TRUE;
973
974   if (effective_arrow == GTK_ARROW_DOWN &&
975       (gtk_adjustment_get_value (priv->adjustment) - gtk_adjustment_get_lower (priv->adjustment) <= EPSILON))
976     return TRUE;
977
978   return FALSE;
979 }
980
981 static void
982 gtk_spin_button_draw_arrow (GtkSpinButton   *spin_button,
983                             GtkStyleContext *context,
984                             cairo_t         *cr,
985                             GtkArrowType     arrow_type)
986 {
987   GtkSpinButtonPrivate *priv;
988   GtkJunctionSides junction;
989   GtkStateFlags state;
990   GtkWidget *widget;
991   GtkBorder padding;
992   gdouble angle;
993   gint x;
994   gint y;
995   gint panel_height;
996   gint height;
997   gint width;
998   gint h, w;
999
1000   g_return_if_fail (arrow_type == GTK_ARROW_UP || arrow_type == GTK_ARROW_DOWN);
1001
1002   gtk_style_context_save (context);
1003   gtk_style_context_add_class (context, GTK_STYLE_CLASS_BUTTON);
1004
1005   priv = spin_button->priv;
1006   widget = GTK_WIDGET (spin_button);
1007   junction = gtk_style_context_get_junction_sides (context);
1008
1009   panel_height = gdk_window_get_height (priv->panel);
1010
1011   if (arrow_type == GTK_ARROW_UP)
1012     {
1013       x = 0;
1014       y = 0;
1015
1016       height = panel_height / 2;
1017       angle = 0;
1018       junction |= GTK_JUNCTION_BOTTOM;
1019     }
1020   else
1021     {
1022       x = 0;
1023       y = panel_height / 2;
1024
1025       height = (panel_height + 1) / 2;
1026       angle = G_PI;
1027       junction |= GTK_JUNCTION_TOP;
1028     }
1029
1030   if (spin_button_at_limit (spin_button, arrow_type))
1031     state = GTK_STATE_FLAG_INSENSITIVE;
1032   else
1033     {
1034       if (priv->click_child == arrow_type)
1035         state = GTK_STATE_ACTIVE;
1036       else
1037         {
1038           if (priv->in_child == arrow_type &&
1039               priv->click_child == NO_ARROW)
1040             state = GTK_STATE_FLAG_PRELIGHT;
1041           else
1042             state = gtk_widget_get_state_flags (widget);
1043         }
1044     }
1045
1046   gtk_style_context_get_padding (context, state, &padding);
1047   gtk_style_context_set_junction_sides (context, junction);
1048   gtk_style_context_set_state (context, state);
1049
1050   width = spin_button_get_arrow_size (spin_button) + padding.left + padding.right;
1051
1052   gtk_render_background (context, cr, x, y, width, height);
1053   gtk_render_frame (context, cr, x, y, width, height);
1054
1055   height = panel_height;
1056
1057   if (arrow_type == GTK_ARROW_DOWN)
1058     {
1059       y = height / 2;
1060       height = height - y - 2;
1061     }
1062   else
1063     {
1064       y = 2;
1065       height = height / 2 - 2;
1066     }
1067
1068   width -= 3;
1069
1070   if (widget && gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL)
1071     x = 2;
1072   else
1073     x = 1;
1074
1075   w = width / 2;
1076   w -= w % 2 - 1; /* force odd */
1077   h = (w + 1) / 2;
1078
1079   x += (width - w) / 2;
1080   y += (height - h) / 2;
1081
1082   height = h;
1083   width = w;
1084
1085   gtk_render_arrow (context, cr,
1086                     angle, x, y, width);
1087
1088   gtk_style_context_restore (context);
1089 }
1090
1091 static gint
1092 gtk_spin_button_enter_notify (GtkWidget        *widget,
1093                               GdkEventCrossing *event)
1094 {
1095   GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1096   GtkSpinButtonPrivate *priv = spin->priv;
1097   GtkRequisition requisition;
1098
1099   if (event->window == priv->panel)
1100     {
1101       GdkDevice *device;
1102       gint x;
1103       gint y;
1104
1105       device = gdk_event_get_device ((GdkEvent *) event);
1106       gdk_window_get_device_position (priv->panel, device, &x, &y, NULL);
1107
1108       gtk_widget_get_preferred_size (widget, &requisition, NULL);
1109
1110       if (y <= requisition.height / 2)
1111         priv->in_child = GTK_ARROW_UP;
1112       else
1113         priv->in_child = GTK_ARROW_DOWN;
1114
1115       gtk_widget_queue_draw (GTK_WIDGET (spin));
1116     }
1117
1118   return GTK_WIDGET_CLASS (gtk_spin_button_parent_class)->enter_notify_event (widget, event);
1119 }
1120
1121 static gint
1122 gtk_spin_button_leave_notify (GtkWidget        *widget,
1123                               GdkEventCrossing *event)
1124 {
1125   GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1126   GtkSpinButtonPrivate *priv = spin->priv;
1127
1128   if (priv->in_child != NO_ARROW)
1129     {
1130       priv->in_child = NO_ARROW;
1131       gtk_widget_queue_draw (GTK_WIDGET (spin));
1132     }
1133
1134   return GTK_WIDGET_CLASS (gtk_spin_button_parent_class)->leave_notify_event (widget, event);
1135 }
1136
1137 static gint
1138 gtk_spin_button_focus_out (GtkWidget     *widget,
1139                            GdkEventFocus *event)
1140 {
1141   if (gtk_editable_get_editable (GTK_EDITABLE (widget)))
1142     gtk_spin_button_update (GTK_SPIN_BUTTON (widget));
1143
1144   return GTK_WIDGET_CLASS (gtk_spin_button_parent_class)->focus_out_event (widget, event);
1145 }
1146
1147 static void
1148 gtk_spin_button_grab_notify (GtkWidget *widget,
1149                              gboolean   was_grabbed)
1150 {
1151   GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1152
1153   if (!was_grabbed)
1154     {
1155       if (gtk_spin_button_stop_spinning (spin))
1156         gtk_widget_queue_draw (GTK_WIDGET (spin));
1157     }
1158 }
1159
1160 static void
1161 gtk_spin_button_state_flags_changed (GtkWidget     *widget,
1162                                      GtkStateFlags  previous_state)
1163 {
1164   GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1165
1166   if (!gtk_widget_is_sensitive (widget))
1167     {
1168       if (gtk_spin_button_stop_spinning (spin))
1169         gtk_widget_queue_draw (GTK_WIDGET (spin));
1170     }
1171 }
1172
1173 static void
1174 gtk_spin_button_style_updated (GtkWidget *widget)
1175 {
1176   GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1177   GtkSpinButtonPrivate *priv = spin->priv;
1178
1179   if (gtk_widget_get_realized (widget))
1180     {
1181       GtkStyleContext *context;
1182
1183       context = gtk_widget_get_style_context (widget);
1184       gtk_style_context_set_background (context, priv->panel);
1185     }
1186
1187   GTK_WIDGET_CLASS (gtk_spin_button_parent_class)->style_updated (widget);
1188 }
1189
1190
1191 static gint
1192 gtk_spin_button_scroll (GtkWidget      *widget,
1193                         GdkEventScroll *event)
1194 {
1195   GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1196   GtkSpinButtonPrivate *priv = spin->priv;
1197
1198   if (event->direction == GDK_SCROLL_UP)
1199     {
1200       if (!gtk_widget_has_focus (widget))
1201         gtk_widget_grab_focus (widget);
1202       gtk_spin_button_real_spin (spin, gtk_adjustment_get_step_increment (priv->adjustment));
1203     }
1204   else if (event->direction == GDK_SCROLL_DOWN)
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
1211     return FALSE;
1212
1213   return TRUE;
1214 }
1215
1216 static gboolean
1217 gtk_spin_button_stop_spinning (GtkSpinButton *spin)
1218 {
1219   GtkSpinButtonPrivate *priv = spin->priv;
1220   gboolean did_spin = FALSE;
1221
1222   if (priv->timer)
1223     {
1224       g_source_remove (priv->timer);
1225       priv->timer = 0;
1226       priv->need_timer = FALSE;
1227
1228       did_spin = TRUE;
1229     }
1230
1231   priv->button = 0;
1232   priv->timer_step = gtk_adjustment_get_step_increment (priv->adjustment);
1233   priv->timer_calls = 0;
1234
1235   priv->click_child = NO_ARROW;
1236
1237   return did_spin;
1238 }
1239
1240 static void
1241 start_spinning (GtkSpinButton *spin,
1242                 GtkArrowType   click_child,
1243                 gdouble        step)
1244 {
1245   GtkSpinButtonPrivate *priv;
1246
1247   g_return_if_fail (click_child == GTK_ARROW_UP || click_child == GTK_ARROW_DOWN);
1248
1249   priv = spin->priv;
1250
1251   priv->click_child = click_child;
1252
1253   if (!priv->timer)
1254     {
1255       GtkSettings *settings = gtk_widget_get_settings (GTK_WIDGET (spin));
1256       guint        timeout;
1257
1258       g_object_get (settings, "gtk-timeout-initial", &timeout, NULL);
1259
1260       priv->timer_step = step;
1261       priv->need_timer = TRUE;
1262       priv->timer = gdk_threads_add_timeout (timeout,
1263                                    (GSourceFunc) gtk_spin_button_timer,
1264                                    (gpointer) spin);
1265     }
1266   gtk_spin_button_real_spin (spin, click_child == GTK_ARROW_UP ? step : -step);
1267
1268   gtk_widget_queue_draw (GTK_WIDGET (spin));
1269 }
1270
1271 static gint
1272 gtk_spin_button_button_press (GtkWidget      *widget,
1273                               GdkEventButton *event)
1274 {
1275   GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1276   GtkSpinButtonPrivate *priv = spin->priv;
1277
1278   if (!priv->button)
1279     {
1280       if (event->window == priv->panel)
1281         {
1282           GtkRequisition requisition;
1283
1284           if (!gtk_widget_has_focus (widget))
1285             gtk_widget_grab_focus (widget);
1286           priv->button = event->button;
1287
1288           if (gtk_editable_get_editable (GTK_EDITABLE (widget)))
1289             gtk_spin_button_update (spin);
1290
1291           gtk_widget_get_preferred_size (widget, &requisition, NULL);
1292
1293           if (event->y <= requisition.height / 2)
1294             {
1295               if (event->button == 1)
1296                 start_spinning (spin, GTK_ARROW_UP, gtk_adjustment_get_step_increment (priv->adjustment));
1297               else if (event->button == 2)
1298                 start_spinning (spin, GTK_ARROW_UP, gtk_adjustment_get_page_increment (priv->adjustment));
1299               else
1300                 priv->click_child = GTK_ARROW_UP;
1301             }
1302           else
1303             {
1304               if (event->button == 1)
1305                 start_spinning (spin, GTK_ARROW_DOWN, gtk_adjustment_get_step_increment (priv->adjustment));
1306               else if (event->button == 2)
1307                 start_spinning (spin, GTK_ARROW_DOWN, gtk_adjustment_get_page_increment (priv->adjustment));
1308               else
1309                 priv->click_child = GTK_ARROW_DOWN;
1310             }
1311           return TRUE;
1312         }
1313       else
1314         return GTK_WIDGET_CLASS (gtk_spin_button_parent_class)->button_press_event (widget, event);
1315     }
1316   return FALSE;
1317 }
1318
1319 static gint
1320 gtk_spin_button_button_release (GtkWidget      *widget,
1321                                 GdkEventButton *event)
1322 {
1323   GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1324   GtkSpinButtonPrivate *priv = spin->priv;
1325   gint arrow_size;
1326
1327   arrow_size = spin_button_get_arrow_size (spin);
1328
1329   if (event->button == priv->button)
1330     {
1331       int click_child = priv->click_child;
1332
1333       gtk_spin_button_stop_spinning (spin);
1334
1335       if (event->button == 3)
1336         {
1337           GtkRequisition requisition;
1338           GtkStyleContext *context;
1339           GtkStateFlags state;
1340           GtkBorder padding;
1341
1342           gtk_widget_get_preferred_size (widget, &requisition, NULL);
1343
1344           context = gtk_widget_get_style_context (widget);
1345           state = gtk_widget_get_state_flags (widget);
1346           gtk_style_context_get_padding (context, state, &padding);
1347
1348           if (event->y >= 0 && event->x >= 0 &&
1349               event->y <= requisition.height &&
1350               event->x <= arrow_size + padding.left + padding.right)
1351             {
1352               if (click_child == GTK_ARROW_UP &&
1353                   event->y <= requisition.height / 2)
1354                 {
1355                   gdouble diff;
1356
1357                   diff = gtk_adjustment_get_upper (priv->adjustment) - gtk_adjustment_get_value (priv->adjustment);
1358                   if (diff > EPSILON)
1359                     gtk_spin_button_real_spin (spin, diff);
1360                 }
1361               else if (click_child == GTK_ARROW_DOWN &&
1362                        event->y > requisition.height / 2)
1363                 {
1364                   gdouble diff;
1365
1366                   diff = gtk_adjustment_get_value (priv->adjustment) - gtk_adjustment_get_lower (priv->adjustment);
1367                   if (diff > EPSILON)
1368                     gtk_spin_button_real_spin (spin, -diff);
1369                 }
1370             }
1371         }
1372       gtk_widget_queue_draw (GTK_WIDGET (spin));
1373
1374       return TRUE;
1375     }
1376   else
1377     return GTK_WIDGET_CLASS (gtk_spin_button_parent_class)->button_release_event (widget, event);
1378 }
1379
1380 static gint
1381 gtk_spin_button_motion_notify (GtkWidget      *widget,
1382                                GdkEventMotion *event)
1383 {
1384   GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1385   GtkSpinButtonPrivate *priv = spin->priv;
1386
1387   if (priv->button)
1388     return FALSE;
1389
1390   if (event->window == priv->panel)
1391     {
1392       GtkRequisition requisition;
1393       gint y = event->y;
1394
1395       gdk_event_request_motions (event);
1396
1397       gtk_widget_get_preferred_size (widget, &requisition, NULL);
1398
1399       if (y <= requisition.height / 2 &&
1400           priv->in_child == GTK_ARROW_DOWN)
1401         {
1402           priv->in_child = GTK_ARROW_UP;
1403           gtk_widget_queue_draw (GTK_WIDGET (spin));
1404         }
1405       else if (y > requisition.height / 2 &&
1406           priv->in_child == GTK_ARROW_UP)
1407         {
1408           priv->in_child = GTK_ARROW_DOWN;
1409           gtk_widget_queue_draw (GTK_WIDGET (spin));
1410         }
1411
1412       return FALSE;
1413     }
1414
1415   return GTK_WIDGET_CLASS (gtk_spin_button_parent_class)->motion_notify_event (widget, event);
1416 }
1417
1418 static gint
1419 gtk_spin_button_timer (GtkSpinButton *spin_button)
1420 {
1421   GtkSpinButtonPrivate *priv = spin_button->priv;
1422   gboolean retval = FALSE;
1423
1424   if (priv->timer)
1425     {
1426       if (priv->click_child == GTK_ARROW_UP)
1427         gtk_spin_button_real_spin (spin_button, priv->timer_step);
1428       else
1429         gtk_spin_button_real_spin (spin_button, -priv->timer_step);
1430
1431       if (priv->need_timer)
1432         {
1433           GtkSettings *settings = gtk_widget_get_settings (GTK_WIDGET (spin_button));
1434           guint        timeout;
1435
1436           g_object_get (settings, "gtk-timeout-repeat", &timeout, NULL);
1437
1438           priv->need_timer = FALSE;
1439           priv->timer = gdk_threads_add_timeout (timeout,
1440                                               (GSourceFunc) gtk_spin_button_timer,
1441                                               (gpointer) spin_button);
1442         }
1443       else
1444         {
1445           if (priv->climb_rate > 0.0 && priv->timer_step
1446               < gtk_adjustment_get_page_increment (priv->adjustment))
1447             {
1448               if (priv->timer_calls < MAX_TIMER_CALLS)
1449                 priv->timer_calls++;
1450               else
1451                 {
1452                   priv->timer_calls = 0;
1453                   priv->timer_step += priv->climb_rate;
1454                 }
1455             }
1456           retval = TRUE;
1457         }
1458     }
1459
1460   return retval;
1461 }
1462
1463 static void
1464 gtk_spin_button_value_changed (GtkAdjustment *adjustment,
1465                                GtkSpinButton *spin_button)
1466 {
1467   gboolean return_val;
1468
1469   g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
1470
1471   return_val = FALSE;
1472   g_signal_emit (spin_button, spinbutton_signals[OUTPUT], 0, &return_val);
1473   if (return_val == FALSE)
1474     gtk_spin_button_default_output (spin_button);
1475
1476   g_signal_emit (spin_button, spinbutton_signals[VALUE_CHANGED], 0);
1477
1478   gtk_widget_queue_draw (GTK_WIDGET (spin_button));
1479
1480   g_object_notify (G_OBJECT (spin_button), "value");
1481 }
1482
1483 static void
1484 gtk_spin_button_real_change_value (GtkSpinButton *spin,
1485                                    GtkScrollType  scroll)
1486 {
1487   GtkSpinButtonPrivate *priv = spin->priv;
1488   gdouble old_value;
1489
1490   /* When the key binding is activated, there may be an outstanding
1491    * value, so we first have to commit what is currently written in
1492    * the spin buttons text entry. See #106574
1493    */
1494   gtk_spin_button_update (spin);
1495
1496   old_value = gtk_adjustment_get_value (priv->adjustment);
1497
1498   /* We don't test whether the entry is editable, since
1499    * this key binding conceptually corresponds to changing
1500    * the value with the buttons using the mouse, which
1501    * we allow for non-editable spin buttons.
1502    */
1503   switch (scroll)
1504     {
1505     case GTK_SCROLL_STEP_BACKWARD:
1506     case GTK_SCROLL_STEP_DOWN:
1507     case GTK_SCROLL_STEP_LEFT:
1508       gtk_spin_button_real_spin (spin, -priv->timer_step);
1509
1510       if (priv->climb_rate > 0.0 && priv->timer_step
1511           < gtk_adjustment_get_page_increment (priv->adjustment))
1512         {
1513           if (priv->timer_calls < MAX_TIMER_CALLS)
1514             priv->timer_calls++;
1515           else
1516             {
1517               priv->timer_calls = 0;
1518               priv->timer_step += priv->climb_rate;
1519             }
1520         }
1521       break;
1522
1523     case GTK_SCROLL_STEP_FORWARD:
1524     case GTK_SCROLL_STEP_UP:
1525     case GTK_SCROLL_STEP_RIGHT:
1526       gtk_spin_button_real_spin (spin, priv->timer_step);
1527
1528       if (priv->climb_rate > 0.0 && priv->timer_step
1529           < gtk_adjustment_get_page_increment (priv->adjustment))
1530         {
1531           if (priv->timer_calls < MAX_TIMER_CALLS)
1532             priv->timer_calls++;
1533           else
1534             {
1535               priv->timer_calls = 0;
1536               priv->timer_step += priv->climb_rate;
1537             }
1538         }
1539       break;
1540
1541     case GTK_SCROLL_PAGE_BACKWARD:
1542     case GTK_SCROLL_PAGE_DOWN:
1543     case GTK_SCROLL_PAGE_LEFT:
1544       gtk_spin_button_real_spin (spin, -gtk_adjustment_get_page_increment (priv->adjustment));
1545       break;
1546
1547     case GTK_SCROLL_PAGE_FORWARD:
1548     case GTK_SCROLL_PAGE_UP:
1549     case GTK_SCROLL_PAGE_RIGHT:
1550       gtk_spin_button_real_spin (spin, gtk_adjustment_get_page_increment (priv->adjustment));
1551       break;
1552
1553     case GTK_SCROLL_START:
1554       {
1555         gdouble diff = gtk_adjustment_get_value (priv->adjustment) - gtk_adjustment_get_lower (priv->adjustment);
1556         if (diff > EPSILON)
1557           gtk_spin_button_real_spin (spin, -diff);
1558         break;
1559       }
1560
1561     case GTK_SCROLL_END:
1562       {
1563         gdouble diff = gtk_adjustment_get_upper (priv->adjustment) - gtk_adjustment_get_value (priv->adjustment);
1564         if (diff > EPSILON)
1565           gtk_spin_button_real_spin (spin, diff);
1566         break;
1567       }
1568
1569     default:
1570       g_warning ("Invalid scroll type %d for GtkSpinButton::change-value", scroll);
1571       break;
1572     }
1573
1574   gtk_spin_button_update (spin);
1575
1576   if (gtk_adjustment_get_value (priv->adjustment) == old_value)
1577     gtk_widget_error_bell (GTK_WIDGET (spin));
1578 }
1579
1580 static gint
1581 gtk_spin_button_key_release (GtkWidget   *widget,
1582                              GdkEventKey *event)
1583 {
1584   GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1585   GtkSpinButtonPrivate *priv = spin->priv;
1586
1587   /* We only get a release at the end of a key repeat run, so reset the timer_step */
1588   priv->timer_step = gtk_adjustment_get_step_increment (priv->adjustment);
1589   priv->timer_calls = 0;
1590
1591   return TRUE;
1592 }
1593
1594 static void
1595 gtk_spin_button_snap (GtkSpinButton *spin_button,
1596                       gdouble        val)
1597 {
1598   GtkSpinButtonPrivate *priv = spin_button->priv;
1599   gdouble inc;
1600   gdouble tmp;
1601
1602   inc = gtk_adjustment_get_step_increment (priv->adjustment);
1603   if (inc == 0)
1604     return;
1605
1606   tmp = (val - gtk_adjustment_get_lower (priv->adjustment)) / inc;
1607   if (tmp - floor (tmp) < ceil (tmp) - tmp)
1608     val = gtk_adjustment_get_lower (priv->adjustment) + floor (tmp) * inc;
1609   else
1610     val = gtk_adjustment_get_lower (priv->adjustment) + ceil (tmp) * inc;
1611
1612   gtk_spin_button_set_value (spin_button, val);
1613 }
1614
1615 static void
1616 gtk_spin_button_activate (GtkEntry *entry)
1617 {
1618   if (gtk_editable_get_editable (GTK_EDITABLE (entry)))
1619     gtk_spin_button_update (GTK_SPIN_BUTTON (entry));
1620
1621   /* Chain up so that entry->activates_default is honored */
1622   GTK_ENTRY_CLASS (gtk_spin_button_parent_class)->activate (entry);
1623 }
1624
1625 static void
1626 gtk_spin_button_get_text_area_size (GtkEntry *entry,
1627                                     gint     *x,
1628                                     gint     *y,
1629                                     gint     *width,
1630                                     gint     *height)
1631 {
1632   GtkStyleContext *context;
1633   GtkStateFlags state;
1634   GtkWidget *widget;
1635   GtkBorder padding;
1636   gint arrow_size;
1637   gint panel_width;
1638
1639   GTK_ENTRY_CLASS (gtk_spin_button_parent_class)->get_text_area_size (entry, x, y, width, height);
1640
1641   widget = GTK_WIDGET (entry);
1642   state = gtk_widget_get_state_flags (widget);
1643   context = gtk_widget_get_style_context (widget);
1644   gtk_style_context_get_padding (context, state, &padding);
1645
1646   arrow_size = spin_button_get_arrow_size (GTK_SPIN_BUTTON (entry));
1647   panel_width = arrow_size + padding.left + padding.right;
1648
1649   if (width)
1650     *width -= panel_width;
1651
1652   if (gtk_widget_get_direction (GTK_WIDGET (entry)) == GTK_TEXT_DIR_RTL && x)
1653     *x += panel_width;
1654 }
1655
1656 static void
1657 gtk_spin_button_insert_text (GtkEditable *editable,
1658                              const gchar *new_text,
1659                              gint         new_text_length,
1660                              gint        *position)
1661 {
1662   GtkEntry *entry = GTK_ENTRY (editable);
1663   GtkSpinButton *spin = GTK_SPIN_BUTTON (editable);
1664   GtkSpinButtonPrivate *priv = spin->priv;
1665   GtkEditableInterface *parent_editable_iface;
1666
1667   parent_editable_iface = g_type_interface_peek (gtk_spin_button_parent_class,
1668                                                  GTK_TYPE_EDITABLE);
1669
1670   if (priv->numeric)
1671     {
1672       struct lconv *lc;
1673       gboolean sign;
1674       gint dotpos = -1;
1675       gint i;
1676       guint32 pos_sign;
1677       guint32 neg_sign;
1678       gint entry_length;
1679       const gchar *entry_text;
1680
1681       entry_length = gtk_entry_get_text_length (entry);
1682       entry_text = gtk_entry_get_text (entry);
1683
1684       lc = localeconv ();
1685
1686       if (*(lc->negative_sign))
1687         neg_sign = *(lc->negative_sign);
1688       else
1689         neg_sign = '-';
1690
1691       if (*(lc->positive_sign))
1692         pos_sign = *(lc->positive_sign);
1693       else
1694         pos_sign = '+';
1695
1696 #ifdef G_OS_WIN32
1697       /* Workaround for bug caused by some Windows application messing
1698        * up the positive sign of the current locale, more specifically
1699        * HKEY_CURRENT_USER\Control Panel\International\sPositiveSign.
1700        * See bug #330743 and for instance
1701        * http://www.msnewsgroups.net/group/microsoft.public.dotnet.languages.csharp/topic36024.aspx
1702        *
1703        * I don't know if the positive sign always gets bogusly set to
1704        * a digit when the above Registry value is corrupted as
1705        * described. (In my test case, it got set to "8", and in the
1706        * bug report above it presumably was set ot "0".) Probably it
1707        * might get set to almost anything? So how to distinguish a
1708        * bogus value from some correct one for some locale? That is
1709        * probably hard, but at least we should filter out the
1710        * digits...
1711        */
1712       if (pos_sign >= '0' && pos_sign <= '9')
1713         pos_sign = '+';
1714 #endif
1715
1716       for (sign=0, i=0; i<entry_length; i++)
1717         if ((entry_text[i] == neg_sign) ||
1718             (entry_text[i] == pos_sign))
1719           {
1720             sign = 1;
1721             break;
1722           }
1723
1724       if (sign && !(*position))
1725         return;
1726
1727       for (dotpos=-1, i=0; i<entry_length; i++)
1728         if (entry_text[i] == *(lc->decimal_point))
1729           {
1730             dotpos = i;
1731             break;
1732           }
1733
1734       if (dotpos > -1 && *position > dotpos &&
1735           (gint)priv->digits - entry_length
1736             + dotpos - new_text_length + 1 < 0)
1737         return;
1738
1739       for (i = 0; i < new_text_length; i++)
1740         {
1741           if (new_text[i] == neg_sign || new_text[i] == pos_sign)
1742             {
1743               if (sign || (*position) || i)
1744                 return;
1745               sign = TRUE;
1746             }
1747           else if (new_text[i] == *(lc->decimal_point))
1748             {
1749               if (!priv->digits || dotpos > -1 ||
1750                   (new_text_length - 1 - i + entry_length
1751                     - *position > (gint)priv->digits))
1752                 return;
1753               dotpos = *position + i;
1754             }
1755           else if (new_text[i] < 0x30 || new_text[i] > 0x39)
1756             return;
1757         }
1758     }
1759
1760   parent_editable_iface->insert_text (editable, new_text,
1761                                       new_text_length, position);
1762 }
1763
1764 static void
1765 gtk_spin_button_real_spin (GtkSpinButton *spin_button,
1766                            gdouble        increment)
1767 {
1768   GtkSpinButtonPrivate *priv = spin_button->priv;
1769   GtkAdjustment *adjustment;
1770   gdouble new_value = 0.0;
1771   gboolean wrapped = FALSE;
1772
1773   adjustment = priv->adjustment;
1774
1775   new_value = gtk_adjustment_get_value (adjustment) + increment;
1776
1777   if (increment > 0)
1778     {
1779       if (priv->wrap)
1780         {
1781           if (fabs (gtk_adjustment_get_value (adjustment) - gtk_adjustment_get_upper (adjustment)) < EPSILON)
1782             {
1783               new_value = gtk_adjustment_get_lower (adjustment);
1784               wrapped = TRUE;
1785             }
1786           else if (new_value > gtk_adjustment_get_upper (adjustment))
1787             new_value = gtk_adjustment_get_upper (adjustment);
1788         }
1789       else
1790         new_value = MIN (new_value, gtk_adjustment_get_upper (adjustment));
1791     }
1792   else if (increment < 0)
1793     {
1794       if (priv->wrap)
1795         {
1796           if (fabs (gtk_adjustment_get_value (adjustment) - gtk_adjustment_get_lower (adjustment)) < EPSILON)
1797             {
1798               new_value = gtk_adjustment_get_upper (adjustment);
1799               wrapped = TRUE;
1800             }
1801           else if (new_value < gtk_adjustment_get_lower (adjustment))
1802             new_value = gtk_adjustment_get_lower (adjustment);
1803         }
1804       else
1805         new_value = MAX (new_value, gtk_adjustment_get_lower (adjustment));
1806     }
1807
1808   if (fabs (new_value - gtk_adjustment_get_value (adjustment)) > EPSILON)
1809     gtk_adjustment_set_value (adjustment, new_value);
1810
1811   if (wrapped)
1812     g_signal_emit (spin_button, spinbutton_signals[WRAPPED], 0);
1813
1814   gtk_widget_queue_draw (GTK_WIDGET (spin_button));
1815 }
1816
1817 static gint
1818 gtk_spin_button_default_input (GtkSpinButton *spin_button,
1819                                gdouble       *new_val)
1820 {
1821   gchar *err = NULL;
1822
1823   *new_val = g_strtod (gtk_entry_get_text (GTK_ENTRY (spin_button)), &err);
1824   if (*err)
1825     return GTK_INPUT_ERROR;
1826   else
1827     return FALSE;
1828 }
1829
1830 static gint
1831 gtk_spin_button_default_output (GtkSpinButton *spin_button)
1832 {
1833   GtkSpinButtonPrivate *priv = spin_button->priv;
1834
1835   gchar *buf = g_strdup_printf ("%0.*f", priv->digits, gtk_adjustment_get_value (priv->adjustment));
1836
1837   if (strcmp (buf, gtk_entry_get_text (GTK_ENTRY (spin_button))))
1838     gtk_entry_set_text (GTK_ENTRY (spin_button), buf);
1839   g_free (buf);
1840   return FALSE;
1841 }
1842
1843
1844 /***********************************************************
1845  ***********************************************************
1846  ***                  Public interface                   ***
1847  ***********************************************************
1848  ***********************************************************/
1849
1850
1851 /**
1852  * gtk_spin_button_configure:
1853  * @spin_button: a #GtkSpinButton
1854  * @adjustment: (allow-none):  a #GtkAdjustment
1855  * @climb_rate: the new climb rate
1856  * @digits: the number of decimal places to display in the spin button
1857  *
1858  * Changes the properties of an existing spin button. The adjustment,
1859  * climb rate, and number of decimal places are all changed accordingly,
1860  * after this function call.
1861  */
1862 void
1863 gtk_spin_button_configure (GtkSpinButton *spin_button,
1864                            GtkAdjustment *adjustment,
1865                            gdouble        climb_rate,
1866                            guint          digits)
1867 {
1868   GtkSpinButtonPrivate *priv;
1869
1870   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
1871
1872   priv = spin_button->priv;
1873
1874   if (adjustment)
1875     gtk_spin_button_set_adjustment (spin_button, adjustment);
1876   else
1877     adjustment = priv->adjustment;
1878
1879   g_object_freeze_notify (G_OBJECT (spin_button));
1880   if (priv->digits != digits)
1881     {
1882       priv->digits = digits;
1883       g_object_notify (G_OBJECT (spin_button), "digits");
1884     }
1885
1886   if (priv->climb_rate != climb_rate)
1887     {
1888       priv->climb_rate = climb_rate;
1889       g_object_notify (G_OBJECT (spin_button), "climb-rate");
1890     }
1891   g_object_thaw_notify (G_OBJECT (spin_button));
1892
1893   gtk_adjustment_value_changed (adjustment);
1894 }
1895
1896 /**
1897  * gtk_spin_button_new:
1898  * @adjustment: (allow-none): the #GtkAdjustment object that this spin
1899  *     button should use, or %NULL
1900  * @climb_rate: specifies how much the spin button changes when an arrow
1901  *     is clicked on
1902  * @digits: the number of decimal places to display
1903  *
1904  * Creates a new #GtkSpinButton.
1905  *
1906  * Returns: The new spin button as a #GtkWidget
1907  */
1908 GtkWidget *
1909 gtk_spin_button_new (GtkAdjustment *adjustment,
1910                      gdouble        climb_rate,
1911                      guint          digits)
1912 {
1913   GtkSpinButton *spin;
1914
1915   if (adjustment)
1916     g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), NULL);
1917
1918   spin = g_object_new (GTK_TYPE_SPIN_BUTTON, NULL);
1919
1920   gtk_spin_button_configure (spin, adjustment, climb_rate, digits);
1921
1922   return GTK_WIDGET (spin);
1923 }
1924
1925 /**
1926  * gtk_spin_button_new_with_range:
1927  * @min: Minimum allowable value
1928  * @max: Maximum allowable value
1929  * @step: Increment added or subtracted by spinning the widget
1930  *
1931  * This is a convenience constructor that allows creation of a numeric
1932  * #GtkSpinButton without manually creating an adjustment. The value is
1933  * initially set to the minimum value and a page increment of 10 * @step
1934  * is the default. The precision of the spin button is equivalent to the
1935  * precision of @step.
1936  *
1937  * Note that the way in which the precision is derived works best if @step
1938  * is a power of ten. If the resulting precision is not suitable for your
1939  * needs, use gtk_spin_button_set_digits() to correct it.
1940  *
1941  * Return value: The new spin button as a #GtkWidget
1942  */
1943 GtkWidget *
1944 gtk_spin_button_new_with_range (gdouble min,
1945                                 gdouble max,
1946                                 gdouble step)
1947 {
1948   GtkAdjustment *adjustment;
1949   GtkSpinButton *spin;
1950   gint digits;
1951
1952   g_return_val_if_fail (min <= max, NULL);
1953   g_return_val_if_fail (step != 0.0, NULL);
1954
1955   spin = g_object_new (GTK_TYPE_SPIN_BUTTON, NULL);
1956
1957   adjustment = gtk_adjustment_new (min, min, max, step, 10 * step, 0);
1958
1959   if (fabs (step) >= 1.0 || step == 0.0)
1960     digits = 0;
1961   else {
1962     digits = abs ((gint) floor (log10 (fabs (step))));
1963     if (digits > MAX_DIGITS)
1964       digits = MAX_DIGITS;
1965   }
1966
1967   gtk_spin_button_configure (spin, adjustment, step, digits);
1968
1969   gtk_spin_button_set_numeric (spin, TRUE);
1970
1971   return GTK_WIDGET (spin);
1972 }
1973
1974 /* Callback used when the spin button's adjustment changes.
1975  * We need to redraw the arrows when the adjustment's range
1976  * changes, and reevaluate our size request.
1977  */
1978 static void
1979 adjustment_changed_cb (GtkAdjustment *adjustment, gpointer data)
1980 {
1981   GtkSpinButton *spin_button = GTK_SPIN_BUTTON (data);
1982   GtkSpinButtonPrivate *priv = spin_button->priv;
1983
1984   priv->timer_step = gtk_adjustment_get_step_increment (priv->adjustment);
1985   gtk_widget_queue_resize (GTK_WIDGET (spin_button));
1986 }
1987
1988 /**
1989  * gtk_spin_button_set_adjustment:
1990  * @spin_button: a #GtkSpinButton
1991  * @adjustment: a #GtkAdjustment to replace the existing adjustment
1992  *
1993  * Replaces the #GtkAdjustment associated with @spin_button.
1994  */
1995 void
1996 gtk_spin_button_set_adjustment (GtkSpinButton *spin_button,
1997                                 GtkAdjustment *adjustment)
1998 {
1999   GtkSpinButtonPrivate *priv;
2000
2001   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2002
2003   priv = spin_button->priv;
2004
2005   if (priv->adjustment != adjustment)
2006     {
2007       if (priv->adjustment)
2008         {
2009           g_signal_handlers_disconnect_by_func (priv->adjustment,
2010                                                 gtk_spin_button_value_changed,
2011                                                 spin_button);
2012           g_signal_handlers_disconnect_by_func (priv->adjustment,
2013                                                 adjustment_changed_cb,
2014                                                 spin_button);
2015           g_object_unref (priv->adjustment);
2016         }
2017       priv->adjustment = adjustment;
2018       if (adjustment)
2019         {
2020           g_object_ref_sink (adjustment);
2021           g_signal_connect (adjustment, "value-changed",
2022                             G_CALLBACK (gtk_spin_button_value_changed),
2023                             spin_button);
2024           g_signal_connect (adjustment, "changed",
2025                             G_CALLBACK (adjustment_changed_cb),
2026                             spin_button);
2027           priv->timer_step = gtk_adjustment_get_step_increment (priv->adjustment);
2028         }
2029
2030       gtk_widget_queue_resize (GTK_WIDGET (spin_button));
2031     }
2032
2033   g_object_notify (G_OBJECT (spin_button), "adjustment");
2034 }
2035
2036 /**
2037  * gtk_spin_button_get_adjustment:
2038  * @spin_button: a #GtkSpinButton
2039  *
2040  * Get the adjustment associated with a #GtkSpinButton
2041  *
2042  * Return value: (transfer none): the #GtkAdjustment of @spin_button
2043  **/
2044 GtkAdjustment *
2045 gtk_spin_button_get_adjustment (GtkSpinButton *spin_button)
2046 {
2047   g_return_val_if_fail (GTK_IS_SPIN_BUTTON (spin_button), NULL);
2048
2049   return spin_button->priv->adjustment;
2050 }
2051
2052 /**
2053  * gtk_spin_button_set_digits:
2054  * @spin_button: a #GtkSpinButton
2055  * @digits: the number of digits after the decimal point to be displayed for the spin button's value
2056  *
2057  * Set the precision to be displayed by @spin_button. Up to 20 digit precision
2058  * is allowed.
2059  **/
2060 void
2061 gtk_spin_button_set_digits (GtkSpinButton *spin_button,
2062                             guint          digits)
2063 {
2064   GtkSpinButtonPrivate *priv;
2065
2066   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2067
2068   priv = spin_button->priv;
2069
2070   if (priv->digits != digits)
2071     {
2072       priv->digits = digits;
2073       gtk_spin_button_value_changed (priv->adjustment, spin_button);
2074       g_object_notify (G_OBJECT (spin_button), "digits");
2075
2076       /* since lower/upper may have changed */
2077       gtk_widget_queue_resize (GTK_WIDGET (spin_button));
2078     }
2079 }
2080
2081 /**
2082  * gtk_spin_button_get_digits:
2083  * @spin_button: a #GtkSpinButton
2084  *
2085  * Fetches the precision of @spin_button. See gtk_spin_button_set_digits().
2086  *
2087  * Returns: the current precision
2088  **/
2089 guint
2090 gtk_spin_button_get_digits (GtkSpinButton *spin_button)
2091 {
2092   g_return_val_if_fail (GTK_IS_SPIN_BUTTON (spin_button), 0);
2093
2094   return spin_button->priv->digits;
2095 }
2096
2097 /**
2098  * gtk_spin_button_set_increments:
2099  * @spin_button: a #GtkSpinButton
2100  * @step: increment applied for a button 1 press.
2101  * @page: increment applied for a button 2 press.
2102  *
2103  * Sets the step and page increments for spin_button.  This affects how
2104  * quickly the value changes when the spin button's arrows are activated.
2105  **/
2106 void
2107 gtk_spin_button_set_increments (GtkSpinButton *spin_button,
2108                                 gdouble        step,
2109                                 gdouble        page)
2110 {
2111   GtkSpinButtonPrivate *priv;
2112
2113   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2114
2115   priv = spin_button->priv;
2116
2117   gtk_adjustment_configure (priv->adjustment,
2118                             gtk_adjustment_get_value (priv->adjustment),
2119                             gtk_adjustment_get_lower (priv->adjustment),
2120                             gtk_adjustment_get_upper (priv->adjustment),
2121                             step,
2122                             page,
2123                             gtk_adjustment_get_page_size (priv->adjustment));
2124 }
2125
2126 /**
2127  * gtk_spin_button_get_increments:
2128  * @spin_button: a #GtkSpinButton
2129  * @step: (out) (allow-none): location to store step increment, or %NULL
2130  * @page: (out) (allow-none): location to store page increment, or %NULL
2131  *
2132  * Gets the current step and page the increments used by @spin_button. See
2133  * gtk_spin_button_set_increments().
2134  **/
2135 void
2136 gtk_spin_button_get_increments (GtkSpinButton *spin_button,
2137                                 gdouble       *step,
2138                                 gdouble       *page)
2139 {
2140   GtkSpinButtonPrivate *priv;
2141
2142   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2143
2144   priv = spin_button->priv;
2145
2146   if (step)
2147     *step = gtk_adjustment_get_step_increment (priv->adjustment);
2148   if (page)
2149     *page = gtk_adjustment_get_page_increment (priv->adjustment);
2150 }
2151
2152 /**
2153  * gtk_spin_button_set_range:
2154  * @spin_button: a #GtkSpinButton
2155  * @min: minimum allowable value
2156  * @max: maximum allowable value
2157  *
2158  * Sets the minimum and maximum allowable values for @spin_button.
2159  */
2160 void
2161 gtk_spin_button_set_range (GtkSpinButton *spin_button,
2162                            gdouble        min,
2163                            gdouble        max)
2164 {
2165   GtkAdjustment *adjustment;
2166
2167   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2168
2169   adjustment = spin_button->priv->adjustment;
2170
2171   gtk_adjustment_configure (adjustment,
2172                             CLAMP (gtk_adjustment_get_value (adjustment), min, max),
2173                             min,
2174                             max,
2175                             gtk_adjustment_get_step_increment (adjustment),
2176                             gtk_adjustment_get_page_increment (adjustment),
2177                             gtk_adjustment_get_page_size (adjustment));
2178 }
2179
2180 /**
2181  * gtk_spin_button_get_range:
2182  * @spin_button: a #GtkSpinButton
2183  * @min: (out) (allow-none): location to store minimum allowed value, or %NULL
2184  * @max: (out) (allow-none): location to store maximum allowed value, or %NULL
2185  *
2186  * Gets the range allowed for @spin_button.
2187  * See gtk_spin_button_set_range().
2188  */
2189 void
2190 gtk_spin_button_get_range (GtkSpinButton *spin_button,
2191                            gdouble       *min,
2192                            gdouble       *max)
2193 {
2194   GtkSpinButtonPrivate *priv;
2195
2196   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2197
2198   priv = spin_button->priv;
2199
2200   if (min)
2201     *min = gtk_adjustment_get_lower (priv->adjustment);
2202   if (max)
2203     *max = gtk_adjustment_get_upper (priv->adjustment);
2204 }
2205
2206 /**
2207  * gtk_spin_button_get_value:
2208  * @spin_button: a #GtkSpinButton
2209  *
2210  * Get the value in the @spin_button.
2211  *
2212  * Return value: the value of @spin_button
2213  */
2214 gdouble
2215 gtk_spin_button_get_value (GtkSpinButton *spin_button)
2216 {
2217   g_return_val_if_fail (GTK_IS_SPIN_BUTTON (spin_button), 0.0);
2218
2219   return gtk_adjustment_get_value (spin_button->priv->adjustment);
2220 }
2221
2222 /**
2223  * gtk_spin_button_get_value_as_int:
2224  * @spin_button: a #GtkSpinButton
2225  *
2226  * Get the value @spin_button represented as an integer.
2227  *
2228  * Return value: the value of @spin_button
2229  */
2230 gint
2231 gtk_spin_button_get_value_as_int (GtkSpinButton *spin_button)
2232 {
2233   GtkSpinButtonPrivate *priv;
2234   gdouble val;
2235
2236   g_return_val_if_fail (GTK_IS_SPIN_BUTTON (spin_button), 0);
2237
2238   priv = spin_button->priv;
2239
2240   val = gtk_adjustment_get_value (priv->adjustment);
2241   if (val - floor (val) < ceil (val) - val)
2242     return floor (val);
2243   else
2244     return ceil (val);
2245 }
2246
2247 /**
2248  * gtk_spin_button_set_value:
2249  * @spin_button: a #GtkSpinButton
2250  * @value: the new value
2251  *
2252  * Sets the value of @spin_button.
2253  */
2254 void
2255 gtk_spin_button_set_value (GtkSpinButton *spin_button,
2256                            gdouble        value)
2257 {
2258   GtkSpinButtonPrivate *priv;
2259
2260   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2261
2262   priv = spin_button->priv;
2263
2264   if (fabs (value - gtk_adjustment_get_value (priv->adjustment)) > EPSILON)
2265     gtk_adjustment_set_value (priv->adjustment, value);
2266   else
2267     {
2268       gint return_val = FALSE;
2269       g_signal_emit (spin_button, spinbutton_signals[OUTPUT], 0, &return_val);
2270       if (return_val == FALSE)
2271         gtk_spin_button_default_output (spin_button);
2272     }
2273 }
2274
2275 /**
2276  * gtk_spin_button_set_update_policy:
2277  * @spin_button: a #GtkSpinButton
2278  * @policy: a #GtkSpinButtonUpdatePolicy value
2279  *
2280  * Sets the update behavior of a spin button.
2281  * This determines wether the spin button is always updated
2282  * or only when a valid value is set.
2283  */
2284 void
2285 gtk_spin_button_set_update_policy (GtkSpinButton             *spin_button,
2286                                    GtkSpinButtonUpdatePolicy  policy)
2287 {
2288   GtkSpinButtonPrivate *priv;
2289
2290   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2291
2292   priv = spin_button->priv;
2293
2294   if (priv->update_policy != policy)
2295     {
2296       priv->update_policy = policy;
2297       g_object_notify (G_OBJECT (spin_button), "update-policy");
2298     }
2299 }
2300
2301 /**
2302  * gtk_spin_button_get_update_policy:
2303  * @spin_button: a #GtkSpinButton
2304  *
2305  * Gets the update behavior of a spin button.
2306  * See gtk_spin_button_set_update_policy().
2307  *
2308  * Return value: the current update policy
2309  */
2310 GtkSpinButtonUpdatePolicy
2311 gtk_spin_button_get_update_policy (GtkSpinButton *spin_button)
2312 {
2313   g_return_val_if_fail (GTK_IS_SPIN_BUTTON (spin_button), GTK_UPDATE_ALWAYS);
2314
2315   return spin_button->priv->update_policy;
2316 }
2317
2318 /**
2319  * gtk_spin_button_set_numeric:
2320  * @spin_button: a #GtkSpinButton
2321  * @numeric: flag indicating if only numeric entry is allowed
2322  *
2323  * Sets the flag that determines if non-numeric text can be typed
2324  * into the spin button.
2325  */
2326 void
2327 gtk_spin_button_set_numeric (GtkSpinButton *spin_button,
2328                              gboolean       numeric)
2329 {
2330   GtkSpinButtonPrivate *priv;
2331
2332   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2333
2334   priv = spin_button->priv;
2335
2336   numeric = numeric != FALSE;
2337
2338   if (priv->numeric != numeric)
2339     {
2340        priv->numeric = numeric;
2341        g_object_notify (G_OBJECT (spin_button), "numeric");
2342     }
2343 }
2344
2345 /**
2346  * gtk_spin_button_get_numeric:
2347  * @spin_button: a #GtkSpinButton
2348  *
2349  * Returns whether non-numeric text can be typed into the spin button.
2350  * See gtk_spin_button_set_numeric().
2351  *
2352  * Return value: %TRUE if only numeric text can be entered
2353  */
2354 gboolean
2355 gtk_spin_button_get_numeric (GtkSpinButton *spin_button)
2356 {
2357   g_return_val_if_fail (GTK_IS_SPIN_BUTTON (spin_button), FALSE);
2358
2359   return spin_button->priv->numeric;
2360 }
2361
2362 /**
2363  * gtk_spin_button_set_wrap:
2364  * @spin_button: a #GtkSpinButton
2365  * @wrap: a flag indicating if wrapping behavior is performed
2366  *
2367  * Sets the flag that determines if a spin button value wraps
2368  * around to the opposite limit when the upper or lower limit
2369  * of the range is exceeded.
2370  */
2371 void
2372 gtk_spin_button_set_wrap (GtkSpinButton  *spin_button,
2373                           gboolean        wrap)
2374 {
2375   GtkSpinButtonPrivate *priv;
2376
2377   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2378
2379   priv = spin_button->priv;
2380
2381   wrap = wrap != FALSE;
2382
2383   if (priv->wrap != wrap)
2384     {
2385        priv->wrap = wrap;
2386
2387        g_object_notify (G_OBJECT (spin_button), "wrap");
2388     }
2389 }
2390
2391 /**
2392  * gtk_spin_button_get_wrap:
2393  * @spin_button: a #GtkSpinButton
2394  *
2395  * Returns whether the spin button's value wraps around to the
2396  * opposite limit when the upper or lower limit of the range is
2397  * exceeded. See gtk_spin_button_set_wrap().
2398  *
2399  * Return value: %TRUE if the spin button wraps around
2400  */
2401 gboolean
2402 gtk_spin_button_get_wrap (GtkSpinButton *spin_button)
2403 {
2404   g_return_val_if_fail (GTK_IS_SPIN_BUTTON (spin_button), FALSE);
2405
2406   return spin_button->priv->wrap;
2407 }
2408
2409 static gint
2410 spin_button_get_arrow_size (GtkSpinButton *spin_button)
2411 {
2412   const PangoFontDescription *font_desc;
2413   GtkStyleContext *context;
2414   gint size;
2415   gint arrow_size;
2416
2417   /* FIXME: use getter */
2418   context = gtk_widget_get_style_context (GTK_WIDGET (spin_button));
2419   font_desc = gtk_style_context_get_font (context, 0);
2420
2421   size = pango_font_description_get_size (font_desc);
2422   arrow_size = MAX (PANGO_PIXELS (size), MIN_ARROW_WIDTH);
2423
2424   return arrow_size - arrow_size % 2; /* force even */
2425 }
2426
2427 /**
2428  * gtk_spin_button_set_snap_to_ticks:
2429  * @spin_button: a #GtkSpinButton
2430  * @snap_to_ticks: a flag indicating if invalid values should be corrected
2431  *
2432  * Sets the policy as to whether values are corrected to the
2433  * nearest step increment when a spin button is activated after
2434  * providing an invalid value.
2435  */
2436 void
2437 gtk_spin_button_set_snap_to_ticks (GtkSpinButton *spin_button,
2438                                    gboolean       snap_to_ticks)
2439 {
2440   GtkSpinButtonPrivate *priv;
2441   guint new_val;
2442
2443   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2444
2445   priv = spin_button->priv;
2446
2447   new_val = (snap_to_ticks != 0);
2448
2449   if (new_val != priv->snap_to_ticks)
2450     {
2451       priv->snap_to_ticks = new_val;
2452       if (new_val && gtk_editable_get_editable (GTK_EDITABLE (spin_button)))
2453         gtk_spin_button_update (spin_button);
2454
2455       g_object_notify (G_OBJECT (spin_button), "snap-to-ticks");
2456     }
2457 }
2458
2459 /**
2460  * gtk_spin_button_get_snap_to_ticks:
2461  * @spin_button: a #GtkSpinButton
2462  *
2463  * Returns whether the values are corrected to the nearest step.
2464  * See gtk_spin_button_set_snap_to_ticks().
2465  *
2466  * Return value: %TRUE if values are snapped to the nearest step
2467  */
2468 gboolean
2469 gtk_spin_button_get_snap_to_ticks (GtkSpinButton *spin_button)
2470 {
2471   g_return_val_if_fail (GTK_IS_SPIN_BUTTON (spin_button), FALSE);
2472
2473   return spin_button->priv->snap_to_ticks;
2474 }
2475
2476 /**
2477  * gtk_spin_button_spin:
2478  * @spin_button: a #GtkSpinButton
2479  * @direction: a #GtkSpinType indicating the direction to spin
2480  * @increment: step increment to apply in the specified direction
2481  *
2482  * Increment or decrement a spin button's value in a specified
2483  * direction by a specified amount.
2484  */
2485 void
2486 gtk_spin_button_spin (GtkSpinButton *spin_button,
2487                       GtkSpinType    direction,
2488                       gdouble        increment)
2489 {
2490   GtkSpinButtonPrivate *priv;
2491   GtkAdjustment *adjustment;
2492   gdouble diff;
2493
2494   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2495
2496   priv = spin_button->priv;
2497
2498   adjustment = priv->adjustment;
2499
2500   /* for compatibility with the 1.0.x version of this function */
2501   if (increment != 0 && increment != gtk_adjustment_get_step_increment (adjustment) &&
2502       (direction == GTK_SPIN_STEP_FORWARD ||
2503        direction == GTK_SPIN_STEP_BACKWARD))
2504     {
2505       if (direction == GTK_SPIN_STEP_BACKWARD && increment > 0)
2506         increment = -increment;
2507       direction = GTK_SPIN_USER_DEFINED;
2508     }
2509
2510   switch (direction)
2511     {
2512     case GTK_SPIN_STEP_FORWARD:
2513
2514       gtk_spin_button_real_spin (spin_button, gtk_adjustment_get_step_increment (adjustment));
2515       break;
2516
2517     case GTK_SPIN_STEP_BACKWARD:
2518
2519       gtk_spin_button_real_spin (spin_button, -gtk_adjustment_get_step_increment (adjustment));
2520       break;
2521
2522     case GTK_SPIN_PAGE_FORWARD:
2523
2524       gtk_spin_button_real_spin (spin_button, gtk_adjustment_get_page_increment (adjustment));
2525       break;
2526
2527     case GTK_SPIN_PAGE_BACKWARD:
2528
2529       gtk_spin_button_real_spin (spin_button, -gtk_adjustment_get_page_increment (adjustment));
2530       break;
2531
2532     case GTK_SPIN_HOME:
2533
2534       diff = gtk_adjustment_get_value (adjustment) - gtk_adjustment_get_lower (adjustment);
2535       if (diff > EPSILON)
2536         gtk_spin_button_real_spin (spin_button, -diff);
2537       break;
2538
2539     case GTK_SPIN_END:
2540
2541       diff = gtk_adjustment_get_upper (adjustment) - gtk_adjustment_get_value (adjustment);
2542       if (diff > EPSILON)
2543         gtk_spin_button_real_spin (spin_button, diff);
2544       break;
2545
2546     case GTK_SPIN_USER_DEFINED:
2547
2548       if (increment != 0)
2549         gtk_spin_button_real_spin (spin_button, increment);
2550       break;
2551
2552     default:
2553       break;
2554     }
2555 }
2556
2557 /**
2558  * gtk_spin_button_update:
2559  * @spin_button: a #GtkSpinButton
2560  *
2561  * Manually force an update of the spin button.
2562  */
2563 void
2564 gtk_spin_button_update (GtkSpinButton *spin_button)
2565 {
2566   GtkSpinButtonPrivate *priv;
2567   gdouble val;
2568   gint error = 0;
2569   gint return_val;
2570
2571   g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2572
2573   priv = spin_button->priv;
2574
2575   return_val = FALSE;
2576   g_signal_emit (spin_button, spinbutton_signals[INPUT], 0, &val, &return_val);
2577   if (return_val == FALSE)
2578     {
2579       return_val = gtk_spin_button_default_input (spin_button, &val);
2580       error = (return_val == GTK_INPUT_ERROR);
2581     }
2582   else if (return_val == GTK_INPUT_ERROR)
2583     error = 1;
2584
2585   gtk_widget_queue_draw (GTK_WIDGET (spin_button));
2586
2587   if (priv->update_policy == GTK_UPDATE_ALWAYS)
2588     {
2589       if (val < gtk_adjustment_get_lower (priv->adjustment))
2590         val = gtk_adjustment_get_lower (priv->adjustment);
2591       else if (val > gtk_adjustment_get_upper (priv->adjustment))
2592         val = gtk_adjustment_get_upper (priv->adjustment);
2593     }
2594   else if ((priv->update_policy == GTK_UPDATE_IF_VALID) &&
2595            (error ||
2596             val < gtk_adjustment_get_lower (priv->adjustment) ||
2597             val > gtk_adjustment_get_upper (priv->adjustment)))
2598     {
2599       gtk_spin_button_value_changed (priv->adjustment, spin_button);
2600       return;
2601     }
2602
2603   if (priv->snap_to_ticks)
2604     gtk_spin_button_snap (spin_button, val);
2605   else
2606     gtk_spin_button_set_value (spin_button, val);
2607 }
2608
2609 GdkWindow *
2610 _gtk_spin_button_get_panel (GtkSpinButton *spin_button)
2611 {
2612   return spin_button->priv->panel;
2613 }