gtkspinbutton.h 7.77 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
2
3
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
4
5
6
 * GtkSpinButton widget for GTK+
 * 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
10
11
12
13
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * 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
Javier Jardón's avatar
Javier Jardón committed
18
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
19
20
 */

21
/*
22
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
23
24
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
25
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
26
27
 */

28
29
30
31
#ifndef __GTK_SPIN_BUTTON_H__
#define __GTK_SPIN_BUTTON_H__


32
33
34
35
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif

36
#include <gtk/gtkwidget.h>
37
38


39
G_BEGIN_DECLS
40
41

#define GTK_TYPE_SPIN_BUTTON                  (gtk_spin_button_get_type ())
Manish Singh's avatar
Manish Singh committed
42
43
#define GTK_SPIN_BUTTON(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_SPIN_BUTTON, GtkSpinButton))
#define GTK_IS_SPIN_BUTTON(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_SPIN_BUTTON))
44

45
46
47
/**
 * GTK_INPUT_ERROR:
 *
48
 * Constant to return from a signal handler for the ::input
49
 * signal in case of conversion failure.
50
51
 *
 * See [signal@Gtk.SpinButton::input].
52
 */
53
#define GTK_INPUT_ERROR -1
54

55
56
/**
 * GtkSpinButtonUpdatePolicy:
Matthias Clasen's avatar
Matthias Clasen committed
57
 * @GTK_UPDATE_ALWAYS: When refreshing your `GtkSpinButton`, the value is
Matthias Clasen's avatar
Matthias Clasen committed
58
 *   always displayed
Matthias Clasen's avatar
Matthias Clasen committed
59
 * @GTK_UPDATE_IF_VALID: When refreshing your `GtkSpinButton`, the value is
Matthias Clasen's avatar
Matthias Clasen committed
60
61
 *   only displayed if it is valid within the bounds of the spin button's
 *   adjustment
62
 *
63
64
65
66
 * Determines whether the spin button displays values outside the adjustment
 * bounds.
 *
 * See [method@Gtk.SpinButton.set_update_policy].
67
 */
68
69
typedef enum
{
70
71
  GTK_UPDATE_ALWAYS,
  GTK_UPDATE_IF_VALID
72
} GtkSpinButtonUpdatePolicy;
73

74
75
76
77
78
79
80
81
82
83
84
85
86
/**
 * GtkSpinType:
 * @GTK_SPIN_STEP_FORWARD: Increment by the adjustments step increment.
 * @GTK_SPIN_STEP_BACKWARD: Decrement by the adjustments step increment.
 * @GTK_SPIN_PAGE_FORWARD: Increment by the adjustments page increment.
 * @GTK_SPIN_PAGE_BACKWARD: Decrement by the adjustments page increment.
 * @GTK_SPIN_HOME: Go to the adjustments lower bound.
 * @GTK_SPIN_END: Go to the adjustments upper bound.
 * @GTK_SPIN_USER_DEFINED: Change by a specified amount.
 *
 * The values of the GtkSpinType enumeration are used to specify the
 * change to make in gtk_spin_button_spin().
 */
87
88
89
90
91
92
93
94
95
96
97
98
typedef enum
{
  GTK_SPIN_STEP_FORWARD,
  GTK_SPIN_STEP_BACKWARD,
  GTK_SPIN_PAGE_FORWARD,
  GTK_SPIN_PAGE_BACKWARD,
  GTK_SPIN_HOME,
  GTK_SPIN_END,
  GTK_SPIN_USER_DEFINED
} GtkSpinType;


99
typedef struct _GtkSpinButton              GtkSpinButton;
100

101
GDK_AVAILABLE_IN_ALL
102
GType           gtk_spin_button_get_type           (void) G_GNUC_CONST;
103

104
GDK_AVAILABLE_IN_ALL
105
106
107
108
void            gtk_spin_button_configure          (GtkSpinButton  *spin_button,
                                                    GtkAdjustment  *adjustment,
                                                    double          climb_rate,
                                                    guint           digits);
109

110
GDK_AVAILABLE_IN_ALL
111
112
113
GtkWidget*      gtk_spin_button_new                (GtkAdjustment  *adjustment,
                                                    double          climb_rate,
                                                    guint           digits);
114

115
GDK_AVAILABLE_IN_ALL
116
117
118
GtkWidget*      gtk_spin_button_new_with_range     (double   min,
                                                    double   max,
                                                    double   step);
