1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * GtkSpinButton widget for GTK+
5 * Copyright (C) 1998 Lars Hamann and Stefan Jeske
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.
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.
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.
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/.
36 #include "gdk/gdkkeysyms.h"
37 #include "gtkbindings.h"
38 #include "gtkspinbutton.h"
40 #include "gtkmarshalers.h"
41 #include "gtksettings.h"
44 #define MIN_SPIN_BUTTON_WIDTH 30
45 #define SPIN_BUTTON_INITIAL_TIMER_DELAY 200
46 #define SPIN_BUTTON_TIMER_DELAY 20
47 #define MAX_TIMER_CALLS 5
50 #define MIN_ARROW_WIDTH 6
74 static void gtk_spin_button_class_init (GtkSpinButtonClass *klass);
75 static void gtk_spin_button_editable_init (GtkEditableClass *iface);
76 static void gtk_spin_button_init (GtkSpinButton *spin_button);
77 static void gtk_spin_button_finalize (GObject *object);
78 static void gtk_spin_button_destroy (GtkObject *object);
79 static void gtk_spin_button_set_property (GObject *object,
83 static void gtk_spin_button_get_property (GObject *object,
87 static void gtk_spin_button_map (GtkWidget *widget);
88 static void gtk_spin_button_unmap (GtkWidget *widget);
89 static void gtk_spin_button_realize (GtkWidget *widget);
90 static void gtk_spin_button_unrealize (GtkWidget *widget);
91 static void gtk_spin_button_size_request (GtkWidget *widget,
92 GtkRequisition *requisition);
93 static void gtk_spin_button_size_allocate (GtkWidget *widget,
94 GtkAllocation *allocation);
95 static gint gtk_spin_button_expose (GtkWidget *widget,
96 GdkEventExpose *event);
97 static gint gtk_spin_button_button_press (GtkWidget *widget,
98 GdkEventButton *event);
99 static gint gtk_spin_button_button_release (GtkWidget *widget,
100 GdkEventButton *event);
101 static gint gtk_spin_button_motion_notify (GtkWidget *widget,
102 GdkEventMotion *event);
103 static gint gtk_spin_button_enter_notify (GtkWidget *widget,
104 GdkEventCrossing *event);
105 static gint gtk_spin_button_leave_notify (GtkWidget *widget,
106 GdkEventCrossing *event);
107 static gint gtk_spin_button_focus_out (GtkWidget *widget,
108 GdkEventFocus *event);
109 static void gtk_spin_button_grab_notify (GtkWidget *widget,
110 gboolean was_grabbed);
111 static void gtk_spin_button_state_changed (GtkWidget *widget,
112 GtkStateType previous_state);
113 static void gtk_spin_button_draw_arrow (GtkSpinButton *spin_button,
114 GtkArrowType arrow_type);
115 static gint gtk_spin_button_timer (GtkSpinButton *spin_button);
116 static void gtk_spin_button_stop_spinning (GtkSpinButton *spin);
117 static void gtk_spin_button_value_changed (GtkAdjustment *adjustment,
118 GtkSpinButton *spin_button);
119 static gint gtk_spin_button_key_release (GtkWidget *widget,
121 static gint gtk_spin_button_scroll (GtkWidget *widget,
122 GdkEventScroll *event);
123 static void gtk_spin_button_activate (GtkEntry *entry);
124 static void gtk_spin_button_snap (GtkSpinButton *spin_button,
126 static void gtk_spin_button_insert_text (GtkEditable *editable,
127 const gchar *new_text,
128 gint new_text_length,
130 static void gtk_spin_button_real_spin (GtkSpinButton *spin_button,
132 static void gtk_spin_button_real_change_value (GtkSpinButton *spin,
133 GtkScrollType scroll);
135 static gint gtk_spin_button_default_input (GtkSpinButton *spin_button,
137 static gint gtk_spin_button_default_output (GtkSpinButton *spin_button);
139 static gint spin_button_get_arrow_size (GtkSpinButton *spin_button);
140 static gint spin_button_get_shadow_type (GtkSpinButton *spin_button);
141 static void spin_button_redraw (GtkSpinButton *spin_button);
144 static GtkEntryClass *parent_class = NULL;
145 static guint spinbutton_signals[LAST_SIGNAL] = {0};
150 gtk_spin_button_get_type (void)
152 static GType spin_button_type = 0;
154 if (!spin_button_type)
156 static const GTypeInfo spin_button_info =
158 sizeof (GtkSpinButtonClass),
159 NULL, /* base_init */
160 NULL, /* base_finalize */
161 (GClassInitFunc) gtk_spin_button_class_init,
162 NULL, /* class_finalize */
163 NULL, /* class_data */
164 sizeof (GtkSpinButton),
166 (GInstanceInitFunc) gtk_spin_button_init,
169 static const GInterfaceInfo editable_info =
171 (GInterfaceInitFunc) gtk_spin_button_editable_init, /* interface_init */
172 NULL, /* interface_finalize */
173 NULL /* interface_data */
177 g_type_register_static (GTK_TYPE_ENTRY, "GtkSpinButton",
178 &spin_button_info, 0);
180 g_type_add_interface_static (spin_button_type,
184 return spin_button_type;
187 #define add_spin_binding(binding_set, keyval, mask, scroll) \
188 gtk_binding_entry_add_signal (binding_set, keyval, mask, \
190 GTK_TYPE_SCROLL_TYPE, scroll)
193 gtk_spin_button_class_init (GtkSpinButtonClass *class)
195 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
196 GtkObjectClass *object_class;
197 GtkWidgetClass *widget_class;
198 GtkEntryClass *entry_class;
199 GtkBindingSet *binding_set;
201 object_class = (GtkObjectClass*) class;
202 widget_class = (GtkWidgetClass*) class;
203 entry_class = (GtkEntryClass*) class;
205 parent_class = g_type_class_peek_parent (class);
207 gobject_class->finalize = gtk_spin_button_finalize;
209 gobject_class->set_property = gtk_spin_button_set_property;
210 gobject_class->get_property = gtk_spin_button_get_property;
212 object_class->destroy = gtk_spin_button_destroy;
214 widget_class->map = gtk_spin_button_map;
215 widget_class->unmap = gtk_spin_button_unmap;
216 widget_class->realize = gtk_spin_button_realize;
217 widget_class->unrealize = gtk_spin_button_unrealize;
218 widget_class->size_request = gtk_spin_button_size_request;
219 widget_class->size_allocate = gtk_spin_button_size_allocate;
220 widget_class->expose_event = gtk_spin_button_expose;
221 widget_class->scroll_event = gtk_spin_button_scroll;
222 widget_class->button_press_event = gtk_spin_button_button_press;
223 widget_class->button_release_event = gtk_spin_button_button_release;
224 widget_class->motion_notify_event = gtk_spin_button_motion_notify;
225 widget_class->key_release_event = gtk_spin_button_key_release;
226 widget_class->enter_notify_event = gtk_spin_button_enter_notify;
227 widget_class->leave_notify_event = gtk_spin_button_leave_notify;
228 widget_class->focus_out_event = gtk_spin_button_focus_out;
229 widget_class->grab_notify = gtk_spin_button_grab_notify;
230 widget_class->state_changed = gtk_spin_button_state_changed;
232 entry_class->activate = gtk_spin_button_activate;
235 class->output = NULL;
236 class->change_value = gtk_spin_button_real_change_value;
238 g_object_class_install_property (gobject_class,
240 g_param_spec_object ("adjustment",
242 P_("The adjustment that holds the value of the spinbutton"),
246 g_object_class_install_property (gobject_class,
248 g_param_spec_double ("climb_rate",
250 P_("The acceleration rate when you hold down a button"),
256 g_object_class_install_property (gobject_class,
258 g_param_spec_uint ("digits",
260 P_("The number of decimal places to display"),
266 g_object_class_install_property (gobject_class,
268 g_param_spec_boolean ("snap_to_ticks",
270 P_("Whether erroneous values are automatically changed to a spin button's nearest step increment"),
274 g_object_class_install_property (gobject_class,
276 g_param_spec_boolean ("numeric",
278 P_("Whether non-numeric characters should be ignored"),
282 g_object_class_install_property (gobject_class,
284 g_param_spec_boolean ("wrap",
286 P_("Whether a spin button should wrap upon reaching its limits"),
290 g_object_class_install_property (gobject_class,
292 g_param_spec_enum ("update_policy",
294 P_("Whether the spin button should update always, or only when the value is legal"),
295 GTK_TYPE_SPIN_BUTTON_UPDATE_POLICY,
299 g_object_class_install_property (gobject_class,
301 g_param_spec_double ("value",
303 P_("Reads the current value, or sets a new value"),
309 gtk_widget_class_install_style_property_parser (widget_class,
310 g_param_spec_enum ("shadow_type",
312 P_("Style of bevel around the spin button"),
313 GTK_TYPE_SHADOW_TYPE,
316 gtk_rc_property_parse_enum);
317 spinbutton_signals[INPUT] =
318 g_signal_new ("input",
319 G_TYPE_FROM_CLASS (gobject_class),
321 G_STRUCT_OFFSET (GtkSpinButtonClass, input),
323 _gtk_marshal_INT__POINTER,
327 spinbutton_signals[OUTPUT] =
328 g_signal_new ("output",
329 G_TYPE_FROM_CLASS (gobject_class),
331 G_STRUCT_OFFSET (GtkSpinButtonClass, output),
332 _gtk_boolean_handled_accumulator, NULL,
333 _gtk_marshal_BOOLEAN__VOID,
336 spinbutton_signals[VALUE_CHANGED] =
337 g_signal_new ("value_changed",
338 G_TYPE_FROM_CLASS (gobject_class),
340 G_STRUCT_OFFSET (GtkSpinButtonClass, value_changed),
342 _gtk_marshal_VOID__VOID,
346 spinbutton_signals[CHANGE_VALUE] =
347 g_signal_new ("change_value",
348 G_TYPE_FROM_CLASS (gobject_class),
349 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
350 G_STRUCT_OFFSET (GtkSpinButtonClass, change_value),
352 _gtk_marshal_VOID__ENUM,
354 GTK_TYPE_SCROLL_TYPE);
356 binding_set = gtk_binding_set_by_class (class);
358 add_spin_binding (binding_set, GDK_Up, 0, GTK_SCROLL_STEP_UP);
359 add_spin_binding (binding_set, GDK_KP_Up, 0, GTK_SCROLL_STEP_UP);
360 add_spin_binding (binding_set, GDK_Down, 0, GTK_SCROLL_STEP_DOWN);
361 add_spin_binding (binding_set, GDK_KP_Down, 0, GTK_SCROLL_STEP_DOWN);
362 add_spin_binding (binding_set, GDK_Page_Up, 0, GTK_SCROLL_PAGE_UP);
363 add_spin_binding (binding_set, GDK_Page_Down, 0, GTK_SCROLL_PAGE_DOWN);
364 add_spin_binding (binding_set, GDK_Page_Up, GDK_CONTROL_MASK, GTK_SCROLL_END);
365 add_spin_binding (binding_set, GDK_Page_Down, GDK_CONTROL_MASK, GTK_SCROLL_START);
369 gtk_spin_button_editable_init (GtkEditableClass *iface)
371 iface->insert_text = gtk_spin_button_insert_text;
375 gtk_spin_button_set_property (GObject *object,
380 GtkSpinButton *spin_button;
382 spin_button = GTK_SPIN_BUTTON (object);
386 GtkAdjustment *adjustment;
388 case PROP_ADJUSTMENT:
389 adjustment = GTK_ADJUSTMENT (g_value_get_object (value));
391 adjustment = (GtkAdjustment*) gtk_adjustment_new (0.0, 0.0, 0.0, 0.0, 0.0, 0.0);
392 gtk_spin_button_set_adjustment (spin_button, adjustment);
394 case PROP_CLIMB_RATE:
395 gtk_spin_button_configure (spin_button,
396 spin_button->adjustment,
397 g_value_get_double (value),
398 spin_button->digits);
401 gtk_spin_button_configure (spin_button,
402 spin_button->adjustment,
403 spin_button->climb_rate,
404 g_value_get_uint (value));
406 case PROP_SNAP_TO_TICKS:
407 gtk_spin_button_set_snap_to_ticks (spin_button, g_value_get_boolean (value));
410 gtk_spin_button_set_numeric (spin_button, g_value_get_boolean (value));
413 gtk_spin_button_set_wrap (spin_button, g_value_get_boolean (value));
415 case PROP_UPDATE_POLICY:
416 gtk_spin_button_set_update_policy (spin_button, g_value_get_enum (value));
419 gtk_spin_button_set_value (spin_button, g_value_get_double (value));
427 gtk_spin_button_get_property (GObject *object,
432 GtkSpinButton *spin_button;
434 spin_button = GTK_SPIN_BUTTON (object);
438 case PROP_ADJUSTMENT:
439 g_value_set_object (value, spin_button->adjustment);
441 case PROP_CLIMB_RATE:
442 g_value_set_double (value, spin_button->climb_rate);
445 g_value_set_uint (value, spin_button->digits);
447 case PROP_SNAP_TO_TICKS:
448 g_value_set_boolean (value, spin_button->snap_to_ticks);
451 g_value_set_boolean (value, spin_button->numeric);
454 g_value_set_boolean (value, spin_button->wrap);
456 case PROP_UPDATE_POLICY:
457 g_value_set_enum (value, spin_button->update_policy);
460 g_value_set_double (value, spin_button->adjustment->value);
463 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
469 gtk_spin_button_init (GtkSpinButton *spin_button)
471 spin_button->adjustment = NULL;
472 spin_button->panel = NULL;
473 spin_button->timer = 0;
474 spin_button->climb_rate = 0.0;
475 spin_button->timer_step = 0.0;
476 spin_button->update_policy = GTK_UPDATE_ALWAYS;
477 spin_button->in_child = NO_ARROW;
478 spin_button->click_child = NO_ARROW;
479 spin_button->button = 0;
480 spin_button->need_timer = FALSE;
481 spin_button->timer_calls = 0;
482 spin_button->digits = 0;
483 spin_button->numeric = FALSE;
484 spin_button->wrap = FALSE;
485 spin_button->snap_to_ticks = FALSE;
487 gtk_spin_button_set_adjustment (spin_button,
488 (GtkAdjustment*) gtk_adjustment_new (0, 0, 0, 0, 0, 0));
492 gtk_spin_button_finalize (GObject *object)
494 gtk_spin_button_set_adjustment (GTK_SPIN_BUTTON (object), NULL);
496 G_OBJECT_CLASS (parent_class)->finalize (object);
500 gtk_spin_button_destroy (GtkObject *object)
502 gtk_spin_button_stop_spinning (GTK_SPIN_BUTTON (object));
504 GTK_OBJECT_CLASS (parent_class)->destroy (object);
508 gtk_spin_button_map (GtkWidget *widget)
510 if (GTK_WIDGET_REALIZED (widget) && !GTK_WIDGET_MAPPED (widget))
512 GTK_WIDGET_CLASS (parent_class)->map (widget);
513 gdk_window_show (GTK_SPIN_BUTTON (widget)->panel);
518 gtk_spin_button_unmap (GtkWidget *widget)
520 if (GTK_WIDGET_MAPPED (widget))
522 gdk_window_hide (GTK_SPIN_BUTTON (widget)->panel);
523 GTK_WIDGET_CLASS (parent_class)->unmap (widget);
528 gtk_spin_button_realize (GtkWidget *widget)
530 GtkSpinButton *spin_button;
531 GdkWindowAttr attributes;
532 gint attributes_mask;
537 spin_button = GTK_SPIN_BUTTON (widget);
538 arrow_size = spin_button_get_arrow_size (spin_button);
540 real_width = widget->allocation.width;
541 widget->allocation.width -= arrow_size + 2 * widget->style->xthickness;
542 gtk_widget_set_events (widget, gtk_widget_get_events (widget) |
543 GDK_KEY_RELEASE_MASK);
544 GTK_WIDGET_CLASS (parent_class)->realize (widget);
546 widget->allocation.width = real_width;
548 attributes.window_type = GDK_WINDOW_CHILD;
549 attributes.wclass = GDK_INPUT_OUTPUT;
550 attributes.visual = gtk_widget_get_visual (widget);
551 attributes.colormap = gtk_widget_get_colormap (widget);
552 attributes.event_mask = gtk_widget_get_events (widget);
553 attributes.event_mask |= GDK_EXPOSURE_MASK | GDK_BUTTON_PRESS_MASK
554 | GDK_BUTTON_RELEASE_MASK | GDK_LEAVE_NOTIFY_MASK | GDK_ENTER_NOTIFY_MASK
555 | GDK_POINTER_MOTION_MASK | GDK_POINTER_MOTION_HINT_MASK;
557 attributes_mask = GDK_WA_X | GDK_WA_Y | GDK_WA_VISUAL | GDK_WA_COLORMAP;
559 attributes.x = (widget->allocation.x +
560 widget->allocation.width - arrow_size -
561 2 * widget->style->xthickness);
562 attributes.y = widget->allocation.y + (widget->allocation.height -
563 widget->requisition.height) / 2;
564 attributes.width = arrow_size + 2 * widget->style->xthickness;
565 attributes.height = widget->requisition.height;
567 spin_button->panel = gdk_window_new (gtk_widget_get_parent_window (widget),
568 &attributes, attributes_mask);
569 gdk_window_set_user_data (spin_button->panel, widget);
571 gtk_style_set_background (widget->style, spin_button->panel, GTK_STATE_NORMAL);
574 g_signal_emit (spin_button, spinbutton_signals[OUTPUT], 0, &return_val);
575 if (return_val == FALSE)
576 gtk_spin_button_default_output (spin_button);
578 gtk_widget_queue_resize (GTK_WIDGET (spin_button));
582 gtk_spin_button_unrealize (GtkWidget *widget)
584 GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
586 GTK_WIDGET_CLASS (parent_class)->unrealize (widget);
590 gdk_window_set_user_data (spin->panel, NULL);
591 gdk_window_destroy (spin->panel);
597 compute_double_length (double val, int digits)
603 if (fabs (val) > 1.0)
604 a = floor (log10 (fabs (val))) + 1;
616 return a + digits + extra;
619 /* Keep in sync with gtkentry.c !
622 get_borders (GtkEntry *entry,
626 GtkWidget *widget = GTK_WIDGET (entry);
628 gboolean interior_focus;
630 gtk_widget_style_get (widget,
631 "interior-focus", &interior_focus,
632 "focus-line-width", &focus_width,
635 if (entry->has_frame)
637 *xborder = widget->style->xthickness;
638 *yborder = widget->style->ythickness;
648 *xborder += focus_width;
649 *yborder += focus_width;
654 gtk_spin_button_size_request (GtkWidget *widget,
655 GtkRequisition *requisition)
658 GtkSpinButton *spin_button;
661 entry = GTK_ENTRY (widget);
662 spin_button = GTK_SPIN_BUTTON (widget);
663 arrow_size = spin_button_get_arrow_size (spin_button);
665 GTK_WIDGET_CLASS (parent_class)->size_request (widget, requisition);
667 if (entry->width_chars < 0)
669 PangoContext *context;
670 PangoFontMetrics *metrics;
676 gboolean interior_focus;
678 gint xborder, yborder;
680 gtk_widget_style_get (widget,
681 "interior-focus", &interior_focus,
682 "focus-line-width", &focus_width,
685 context = gtk_widget_get_pango_context (widget);
686 metrics = pango_context_get_metrics (context,
687 widget->style->font_desc,
688 pango_context_get_language (context));
690 digit_width = pango_font_metrics_get_approximate_digit_width (metrics);
691 digit_width = PANGO_SCALE *
692 ((digit_width + PANGO_SCALE - 1) / PANGO_SCALE);
694 pango_font_metrics_unref (metrics);
696 /* Get max of MIN_SPIN_BUTTON_WIDTH, size of upper, size of lower */
698 width = MIN_SPIN_BUTTON_WIDTH;
699 max_string_len = MAX (10, compute_double_length (1e9 * spin_button->adjustment->step_increment,
700 spin_button->digits));
702 string_len = compute_double_length (spin_button->adjustment->upper,
703 spin_button->digits);
704 w = PANGO_PIXELS (MIN (string_len, max_string_len) * digit_width);
705 width = MAX (width, w);
706 string_len = compute_double_length (spin_button->adjustment->lower,
707 spin_button->digits);
708 w = PANGO_PIXELS (MIN (string_len, max_string_len) * digit_width);
709 width = MAX (width, w);
711 get_borders (entry, &xborder, &yborder);
713 xborder += 2; /* INNER_BORDER */
715 requisition->width = width + xborder * 2;
718 requisition->width += arrow_size + 2 * widget->style->xthickness;
722 gtk_spin_button_size_allocate (GtkWidget *widget,
723 GtkAllocation *allocation)
726 GtkAllocation entry_allocation;
727 GtkAllocation panel_allocation;
731 g_return_if_fail (GTK_IS_SPIN_BUTTON (widget));
732 g_return_if_fail (allocation != NULL);
734 spin = GTK_SPIN_BUTTON (widget);
735 arrow_size = spin_button_get_arrow_size (spin);
736 panel_width = arrow_size + 2 * widget->style->xthickness;
738 widget->allocation = *allocation;
740 entry_allocation = *allocation;
741 entry_allocation.width -= panel_width;
743 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL)
745 entry_allocation.x += panel_width;
746 panel_allocation.x = allocation->x;
750 panel_allocation.x = allocation->x + allocation->width - panel_width;
753 panel_allocation.width = panel_width;
754 panel_allocation.height = MIN (widget->requisition.height, allocation->height);
756 panel_allocation.y = allocation->y + (allocation->height -
757 panel_allocation.height) / 2;
759 GTK_WIDGET_CLASS (parent_class)->size_allocate (widget, &entry_allocation);
761 if (GTK_WIDGET_REALIZED (widget))
763 gdk_window_move_resize (GTK_SPIN_BUTTON (widget)->panel,
766 panel_allocation.width,
767 panel_allocation.height);
770 spin_button_redraw (spin);
774 gtk_spin_button_expose (GtkWidget *widget,
775 GdkEventExpose *event)
779 g_return_val_if_fail (GTK_IS_SPIN_BUTTON (widget), FALSE);
780 g_return_val_if_fail (event != NULL, FALSE);
782 spin = GTK_SPIN_BUTTON (widget);
784 if (GTK_WIDGET_DRAWABLE (widget))
786 GtkShadowType shadow_type;
789 if (event->window != spin->panel)
790 GTK_WIDGET_CLASS (parent_class)->expose_event (widget, event);
792 /* we redraw the panel even if it wasn't exposed. This is
793 * because spin->panel is not a child window of widget->window,
794 * so it will not be invalidated by eg. gtk_widget_queue_draw().
799 gdk_drawable_get_size (spin->panel, &rect.width, &rect.height);
801 shadow_type = spin_button_get_shadow_type (spin);
803 gdk_window_begin_paint_rect (spin->panel, &rect);
805 if (shadow_type != GTK_SHADOW_NONE)
807 gtk_paint_box (widget->style, spin->panel,
808 GTK_STATE_NORMAL, shadow_type,
809 NULL, widget, "spinbutton",
810 rect.x, rect.y, rect.width, rect.height);
813 gtk_spin_button_draw_arrow (spin, GTK_ARROW_UP);
814 gtk_spin_button_draw_arrow (spin, GTK_ARROW_DOWN);
816 gdk_window_end_paint (spin->panel);
823 spin_button_at_limit (GtkSpinButton *spin_button,
826 if (spin_button->wrap)
829 if (arrow == GTK_ARROW_UP &&
830 (spin_button->adjustment->upper - spin_button->adjustment->value <= EPSILON))
833 if (arrow == GTK_ARROW_DOWN &&
834 (spin_button->adjustment->value - spin_button->adjustment->lower <= EPSILON))
841 gtk_spin_button_draw_arrow (GtkSpinButton *spin_button,
842 GtkArrowType arrow_type)
844 GtkStateType state_type;
845 GtkShadowType shadow_type;
853 g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
854 g_return_if_fail (arrow_type == GTK_ARROW_UP || arrow_type == GTK_ARROW_DOWN);
856 widget = GTK_WIDGET (spin_button);
858 if (GTK_WIDGET_DRAWABLE (widget))
860 width = spin_button_get_arrow_size (spin_button) + 2 * widget->style->xthickness;
862 if (arrow_type == GTK_ARROW_UP)
867 height = widget->requisition.height / 2;
872 y = widget->requisition.height / 2;
874 height = (widget->requisition.height + 1) / 2;
877 if (spin_button_at_limit (spin_button, arrow_type))
879 shadow_type = GTK_SHADOW_OUT;
880 state_type = GTK_STATE_INSENSITIVE;
884 if (spin_button->click_child == arrow_type)
886 state_type = GTK_STATE_ACTIVE;
887 shadow_type = GTK_SHADOW_IN;
891 if (spin_button->in_child == arrow_type &&
892 spin_button->click_child == NO_ARROW)
894 state_type = GTK_STATE_PRELIGHT;
898 state_type = GTK_WIDGET_STATE (widget);
901 shadow_type = GTK_SHADOW_OUT;
905 gtk_paint_box (widget->style, spin_button->panel,
906 state_type, shadow_type,
908 (arrow_type == GTK_ARROW_UP)? "spinbutton_up" : "spinbutton_down",
909 x, y, width, height);
911 height = widget->requisition.height;
913 if (arrow_type == GTK_ARROW_DOWN)
916 height = height - y - 2;
921 height = height / 2 - 2;
926 if (widget && gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL)
932 w -= w % 2 - 1; /* force odd */
935 x += (width - w) / 2;
936 y += (height - h) / 2;
941 gtk_paint_arrow (widget->style, spin_button->panel,
942 state_type, shadow_type,
943 NULL, widget, "spinbutton",
945 x, y, width, height);
950 gtk_spin_button_enter_notify (GtkWidget *widget,
951 GdkEventCrossing *event)
953 GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
955 if (event->window == spin->panel)
960 gdk_window_get_pointer (spin->panel, &x, &y, NULL);
962 if (y <= widget->requisition.height / 2)
963 spin->in_child = GTK_ARROW_UP;
965 spin->in_child = GTK_ARROW_DOWN;
967 spin_button_redraw (spin);
974 gtk_spin_button_leave_notify (GtkWidget *widget,
975 GdkEventCrossing *event)
977 GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
979 spin->in_child = NO_ARROW;
980 spin_button_redraw (spin);
986 gtk_spin_button_focus_out (GtkWidget *widget,
987 GdkEventFocus *event)
989 if (GTK_ENTRY (widget)->editable)
990 gtk_spin_button_update (GTK_SPIN_BUTTON (widget));
992 return GTK_WIDGET_CLASS (parent_class)->focus_out_event (widget, event);
996 gtk_spin_button_grab_notify (GtkWidget *widget,
997 gboolean was_grabbed)
999 GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1003 gtk_spin_button_stop_spinning (spin);
1004 spin_button_redraw (spin);
1009 gtk_spin_button_state_changed (GtkWidget *widget,
1010 GtkStateType previous_state)
1012 GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1014 if (!GTK_WIDGET_IS_SENSITIVE (widget))
1016 gtk_spin_button_stop_spinning (spin);
1017 spin_button_redraw (spin);
1022 gtk_spin_button_scroll (GtkWidget *widget,
1023 GdkEventScroll *event)
1025 GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1027 if (event->direction == GDK_SCROLL_UP)
1029 if (!GTK_WIDGET_HAS_FOCUS (widget))
1030 gtk_widget_grab_focus (widget);
1031 gtk_spin_button_real_spin (spin, spin->adjustment->step_increment);
1033 else if (event->direction == GDK_SCROLL_DOWN)
1035 if (!GTK_WIDGET_HAS_FOCUS (widget))
1036 gtk_widget_grab_focus (widget);
1037 gtk_spin_button_real_spin (spin, -spin->adjustment->step_increment);
1046 gtk_spin_button_stop_spinning (GtkSpinButton *spin)
1050 g_source_remove (spin->timer);
1052 spin->timer_calls = 0;
1053 spin->need_timer = FALSE;
1058 spin->timer_step = spin->adjustment->step_increment;
1059 spin->timer_calls = 0;
1061 spin->click_child = NO_ARROW;
1066 start_spinning (GtkSpinButton *spin,
1067 GtkArrowType click_child,
1070 g_return_if_fail (click_child == GTK_ARROW_UP || click_child == GTK_ARROW_DOWN);
1072 spin->click_child = click_child;
1073 gtk_spin_button_real_spin (spin, click_child == GTK_ARROW_UP ? step : -step);
1077 spin->timer_step = step;
1078 spin->need_timer = TRUE;
1079 spin->timer = g_timeout_add (SPIN_BUTTON_INITIAL_TIMER_DELAY,
1080 (GSourceFunc) gtk_spin_button_timer,
1084 spin_button_redraw (spin);
1088 gtk_spin_button_button_press (GtkWidget *widget,
1089 GdkEventButton *event)
1091 GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1095 if (event->window == spin->panel)
1097 if (!GTK_WIDGET_HAS_FOCUS (widget))
1098 gtk_widget_grab_focus (widget);
1099 spin->button = event->button;
1101 if (GTK_ENTRY (widget)->editable)
1102 gtk_spin_button_update (spin);
1104 if (event->y <= widget->requisition.height / 2)
1106 if (event->button == 1)
1107 start_spinning (spin, GTK_ARROW_UP, spin->adjustment->step_increment);
1108 else if (event->button == 2)
1109 start_spinning (spin, GTK_ARROW_UP, spin->adjustment->page_increment);
1111 spin->click_child = GTK_ARROW_UP;
1115 if (event->button == 1)
1116 start_spinning (spin, GTK_ARROW_DOWN, spin->adjustment->step_increment);
1117 else if (event->button == 2)
1118 start_spinning (spin, GTK_ARROW_DOWN, spin->adjustment->page_increment);
1120 spin->click_child = GTK_ARROW_DOWN;
1125 return GTK_WIDGET_CLASS (parent_class)->button_press_event (widget, event);
1131 gtk_spin_button_button_release (GtkWidget *widget,
1132 GdkEventButton *event)
1134 GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1137 arrow_size = spin_button_get_arrow_size (spin);
1139 if (event->button == spin->button)
1141 int click_child = spin->click_child;
1143 gtk_spin_button_stop_spinning (spin);
1145 if (event->button == 3)
1147 if (event->y >= 0 && event->x >= 0 &&
1148 event->y <= widget->requisition.height &&
1149 event->x <= arrow_size + 2 * widget->style->xthickness)
1151 if (click_child == GTK_ARROW_UP &&
1152 event->y <= widget->requisition.height / 2)
1156 diff = spin->adjustment->upper - spin->adjustment->value;
1158 gtk_spin_button_real_spin (spin, diff);
1160 else if (click_child == GTK_ARROW_DOWN &&
1161 event->y > widget->requisition.height / 2)
1165 diff = spin->adjustment->value - spin->adjustment->lower;
1167 gtk_spin_button_real_spin (spin, -diff);
1171 spin_button_redraw (spin);
1176 return GTK_WIDGET_CLASS (parent_class)->button_release_event (widget, event);
1180 gtk_spin_button_motion_notify (GtkWidget *widget,
1181 GdkEventMotion *event)
1183 GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1188 if (event->window == spin->panel)
1192 gdk_window_get_pointer (spin->panel, NULL, &y, NULL);
1194 if (y <= widget->requisition.height / 2 &&
1195 spin->in_child == GTK_ARROW_DOWN)
1197 spin->in_child = GTK_ARROW_UP;
1198 spin_button_redraw (spin);
1200 else if (y > widget->requisition.height / 2 &&
1201 spin->in_child == GTK_ARROW_UP)
1203 spin->in_child = GTK_ARROW_DOWN;
1204 spin_button_redraw (spin);
1210 return GTK_WIDGET_CLASS (parent_class)->motion_notify_event (widget, event);
1214 gtk_spin_button_timer (GtkSpinButton *spin_button)
1216 gboolean retval = FALSE;
1218 GDK_THREADS_ENTER ();
1220 if (spin_button->timer)
1222 if (spin_button->click_child == GTK_ARROW_UP)
1223 gtk_spin_button_real_spin (spin_button, spin_button->timer_step);
1225 gtk_spin_button_real_spin (spin_button, -spin_button->timer_step);
1227 if (spin_button->need_timer)
1229 spin_button->need_timer = FALSE;
1230 spin_button->timer = g_timeout_add (SPIN_BUTTON_TIMER_DELAY,
1231 (GSourceFunc) gtk_spin_button_timer,
1232 (gpointer) spin_button);
1236 if (spin_button->climb_rate > 0.0 && spin_button->timer_step
1237 < spin_button->adjustment->page_increment)
1239 if (spin_button->timer_calls < MAX_TIMER_CALLS)
1240 spin_button->timer_calls++;
1243 spin_button->timer_calls = 0;
1244 spin_button->timer_step += spin_button->climb_rate;
1251 GDK_THREADS_LEAVE ();
1257 gtk_spin_button_value_changed (GtkAdjustment *adjustment,
1258 GtkSpinButton *spin_button)
1260 gboolean return_val;
1262 g_return_if_fail (GTK_IS_ADJUSTMENT (adjustment));
1265 g_signal_emit (spin_button, spinbutton_signals[OUTPUT], 0, &return_val);
1266 if (return_val == FALSE)
1267 gtk_spin_button_default_output (spin_button);
1269 g_signal_emit (spin_button, spinbutton_signals[VALUE_CHANGED], 0);
1271 spin_button_redraw (spin_button);
1273 g_object_notify (G_OBJECT (spin_button), "value");
1277 gtk_spin_button_real_change_value (GtkSpinButton *spin,
1278 GtkScrollType scroll)
1280 /* We don't test whether the entry is editable, since
1281 * this key binding conceptually corresponds to changing
1282 * the value with the buttons using the mouse, which
1283 * we allow for non-editable spin buttons.
1287 case GTK_SCROLL_STEP_BACKWARD:
1288 case GTK_SCROLL_STEP_DOWN:
1289 case GTK_SCROLL_STEP_LEFT:
1290 gtk_spin_button_real_spin (spin, -spin->timer_step);
1292 if (spin->climb_rate > 0.0 && spin->timer_step
1293 < spin->adjustment->page_increment)
1295 if (spin->timer_calls < MAX_TIMER_CALLS)
1296 spin->timer_calls++;
1299 spin->timer_calls = 0;
1300 spin->timer_step += spin->climb_rate;
1305 case GTK_SCROLL_STEP_FORWARD:
1306 case GTK_SCROLL_STEP_UP:
1307 case GTK_SCROLL_STEP_RIGHT:
1308 gtk_spin_button_real_spin (spin, spin->timer_step);
1310 if (spin->climb_rate > 0.0 && spin->timer_step
1311 < spin->adjustment->page_increment)
1313 if (spin->timer_calls < MAX_TIMER_CALLS)
1314 spin->timer_calls++;
1317 spin->timer_calls = 0;
1318 spin->timer_step += spin->climb_rate;
1323 case GTK_SCROLL_PAGE_BACKWARD:
1324 case GTK_SCROLL_PAGE_DOWN:
1325 case GTK_SCROLL_PAGE_LEFT:
1326 gtk_spin_button_real_spin (spin, -spin->adjustment->page_increment);
1329 case GTK_SCROLL_PAGE_FORWARD:
1330 case GTK_SCROLL_PAGE_UP:
1331 case GTK_SCROLL_PAGE_RIGHT:
1332 gtk_spin_button_real_spin (spin, spin->adjustment->page_increment);
1335 case GTK_SCROLL_START:
1337 gdouble diff = spin->adjustment->value - spin->adjustment->lower;
1339 gtk_spin_button_real_spin (spin, -diff);
1343 case GTK_SCROLL_END:
1345 gdouble diff = spin->adjustment->upper - spin->adjustment->value;
1347 gtk_spin_button_real_spin (spin, diff);
1352 g_warning ("Invalid scroll type %d for GtkSpinButton::change-value", scroll);
1356 gtk_spin_button_update (spin);
1360 gtk_spin_button_key_release (GtkWidget *widget,
1363 GtkSpinButton *spin = GTK_SPIN_BUTTON (widget);
1365 /* We only get a release at the end of a key repeat run, so reset the timer_step */
1366 spin->timer_step = spin->adjustment->step_increment;
1367 spin->timer_calls = 0;
1373 gtk_spin_button_snap (GtkSpinButton *spin_button,
1379 inc = spin_button->adjustment->step_increment;
1383 tmp = (val - spin_button->adjustment->lower) / inc;
1384 if (tmp - floor (tmp) < ceil (tmp) - tmp)
1385 val = spin_button->adjustment->lower + floor (tmp) * inc;
1387 val = spin_button->adjustment->lower + ceil (tmp) * inc;
1389 if (fabs (val - spin_button->adjustment->value) > EPSILON)
1390 gtk_adjustment_set_value (spin_button->adjustment, val);
1393 gint return_val = FALSE;
1394 g_signal_emit (spin_button, spinbutton_signals[OUTPUT], 0, &return_val);
1395 if (return_val == FALSE)
1396 gtk_spin_button_default_output (spin_button);
1401 gtk_spin_button_activate (GtkEntry *entry)
1403 if (entry->editable)
1404 gtk_spin_button_update (GTK_SPIN_BUTTON (entry));
1406 /* Chain up so that entry->activates_default is honored */
1407 parent_class->activate (entry);
1411 gtk_spin_button_insert_text (GtkEditable *editable,
1412 const gchar *new_text,
1413 gint new_text_length,
1416 GtkEntry *entry = GTK_ENTRY (editable);
1417 GtkSpinButton *spin = GTK_SPIN_BUTTON (editable);
1418 GtkEditableClass *parent_editable_iface = g_type_interface_peek (parent_class, GTK_TYPE_EDITABLE);
1430 entry_length = entry->text_length;
1434 if (*(lc->negative_sign))
1435 neg_sign = *(lc->negative_sign);
1439 if (*(lc->positive_sign))
1440 pos_sign = *(lc->positive_sign);
1444 for (sign=0, i=0; i<entry_length; i++)
1445 if ((entry->text[i] == neg_sign) ||
1446 (entry->text[i] == pos_sign))
1452 if (sign && !(*position))
1455 for (dotpos=-1, i=0; i<entry_length; i++)
1456 if (entry->text[i] == *(lc->decimal_point))
1462 if (dotpos > -1 && *position > dotpos &&
1463 (gint)spin->digits - entry_length
1464 + dotpos - new_text_length + 1 < 0)
1467 for (i = 0; i < new_text_length; i++)
1469 if (new_text[i] == neg_sign || new_text[i] == pos_sign)
1471 if (sign || (*position) || i)
1475 else if (new_text[i] == *(lc->decimal_point))
1477 if (!spin->digits || dotpos > -1 ||
1478 (new_text_length - 1 - i + entry_length
1479 - *position > (gint)spin->digits))
1481 dotpos = *position + i;
1483 else if (new_text[i] < 0x30 || new_text[i] > 0x39)
1488 parent_editable_iface->insert_text (editable, new_text,
1489 new_text_length, position);
1493 gtk_spin_button_real_spin (GtkSpinButton *spin_button,
1497 gdouble new_value = 0.0;
1499 adj = spin_button->adjustment;
1501 new_value = adj->value + increment;
1505 if (spin_button->wrap)
1507 if (fabs (adj->value - adj->upper) < EPSILON)
1508 new_value = adj->lower;
1509 else if (new_value > adj->upper)
1510 new_value = adj->upper;
1513 new_value = MIN (new_value, adj->upper);
1515 else if (increment < 0)
1517 if (spin_button->wrap)
1519 if (fabs (adj->value - adj->lower) < EPSILON)
1520 new_value = adj->upper;
1521 else if (new_value < adj->lower)
1522 new_value = adj->lower;
1525 new_value = MAX (new_value, adj->lower);
1528 if (fabs (new_value - adj->value) > EPSILON)
1529 gtk_adjustment_set_value (adj, new_value);
1531 spin_button_redraw (spin_button);
1535 gtk_spin_button_default_input (GtkSpinButton *spin_button,
1540 *new_val = g_strtod (gtk_entry_get_text (GTK_ENTRY (spin_button)), &err);
1542 return GTK_INPUT_ERROR;
1548 gtk_spin_button_default_output (GtkSpinButton *spin_button)
1550 gchar *buf = g_strdup_printf ("%0.*f", spin_button->digits, spin_button->adjustment->value);
1552 if (strcmp (buf, gtk_entry_get_text (GTK_ENTRY (spin_button))))
1553 gtk_entry_set_text (GTK_ENTRY (spin_button), buf);
1559 /***********************************************************
1560 ***********************************************************
1561 *** Public interface ***
1562 ***********************************************************
1563 ***********************************************************/
1567 gtk_spin_button_configure (GtkSpinButton *spin_button,
1568 GtkAdjustment *adjustment,
1572 g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
1575 gtk_spin_button_set_adjustment (spin_button, adjustment);
1577 adjustment = spin_button->adjustment;
1579 g_object_freeze_notify (G_OBJECT (spin_button));
1580 if (spin_button->digits != digits)
1582 spin_button->digits = digits;
1583 g_object_notify (G_OBJECT (spin_button), "digits");
1586 if (spin_button->climb_rate != climb_rate)
1588 spin_button->climb_rate = climb_rate;
1589 g_object_notify (G_OBJECT (spin_button), "climb_rate");
1591 g_object_thaw_notify (G_OBJECT (spin_button));
1593 gtk_adjustment_value_changed (adjustment);
1597 gtk_spin_button_new (GtkAdjustment *adjustment,
1601 GtkSpinButton *spin;
1604 g_return_val_if_fail (GTK_IS_ADJUSTMENT (adjustment), NULL);
1606 spin = g_object_new (GTK_TYPE_SPIN_BUTTON, NULL);
1608 gtk_spin_button_configure (spin, adjustment, climb_rate, digits);
1610 return GTK_WIDGET (spin);
1614 * gtk_spin_button_new_with_range:
1615 * @min: Minimum allowable value
1616 * @max: Maximum allowable value
1617 * @step: Increment added or subtracted by spinning the widget
1619 * This is a convenience constructor that allows creation of a numeric
1620 * #GtkSpinButton without manually creating an adjustment. The value is
1621 * initially set to the minimum value and a page increment of 10 * @step
1622 * is the default. The precision of the spin button is equivalent to the
1623 * precision of @step.
1625 * Return value: The new spin button as a #GtkWidget.
1628 gtk_spin_button_new_with_range (gdouble min,
1633 GtkSpinButton *spin;
1636 g_return_val_if_fail (min < max, NULL);
1637 g_return_val_if_fail (step != 0.0, NULL);
1639 spin = g_object_new (GTK_TYPE_SPIN_BUTTON, NULL);
1641 adj = gtk_adjustment_new (min, min, max, step, 10 * step, 0);
1643 if (fabs (step) >= 1.0 || step == 0.0)
1646 digits = abs ((gint) floor (log10 (fabs (step))));
1647 if (digits > MAX_DIGITS)
1648 digits = MAX_DIGITS;
1651 gtk_spin_button_configure (spin, GTK_ADJUSTMENT (adj), step, digits);
1653 gtk_spin_button_set_numeric (spin, TRUE);
1655 return GTK_WIDGET (spin);
1658 /* Callback used when the spin button's adjustment changes. We need to redraw
1659 * the arrows when the adjustment's range changes, and reevaluate our size request.
1662 adjustment_changed_cb (GtkAdjustment *adjustment, gpointer data)
1664 GtkSpinButton *spin_button;
1666 spin_button = GTK_SPIN_BUTTON (data);
1668 spin_button->timer_step = spin_button->adjustment->step_increment;
1669 gtk_widget_queue_resize (GTK_WIDGET (spin_button));
1673 * gtk_spin_button_set_adjustment:
1674 * @spin_button: a #GtkSpinButton
1675 * @adjustment: a #GtkAdjustment to replace the existing adjustment
1677 * Replaces the #GtkAdjustment associated with @spin_button.
1680 gtk_spin_button_set_adjustment (GtkSpinButton *spin_button,
1681 GtkAdjustment *adjustment)
1683 g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
1685 if (spin_button->adjustment != adjustment)
1687 if (spin_button->adjustment)
1689 g_signal_handlers_disconnect_by_func (spin_button->adjustment,
1690 gtk_spin_button_value_changed,
1692 g_signal_handlers_disconnect_by_func (spin_button->adjustment,
1693 adjustment_changed_cb,
1695 g_object_unref (spin_button->adjustment);
1697 spin_button->adjustment = adjustment;
1700 g_object_ref (adjustment);
1701 gtk_object_sink (GTK_OBJECT (adjustment));
1702 g_signal_connect (adjustment, "value_changed",
1703 G_CALLBACK (gtk_spin_button_value_changed),
1705 g_signal_connect (adjustment, "changed",
1706 G_CALLBACK (adjustment_changed_cb),
1708 spin_button->timer_step = spin_button->adjustment->step_increment;
1711 gtk_widget_queue_resize (GTK_WIDGET (spin_button));
1714 g_object_notify (G_OBJECT (spin_button), "adjustment");
1718 * gtk_spin_button_get_adjustment:
1721 * Get the adjustment associated with a #GtkSpinButton
1723 * Return value: the #GtkAdjustment of @spin_button
1726 gtk_spin_button_get_adjustment (GtkSpinButton *spin_button)
1728 g_return_val_if_fail (GTK_IS_SPIN_BUTTON (spin_button), NULL);
1730 return spin_button->adjustment;
1734 * gtk_spin_button_set_digits:
1735 * @spin_button: a #GtkSpinButton
1736 * @digits: the number of digits after the decimal point to be displayed for the spin button's value
1738 * Set the precision to be displayed by @spin_button. Up to 20 digit precision
1742 gtk_spin_button_set_digits (GtkSpinButton *spin_button,
1745 g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
1747 if (spin_button->digits != digits)
1749 spin_button->digits = digits;
1750 gtk_spin_button_value_changed (spin_button->adjustment, spin_button);
1751 g_object_notify (G_OBJECT (spin_button), "digits");
1753 /* since lower/upper may have changed */
1754 gtk_widget_queue_resize (GTK_WIDGET (spin_button));
1759 * gtk_spin_button_get_digits:
1760 * @spin_button: a #GtkSpinButton
1762 * Fetches the precision of @spin_button. See gtk_spin_button_set_digits().
1764 * Returns: the current precision
1767 gtk_spin_button_get_digits (GtkSpinButton *spin_button)
1769 g_return_val_if_fail (GTK_IS_SPIN_BUTTON (spin_button), 0);
1771 return spin_button->digits;
1775 * gtk_spin_button_set_increments:
1776 * @spin_button: a #GtkSpinButton
1777 * @step: increment applied for a button 1 press.
1778 * @page: increment applied for a button 2 press.
1780 * Sets the step and page increments for spin_button. This affects how
1781 * quickly the value changes when the spin button's arrows are activated.
1784 gtk_spin_button_set_increments (GtkSpinButton *spin_button,
1788 g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
1790 spin_button->adjustment->step_increment = step;
1791 spin_button->adjustment->page_increment = page;
1795 * gtk_spin_button_get_increments:
1796 * @spin_button: a #GtkSpinButton
1797 * @step: location to store step increment, or %NULL
1798 * @page: location to store page increment, or %NULL
1800 * Gets the current step and page the increments used by @spin_button. See
1801 * gtk_spin_button_set_increments().
1804 gtk_spin_button_get_increments (GtkSpinButton *spin_button,
1808 g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
1811 *step = spin_button->adjustment->step_increment;
1813 *page = spin_button->adjustment->page_increment;
1817 * gtk_spin_button_set_range:
1818 * @spin_button: a #GtkSpinButton
1819 * @min: minimum allowable value
1820 * @max: maximum allowable value
1822 * Sets the minimum and maximum allowable values for @spin_button
1825 gtk_spin_button_set_range (GtkSpinButton *spin_button,
1831 g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
1833 spin_button->adjustment->lower = min;
1834 spin_button->adjustment->upper = max;
1836 value = CLAMP (spin_button->adjustment->value,
1837 spin_button->adjustment->lower,
1838 (spin_button->adjustment->upper - spin_button->adjustment->page_size));
1840 if (value != spin_button->adjustment->value)
1841 gtk_spin_button_set_value (spin_button, value);
1843 gtk_adjustment_changed (spin_button->adjustment);
1847 * gtk_spin_button_get_range:
1848 * @spin_button: a #GtkSpinButton
1849 * @min: location to store minimum allowed value, or %NULL
1850 * @max: location to store maximum allowed value, or %NULL
1852 * Gets the range allowed for @spin_button. See
1853 * gtk_spin_button_set_range().
1856 gtk_spin_button_get_range (GtkSpinButton *spin_button,
1860 g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
1863 *min = spin_button->adjustment->lower;
1865 *max = spin_button->adjustment->upper;
1869 * gtk_spin_button_get_value:
1870 * @spin_button: a #GtkSpinButton
1872 * Get the value in the @spin_button.
1874 * Return value: the value of @spin_button
1877 gtk_spin_button_get_value (GtkSpinButton *spin_button)
1879 g_return_val_if_fail (GTK_IS_SPIN_BUTTON (spin_button), 0.0);
1881 return spin_button->adjustment->value;
1885 * gtk_spin_button_get_value_as_int:
1886 * @spin_button: a #GtkSpinButton
1888 * Get the value @spin_button represented as an integer.
1890 * Return value: the value of @spin_button
1893 gtk_spin_button_get_value_as_int (GtkSpinButton *spin_button)
1897 g_return_val_if_fail (GTK_IS_SPIN_BUTTON (spin_button), 0);
1899 val = spin_button->adjustment->value;
1900 if (val - floor (val) < ceil (val) - val)
1907 * gtk_spin_button_set_value:
1908 * @spin_button: a #GtkSpinButton
1909 * @value: the new value
1911 * Set the value of @spin_button.
1914 gtk_spin_button_set_value (GtkSpinButton *spin_button,
1917 g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
1919 if (fabs (value - spin_button->adjustment->value) > EPSILON)
1920 gtk_adjustment_set_value (spin_button->adjustment, value);
1923 gint return_val = FALSE;
1924 g_signal_emit (spin_button, spinbutton_signals[OUTPUT], 0, &return_val);
1925 if (return_val == FALSE)
1926 gtk_spin_button_default_output (spin_button);
1931 * gtk_spin_button_set_update_policy:
1932 * @spin_button: a #GtkSpinButton
1933 * @policy: a #GtkSpinButtonUpdatePolicy value
1935 * Sets the update behavior of a spin button. This determines whether the
1936 * spin button is always updated or only when a valid value is set.
1939 gtk_spin_button_set_update_policy (GtkSpinButton *spin_button,
1940 GtkSpinButtonUpdatePolicy policy)
1942 g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
1944 if (spin_button->update_policy != policy)
1946 spin_button->update_policy = policy;
1947 g_object_notify (G_OBJECT (spin_button), "update_policy");
1952 * gtk_spin_button_get_update_policy:
1953 * @spin_button: a #GtkSpinButton
1955 * Gets the update behavior of a spin button. See
1956 * gtk_spin_button_set_update_policy().
1958 * Return value: the current update policy
1960 GtkSpinButtonUpdatePolicy
1961 gtk_spin_button_get_update_policy (GtkSpinButton *spin_button)
1963 g_return_val_if_fail (GTK_IS_SPIN_BUTTON (spin_button), GTK_UPDATE_ALWAYS);
1965 return spin_button->update_policy;
1969 * gtk_spin_button_set_numeric:
1970 * @spin_button: a #GtkSpinButton
1971 * @numeric: flag indicating if only numeric entry is allowed.
1973 * Sets the flag that determines if non-numeric text can be typed into
1977 gtk_spin_button_set_numeric (GtkSpinButton *spin_button,
1980 g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
1982 numeric = numeric != FALSE;
1984 if (spin_button->numeric != numeric)
1986 spin_button->numeric = numeric;
1987 g_object_notify (G_OBJECT (spin_button), "numeric");
1992 * gtk_spin_button_get_numeric:
1993 * @spin_button: a #GtkSpinButton
1995 * Returns whether non-numeric text can be typed into the spin button.
1996 * See gtk_spin_button_set_numeric().
1998 * Return value: %TRUE if only numeric text can be entered
2001 gtk_spin_button_get_numeric (GtkSpinButton *spin_button)
2003 g_return_val_if_fail (GTK_IS_SPIN_BUTTON (spin_button), FALSE);
2005 return spin_button->numeric;
2009 * gtk_spin_button_set_wrap:
2010 * @spin_button: a #GtkSpinButton
2011 * @wrap: a flag indicating if wrapping behavior is performed.
2013 * Sets the flag that determines if a spin button value wraps around to the
2014 * opposite limit when the upper or lower limit of the range is exceeded.
2017 gtk_spin_button_set_wrap (GtkSpinButton *spin_button,
2020 g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2022 wrap = wrap != FALSE;
2024 if (spin_button->wrap != wrap)
2026 spin_button->wrap = (wrap != 0);
2028 g_object_notify (G_OBJECT (spin_button), "wrap");
2033 * gtk_spin_button_get_wrap:
2034 * @spin_button: a #GtkSpinButton
2036 * Returns whether the spin button's value wraps around to the
2037 * opposite limit when the upper or lower limit of the range is
2038 * exceeded. See gtk_spin_button_set_wrap().
2040 * Return value: %TRUE if the spin button wraps around
2043 gtk_spin_button_get_wrap (GtkSpinButton *spin_button)
2045 g_return_val_if_fail (GTK_IS_SPIN_BUTTON (spin_button), FALSE);
2047 return spin_button->wrap;
2051 spin_button_get_arrow_size (GtkSpinButton *spin_button)
2053 gint size = pango_font_description_get_size (GTK_WIDGET (spin_button)->style->font_desc);
2056 arrow_size = MAX (PANGO_PIXELS (size), MIN_ARROW_WIDTH);
2058 return arrow_size - arrow_size % 2; /* force even */
2062 * spin_button_get_shadow_type:
2063 * @spin_button: a #GtkSpinButton
2065 * Convenience function to Get the shadow type from the underlying widget's
2068 * Return value: the #GtkShadowType
2071 spin_button_get_shadow_type (GtkSpinButton *spin_button)
2073 GtkShadowType rc_shadow_type;
2075 gtk_widget_style_get (GTK_WIDGET (spin_button), "shadow_type", &rc_shadow_type, NULL);
2077 return rc_shadow_type;
2081 * gtk_spin_button_set_snap_to_ticks:
2082 * @spin_button: a #GtkSpinButton
2083 * @snap_to_ticks: a flag indicating if invalid values should be corrected.
2085 * Sets the policy as to whether values are corrected to the nearest step
2086 * increment when a spin button is activated after providing an invalid value.
2089 gtk_spin_button_set_snap_to_ticks (GtkSpinButton *spin_button,
2090 gboolean snap_to_ticks)
2094 g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2096 new_val = (snap_to_ticks != 0);
2098 if (new_val != spin_button->snap_to_ticks)
2100 spin_button->snap_to_ticks = new_val;
2101 if (new_val && GTK_ENTRY (spin_button)->editable)
2102 gtk_spin_button_update (spin_button);
2104 g_object_notify (G_OBJECT (spin_button), "snap_to_ticks");
2109 * gtk_spin_button_get_snap_to_ticks:
2110 * @spin_button: a #GtkSpinButton
2112 * Returns whether the values are corrected to the nearest step. See
2113 * gtk_spin_button_set_snap_to_ticks().
2115 * Return value: %TRUE if values are snapped to the nearest step.
2118 gtk_spin_button_get_snap_to_ticks (GtkSpinButton *spin_button)
2120 g_return_val_if_fail (GTK_IS_SPIN_BUTTON (spin_button), FALSE);
2122 return spin_button->snap_to_ticks;
2126 * gtk_spin_button_spin:
2127 * @spin_button: a #GtkSpinButton
2128 * @direction: a #GtkSpinType indicating the direction to spin.
2129 * @increment: step increment to apply in the specified direction.
2131 * Increment or decrement a spin button's value in a specified direction
2132 * by a specified amount.
2135 gtk_spin_button_spin (GtkSpinButton *spin_button,
2136 GtkSpinType direction,
2142 g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2144 adj = spin_button->adjustment;
2146 /* for compatibility with the 1.0.x version of this function */
2147 if (increment != 0 && increment != adj->step_increment &&
2148 (direction == GTK_SPIN_STEP_FORWARD ||
2149 direction == GTK_SPIN_STEP_BACKWARD))
2151 if (direction == GTK_SPIN_STEP_BACKWARD && increment > 0)
2152 increment = -increment;
2153 direction = GTK_SPIN_USER_DEFINED;
2158 case GTK_SPIN_STEP_FORWARD:
2160 gtk_spin_button_real_spin (spin_button, adj->step_increment);
2163 case GTK_SPIN_STEP_BACKWARD:
2165 gtk_spin_button_real_spin (spin_button, -adj->step_increment);
2168 case GTK_SPIN_PAGE_FORWARD:
2170 gtk_spin_button_real_spin (spin_button, adj->page_increment);
2173 case GTK_SPIN_PAGE_BACKWARD:
2175 gtk_spin_button_real_spin (spin_button, -adj->page_increment);
2180 diff = adj->value - adj->lower;
2182 gtk_spin_button_real_spin (spin_button, -diff);
2187 diff = adj->upper - adj->value;
2189 gtk_spin_button_real_spin (spin_button, diff);
2192 case GTK_SPIN_USER_DEFINED:
2195 gtk_spin_button_real_spin (spin_button, increment);
2204 * gtk_spin_button_update:
2205 * @spin_button: a #GtkSpinButton
2207 * Manually force an update of the spin button.
2210 gtk_spin_button_update (GtkSpinButton *spin_button)
2216 g_return_if_fail (GTK_IS_SPIN_BUTTON (spin_button));
2219 g_signal_emit (spin_button, spinbutton_signals[INPUT], 0, &val, &return_val);
2220 if (return_val == FALSE)
2222 return_val = gtk_spin_button_default_input (spin_button, &val);
2223 error = (return_val == GTK_INPUT_ERROR);
2225 else if (return_val == GTK_INPUT_ERROR)
2228 spin_button_redraw (spin_button);
2230 if (spin_button->update_policy == GTK_UPDATE_ALWAYS)
2232 if (val < spin_button->adjustment->lower)
2233 val = spin_button->adjustment->lower;
2234 else if (val > spin_button->adjustment->upper)
2235 val = spin_button->adjustment->upper;
2237 else if ((spin_button->update_policy == GTK_UPDATE_IF_VALID) &&
2239 val < spin_button->adjustment->lower ||
2240 val > spin_button->adjustment->upper))
2242 gtk_spin_button_value_changed (spin_button->adjustment, spin_button);
2246 if (spin_button->snap_to_ticks)
2247 gtk_spin_button_snap (spin_button, val);
2250 if (fabs (val - spin_button->adjustment->value) > EPSILON)
2251 gtk_adjustment_set_value (spin_button->adjustment, val);
2255 g_signal_emit (spin_button, spinbutton_signals[OUTPUT], 0,
2257 if (return_val == FALSE)
2258 gtk_spin_button_default_output (spin_button);
2264 spin_button_redraw (GtkSpinButton *spin_button)
2268 widget = GTK_WIDGET (spin_button);
2270 if (GTK_WIDGET_DRAWABLE (widget))
2272 gtk_widget_queue_draw (widget);
2274 /* We must invalidate the panel window ourselves, because it
2275 * is not a child of widget->window
2277 gdk_window_invalidate_rect (spin_button->panel, NULL, TRUE);