gtkspinbutton.h 6.18 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
18 19 20
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
21 22
 */

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

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

34 35 36 37 38 39 40 41
#ifndef __GTK_SPIN_BUTTON_H__
#define __GTK_SPIN_BUTTON_H__


#include <gtk/gtkentry.h>
#include <gtk/gtkadjustment.h>


42
G_BEGIN_DECLS
43 44

#define GTK_TYPE_SPIN_BUTTON                  (gtk_spin_button_get_type ())
Manish Singh's avatar
Manish Singh committed
45 46 47 48 49
#define GTK_SPIN_BUTTON(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_SPIN_BUTTON, GtkSpinButton))
#define GTK_SPIN_BUTTON_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_SPIN_BUTTON, GtkSpinButtonClass))
#define GTK_IS_SPIN_BUTTON(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_SPIN_BUTTON))
#define GTK_IS_SPIN_BUTTON_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_SPIN_BUTTON))
#define GTK_SPIN_BUTTON_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_SPIN_BUTTON, GtkSpinButtonClass))
50

51
#define GTK_INPUT_ERROR -1
52

53 54
typedef enum
{
55 56
  GTK_UPDATE_ALWAYS,
  GTK_UPDATE_IF_VALID
57
} GtkSpinButtonUpdatePolicy;
58

59 60 61 62 63 64 65 66 67 68 69 70
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;


71
typedef struct _GtkSpinButton	    GtkSpinButton;
72 73 74 75 76 77
typedef struct _GtkSpinButtonClass  GtkSpinButtonClass;


struct _GtkSpinButton
{
  GtkEntry entry;
78

Tim Janik's avatar
Tim Janik committed
79
  GtkAdjustment *GSEAL (adjustment);
80

Tim Janik's avatar
Tim Janik committed
81
  GdkWindow *GSEAL (panel);
82

Tim Janik's avatar
Tim Janik committed
83
  guint32 GSEAL (timer);
84

Tim Janik's avatar
Tim Janik committed
85 86
  gdouble GSEAL (climb_rate);
  gdouble GSEAL (timer_step);
87

Tim Janik's avatar
Tim Janik committed
88
  GtkSpinButtonUpdatePolicy GSEAL (update_policy);
89

90 91 92 93 94 95 96 97 98
  guint GSEAL (in_child) : 2;
  guint GSEAL (click_child) : 2; /* valid: GTK_ARROW_UP=0, GTK_ARROW_DOWN=1 or 2=NONE/BOTH */
  guint GSEAL (button) : 2;
  guint GSEAL (need_timer) : 1;
  guint GSEAL (timer_calls) : 3;
  guint GSEAL (digits) : 10;
  guint GSEAL (numeric) : 1;
  guint GSEAL (wrap) : 1;
  guint GSEAL (snap_to_ticks) : 1;
99 100 101 102 103
};

struct _GtkSpinButtonClass
{
  GtkEntryClass parent_class;
104 105

  gint (*input)  (GtkSpinButton *spin_button,
106
		  gdouble       *new_value);
107
  gint (*output) (GtkSpinButton *spin_button);
108
  void (*value_changed) (GtkSpinButton *spin_button);
109

Owen Taylor's avatar
Owen Taylor committed
110 111 112
  /* Action signals for keybindings, do not connect to these */
  void (*change_value) (GtkSpinButton *spin_button,
			GtkScrollType  scroll);
113

114 115
  void (*wrapped) (GtkSpinButton *spin_button);

116 117 118 119
  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
120 121
};

122

Manish Singh's avatar
Manish Singh committed
123
GType		gtk_spin_button_get_type	   (void) G_GNUC_CONST;
124

125
void		gtk_spin_button_configure	   (GtkSpinButton  *spin_button,
126
						    GtkAdjustment  *adjustment,
127
						    gdouble	    climb_rate,
128
						    guint	    digits);
129

130
GtkWidget*	gtk_spin_button_new		   (GtkAdjustment  *adjustment,
131
						    gdouble	    climb_rate,
132
						    guint	    digits);
133

134 135 136 137
GtkWidget*	gtk_spin_button_new_with_range	   (gdouble  min,
						    gdouble  max,
						    gdouble  step);

138
void		gtk_spin_button_set_adjustment	   (GtkSpinButton  *spin_button,
139
						    GtkAdjustment  *adjustment);
140

141
GtkAdjustment*	gtk_spin_button_get_adjustment	   (GtkSpinButton  *spin_button);
142

143
void		gtk_spin_button_set_digits	   (GtkSpinButton  *spin_button,
144
						    guint	    digits);
145
guint           gtk_spin_button_get_digits         (GtkSpinButton  *spin_button);
146

147 148 149
void		gtk_spin_button_set_increments	   (GtkSpinButton  *spin_button,
						    gdouble         step,
						    gdouble         page);
150 151 152
void            gtk_spin_button_get_increments     (GtkSpinButton  *spin_button,
						    gdouble        *step,
						    gdouble        *page);
153 154 155 156

void		gtk_spin_button_set_range	   (GtkSpinButton  *spin_button,
						    gdouble         min,
						    gdouble         max);
157 158 159
void            gtk_spin_button_get_range          (GtkSpinButton  *spin_button,
						    gdouble        *min,
						    gdouble        *max);
160

161
gdouble		gtk_spin_button_get_value          (GtkSpinButton  *spin_button);
162

163
gint		gtk_spin_button_get_value_as_int   (GtkSpinButton  *spin_button);
164

165
void		gtk_spin_button_set_value	   (GtkSpinButton  *spin_button,
166
						    gdouble	    value);
167

168 169
void		gtk_spin_button_set_update_policy  (GtkSpinButton  *spin_button,
						    GtkSpinButtonUpdatePolicy  policy);
170
GtkSpinButtonUpdatePolicy gtk_spin_button_get_update_policy (GtkSpinButton *spin_button);
171

172
void		gtk_spin_button_set_numeric	   (GtkSpinButton  *spin_button,
173
						    gboolean	    numeric);
174
gboolean        gtk_spin_button_get_numeric        (GtkSpinButton  *spin_button);
175

176 177
void		gtk_spin_button_spin		   (GtkSpinButton  *spin_button,
						    GtkSpinType     direction,
178
						    gdouble	    increment);
179 180

void		gtk_spin_button_set_wrap	   (GtkSpinButton  *spin_button,
181
						    gboolean	    wrap);
182
gboolean        gtk_spin_button_get_wrap           (GtkSpinButton  *spin_button);
183

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

Matthias Clasen's avatar
Matthias Clasen committed
189
G_END_DECLS
190 191

#endif /* __GTK_SPIN_BUTTON_H__ */