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, see <http://www.gnu.org/licenses/>.
22 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
23 * file for a list of people on the GTK+ Team. See the ChangeLog
24 * files for a list of changes. These files are distributed with
25 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
28 #ifndef __GTK_SPIN_BUTTON_H__
29 #define __GTK_SPIN_BUTTON_H__
32 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
33 #error "Only <gtk/gtk.h> can be included directly."
36 #include <gtk/gtkentry.h>
41 #define GTK_TYPE_SPIN_BUTTON (gtk_spin_button_get_type ())
42 #define GTK_SPIN_BUTTON(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_SPIN_BUTTON, GtkSpinButton))
43 #define GTK_SPIN_BUTTON_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_SPIN_BUTTON, GtkSpinButtonClass))
44 #define GTK_IS_SPIN_BUTTON(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_SPIN_BUTTON))
45 #define GTK_IS_SPIN_BUTTON_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_SPIN_BUTTON))
46 #define GTK_SPIN_BUTTON_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_SPIN_BUTTON, GtkSpinButtonClass))
51 * Constant to return from a signal handler for the #GtkSpinButton::input
52 * signal in case of conversion failure.
54 #define GTK_INPUT_ERROR -1
57 * GtkSpinButtonUpdatePolicy:
58 * @GTK_UPDATE_ALWAYS: When refreshing your #GtkSpinButton, the value is
60 * @GTK_UPDATE_IF_VALID: When refreshing your #GtkSpinButton, the value is
61 * only displayed if it is valid within the bounds of the spin button's
64 * The spin button update policy determines whether the spin button displays
65 * values even if they are outside the bounds of its adjustment.
66 * See gtk_spin_button_set_update_policy().
72 } GtkSpinButtonUpdatePolicy;
76 * @GTK_SPIN_STEP_FORWARD: Increment by the adjustments step increment.
77 * @GTK_SPIN_STEP_BACKWARD: Decrement by the adjustments step increment.
78 * @GTK_SPIN_PAGE_FORWARD: Increment by the adjustments page increment.
79 * @GTK_SPIN_PAGE_BACKWARD: Decrement by the adjustments page increment.
80 * @GTK_SPIN_HOME: Go to the adjustments lower bound.
81 * @GTK_SPIN_END: Go to the adjustments upper bound.
82 * @GTK_SPIN_USER_DEFINED: Change by a specified amount.
84 * The values of the GtkSpinType enumeration are used to specify the
85 * change to make in gtk_spin_button_spin().
89 GTK_SPIN_STEP_FORWARD,
90 GTK_SPIN_STEP_BACKWARD,
91 GTK_SPIN_PAGE_FORWARD,
92 GTK_SPIN_PAGE_BACKWARD,
99 typedef struct _GtkSpinButton GtkSpinButton;
100 typedef struct _GtkSpinButtonPrivate GtkSpinButtonPrivate;
101 typedef struct _GtkSpinButtonClass GtkSpinButtonClass;
106 * The #GtkSpinButton struct contains only private data and should
107 * not be directly modified.
109 struct _GtkSpinButton
114 GtkSpinButtonPrivate *priv;
117 struct _GtkSpinButtonClass
119 GtkEntryClass parent_class;
121 gint (*input) (GtkSpinButton *spin_button,
123 gint (*output) (GtkSpinButton *spin_button);
124 void (*value_changed) (GtkSpinButton *spin_button);
126 /* Action signals for keybindings, do not connect to these */
127 void (*change_value) (GtkSpinButton *spin_button,
128 GtkScrollType scroll);
130 void (*wrapped) (GtkSpinButton *spin_button);
132 /* Padding for future expansion */
133 void (*_gtk_reserved1) (void);
134 void (*_gtk_reserved2) (void);
135 void (*_gtk_reserved3) (void);
136 void (*_gtk_reserved4) (void);
140 GType gtk_spin_button_get_type (void) G_GNUC_CONST;
142 void gtk_spin_button_configure (GtkSpinButton *spin_button,
143 GtkAdjustment *adjustment,
147 GtkWidget* gtk_spin_button_new (GtkAdjustment *adjustment,
151 GtkWidget* gtk_spin_button_new_with_range (gdouble min,
155 void gtk_spin_button_set_adjustment (GtkSpinButton *spin_button,
156 GtkAdjustment *adjustment);
158 GtkAdjustment* gtk_spin_button_get_adjustment (GtkSpinButton *spin_button);
160 void gtk_spin_button_set_digits (GtkSpinButton *spin_button,
162 guint gtk_spin_button_get_digits (GtkSpinButton *spin_button);
164 void gtk_spin_button_set_increments (GtkSpinButton *spin_button,
167 void gtk_spin_button_get_increments (GtkSpinButton *spin_button,
171 void gtk_spin_button_set_range (GtkSpinButton *spin_button,
174 void gtk_spin_button_get_range (GtkSpinButton *spin_button,
178 gdouble gtk_spin_button_get_value (GtkSpinButton *spin_button);
180 gint gtk_spin_button_get_value_as_int (GtkSpinButton *spin_button);
182 void gtk_spin_button_set_value (GtkSpinButton *spin_button,
185 void gtk_spin_button_set_update_policy (GtkSpinButton *spin_button,
186 GtkSpinButtonUpdatePolicy policy);
187 GtkSpinButtonUpdatePolicy gtk_spin_button_get_update_policy (GtkSpinButton *spin_button);
189 void gtk_spin_button_set_numeric (GtkSpinButton *spin_button,
191 gboolean gtk_spin_button_get_numeric (GtkSpinButton *spin_button);
193 void gtk_spin_button_spin (GtkSpinButton *spin_button,
194 GtkSpinType direction,
197 void gtk_spin_button_set_wrap (GtkSpinButton *spin_button,
199 gboolean gtk_spin_button_get_wrap (GtkSpinButton *spin_button);
201 void gtk_spin_button_set_snap_to_ticks (GtkSpinButton *spin_button,
202 gboolean snap_to_ticks);
203 gboolean gtk_spin_button_get_snap_to_ticks (GtkSpinButton *spin_button);
204 void gtk_spin_button_update (GtkSpinButton *spin_button);
207 void _gtk_spin_button_get_panels (GtkSpinButton *spin_button,
208 GdkWindow **down_panel,
209 GdkWindow **up_panel);
213 #endif /* __GTK_SPIN_BUTTON_H__ */