gtkspinbutton.h 4.97 KB
Newer Older
1 2 3
/* GTK - The GIMP Toolkit
 * 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 27 28 29
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

30 31 32 33 34 35 36 37 38 39 40 41
#ifndef __GTK_SPIN_BUTTON_H__
#define __GTK_SPIN_BUTTON_H__


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


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
42 43 44 45 46 47 48


#define GTK_TYPE_SPIN_BUTTON                  (gtk_spin_button_get_type ())
#define GTK_SPIN_BUTTON(obj)                  (GTK_CHECK_CAST ((obj), GTK_TYPE_SPIN_BUTTON, GtkSpinButton))
#define GTK_SPIN_BUTTON_CLASS(klass)          (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_SPIN_BUTTON, GtkSpinButtonClass))
#define GTK_IS_SPIN_BUTTON(obj)               (GTK_CHECK_TYPE ((obj), GTK_TYPE_SPIN_BUTTON))
#define GTK_IS_SPIN_BUTTON_CLASS(klass)       (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_SPIN_BUTTON))
Tim Janik's avatar
Tim Janik committed
49
#define GTK_SPIN_BUTTON_GET_CLASS(obj)        (GTK_CHECK_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
  
79
  GtkAdjustment *adjustment;
80
  
81
  GdkWindow *panel;
82
  
83
  guint32 timer;
84
  guint32 ev_time;
85
  
86 87
  gdouble climb_rate;
  gdouble timer_step;
88
  
89
  GtkSpinButtonUpdatePolicy update_policy;
90
  
91 92 93 94 95
  guint in_child : 2;
  guint click_child : 2;
  guint button : 2;
  guint need_timer : 1;
  guint timer_calls : 3;
96 97
  guint digits : 3;
  guint numeric : 1;
98
  guint wrap : 1;
99
  guint snap_to_ticks : 1;
100 101 102 103 104
};

struct _GtkSpinButtonClass
{
  GtkEntryClass parent_class;
105 106

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

112

Elliot Lee's avatar
Elliot Lee committed
113
GtkType		gtk_spin_button_get_type	   (void) G_GNUC_CONST;
114

115
void		gtk_spin_button_configure	   (GtkSpinButton  *spin_button,
116
						    GtkAdjustment  *adjustment,
117
						    gdouble	    climb_rate,
118
						    guint	    digits);
119

120
GtkWidget*	gtk_spin_button_new		   (GtkAdjustment  *adjustment,
121
						    gdouble	    climb_rate,
122
						    guint	    digits);
123

124 125 126 127
GtkWidget*	gtk_spin_button_new_with_range	   (gdouble  min,
						    gdouble  max,
						    gdouble  step);

128
void		gtk_spin_button_set_adjustment	   (GtkSpinButton  *spin_button,
129
						    GtkAdjustment  *adjustment);
130

131
GtkAdjustment*	gtk_spin_button_get_adjustment	   (GtkSpinButton  *spin_button);
132

133
void		gtk_spin_button_set_digits	   (GtkSpinButton  *spin_button,
134
						    guint	    digits);
135

136 137 138 139 140 141 142 143
void		gtk_spin_button_set_increments	   (GtkSpinButton  *spin_button,
						    gdouble         step,
						    gdouble         page);

void		gtk_spin_button_set_range	   (GtkSpinButton  *spin_button,
						    gdouble         min,
						    gdouble         max);

144
gdouble		gtk_spin_button_get_value_as_float (GtkSpinButton  *spin_button);
145

146
gint		gtk_spin_button_get_value_as_int   (GtkSpinButton  *spin_button);
147

148
void		gtk_spin_button_set_value	   (GtkSpinButton  *spin_button, 
149
						    gdouble	    value);
150

151 152
void		gtk_spin_button_set_update_policy  (GtkSpinButton  *spin_button,
						    GtkSpinButtonUpdatePolicy  policy);
153

154
void		gtk_spin_button_set_numeric	   (GtkSpinButton  *spin_button,
155
						    gboolean	    numeric);
156

157 158
void		gtk_spin_button_spin		   (GtkSpinButton  *spin_button,
						    GtkSpinType     direction,
159
						    gdouble	    increment);
160 161

void		gtk_spin_button_set_wrap	   (GtkSpinButton  *spin_button,
162
						    gboolean	    wrap);
163

164
void		gtk_spin_button_set_snap_to_ticks  (GtkSpinButton  *spin_button,
165
						    gboolean	    snap_to_ticks);
166 167
void            gtk_spin_button_update             (GtkSpinButton  *spin_button);

168

169

170 171 172 173 174 175
#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GTK_SPIN_BUTTON_H__ */