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