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