119

120
GDK_AVAILABLE_IN_ALL
121
122
void            gtk_spin_button_set_adjustment     (GtkSpinButton  *spin_button,
                                                    GtkAdjustment  *adjustment);
123

124
GDK_AVAILABLE_IN_ALL
125
GtkAdjustment*  gtk_spin_button_get_adjustment     (GtkSpinButton  *spin_button);
126

127
GDK_AVAILABLE_IN_ALL
128
129
void            gtk_spin_button_set_digits         (GtkSpinButton  *spin_button,
                                                    guint           digits);
130
GDK_AVAILABLE_IN_ALL
131
guint           gtk_spin_button_get_digits         (GtkSpinButton  *spin_button);
132

133
GDK_AVAILABLE_IN_ALL
134
135
136
void            gtk_spin_button_set_increments     (GtkSpinButton  *spin_button,
                                                    double          step,
                                                    double          page);
137
GDK_AVAILABLE_IN_ALL
138
void            gtk_spin_button_get_increments     (GtkSpinButton  *spin_button,
139
140
                                                    double         *step,
                                                    double         *page);
141

142
GDK_AVAILABLE_IN_ALL
143
144
145
void            gtk_spin_button_set_range          (GtkSpinButton  *spin_button,
                                                    double          min,
                                                    double          max);
146
GDK_AVAILABLE_IN_ALL
147
void            gtk_spin_button_get_range          (GtkSpinButton  *spin_button,
148
149
                                                    double         *min,
                                                    double         *max);
150

151
GDK_AVAILABLE_IN_ALL
152
double          gtk_spin_button_get_value          (GtkSpinButton  *spin_button);
153

154
GDK_AVAILABLE_IN_ALL
155
int             gtk_spin_button_get_value_as_int   (GtkSpinButton  *spin_button);
156

157
GDK_AVAILABLE_IN_ALL
158
159
void            gtk_spin_button_set_value          (GtkSpinButton  *spin_button,
                                                    double          value);
160

161
GDK_AVAILABLE_IN_ALL
162
163
void            gtk_spin_button_set_update_policy  (GtkSpinButton  *spin_button,
                                                    GtkSpinButtonUpdatePolicy  policy);
164
GDK_AVAILABLE_IN_ALL
165
GtkSpinButtonUpdatePolicy gtk_spin_button_get_update_policy (GtkSpinButton *spin_button);
166

167
GDK_AVAILABLE_IN_ALL
168
169
void            gtk_spin_button_set_numeric        (GtkSpinButton  *spin_button,
                                                    gboolean        numeric);
170
GDK_AVAILABLE_IN_ALL
171
gboolean        gtk_spin_button_get_numeric        (GtkSpinButton  *spin_button);
172

173
GDK_AVAILABLE_IN_ALL
174
175
176
void            gtk_spin_button_spin               (GtkSpinButton  *spin_button,
                                                    GtkSpinType     direction,
                                                    double          increment);
177

178
GDK_AVAILABLE_IN_ALL
179
180
void            gtk_spin_button_set_wrap           (GtkSpinButton  *spin_button,
                                                    gboolean        wrap);
181
GDK_AVAILABLE_IN_ALL
182
gboolean        gtk_spin_button_get_wrap           (GtkSpinButton  *spin_button);
183

184
GDK_AVAILABLE_IN_ALL
185
186
void            gtk_spin_button_set_snap_to_ticks  (GtkSpinButton  *spin_button,
                                                    gboolean        snap_to_ticks);
187
GDK_AVAILABLE_IN_ALL
188
gboolean        gtk_spin_button_get_snap_to_ticks  (GtkSpinButton  *spin_button);
189

190
GDK_AVAILABLE_IN_ALL
191
192
193
194
void            gtk_spin_button_set_climb_rate     (GtkSpinButton  *spin_button,
                                                    double          climb_rate);
GDK_AVAILABLE_IN_ALL
double          gtk_spin_button_get_climb_rate     (GtkSpinButton  *spin_button);
195

196
197
GDK_AVAILABLE_IN_ALL
void            gtk_spin_button_update             (GtkSpinButton  *spin_button);
198

199

Matthias Clasen's avatar
Matthias Clasen committed
200
G_END_DECLS
201
202

#endif /* __GTK_SPIN_BUTTON_H__ */