Pileus Git - ~andy/gtk/blob - gtk/gtkspinbutton.h

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * GtkSpinButton widget for GTK+
   5  * Copyright (C) 1998 Lars Hamann and Stefan Jeske
   6  *
   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.
  11  *
  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.
  16  *
  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.
  21  */
  22
  23 /*
  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/.
  28  */
  29
  30 #ifndef __GTK_SPIN_BUTTON_H__
  31 #define __GTK_SPIN_BUTTON_H__
  32
  33
  34 #include <gdk/gdk.h>
  35 #include <gtk/gtkentry.h>
  36 #include <gtk/gtkadjustment.h>
  37
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif /* __cplusplus */
  42
  43
  44 #define GTK_TYPE_SPIN_BUTTON                  (gtk_spin_button_get_type ())
  45 #define GTK_SPIN_BUTTON(obj)                  (GTK_CHECK_CAST ((obj), GTK_TYPE_SPIN_BUTTON, GtkSpinButton))
  46 #define GTK_SPIN_BUTTON_CLASS(klass)          (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_SPIN_BUTTON, GtkSpinButtonClass))
  47 #define GTK_IS_SPIN_BUTTON(obj)               (GTK_CHECK_TYPE ((obj), GTK_TYPE_SPIN_BUTTON))
  48 #define GTK_IS_SPIN_BUTTON_CLASS(klass)       (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_SPIN_BUTTON))
  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 typedef enum
  54 {
  55   GTK_UPDATE_ALWAYS,
  56   GTK_UPDATE_IF_VALID
  57 } GtkSpinButtonUpdatePolicy;
  58
  59 typedef enum
  60 {
  61   GTK_SPIN_STEP_FORWARD,
  62   GTK_SPIN_STEP_BACKWARD,
  63   GTK_SPIN_PAGE_FORWARD,
  64   GTK_SPIN_PAGE_BACKWARD,
  65   GTK_SPIN_HOME,
  66   GTK_SPIN_END,
  67   GTK_SPIN_USER_DEFINED
  68 } GtkSpinType;
  69
  70
  71 typedef struct _GtkSpinButton       GtkSpinButton;
  72 typedef struct _GtkSpinButtonClass  GtkSpinButtonClass;
  73
  74
  75 struct _GtkSpinButton
  76 {
  77   GtkEntry entry;
  78
  79   GtkAdjustment *adjustment;
  80
  81   GdkWindow *panel;
  82
  83   guint32 timer;
  84   guint32 ev_time;
  85
  86   gdouble climb_rate;
  87   gdouble timer_step;
  88
  89   GtkSpinButtonUpdatePolicy update_policy;
  90
  91   guint in_child : 2;
  92   guint click_child : 2; /* valid: GTK_ARROW_UP=0, GTK_ARROW_DOWN=1 or 2=NONE/BOTH */
  93   guint button : 2;
  94   guint need_timer : 1;
  95   guint timer_calls : 3;
  96   guint digits : 10;
  97   guint numeric : 1;
  98   guint wrap : 1;
  99   guint snap_to_ticks : 1;
 100 };
 101
 102 struct _GtkSpinButtonClass
 103 {
 104   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   void (*change_value)  (GtkSpinButton *spin,
 112                          GtkScrollType  scroll);
 113
 114 };
 115
 116
 117 GtkType         gtk_spin_button_get_type           (void) G_GNUC_CONST;
 118
 119 void            gtk_spin_button_configure          (GtkSpinButton  *spin_button,
 120                                                     GtkAdjustment  *adjustment,
 121                                                     gdouble         climb_rate,
 122                                                     guint           digits);
 123
 124 GtkWidget*      gtk_spin_button_new                (GtkAdjustment  *adjustment,
 125                                                     gdouble         climb_rate,
 126                                                     guint           digits);
 127
 128 GtkWidget*      gtk_spin_button_new_with_range     (gdouble  min,
 129                                                     gdouble  max,
 130                                                     gdouble  step);
 131
 132 void            gtk_spin_button_set_adjustment     (GtkSpinButton  *spin_button,
 133                                                     GtkAdjustment  *adjustment);
 134
 135 GtkAdjustment*  gtk_spin_button_get_adjustment     (GtkSpinButton  *spin_button);
 136
 137 void            gtk_spin_button_set_digits         (GtkSpinButton  *spin_button,
 138                                                     guint           digits);
 139 guint           gtk_spin_button_get_digits         (GtkSpinButton  *spin_button);
 140
 141 void            gtk_spin_button_set_increments     (GtkSpinButton  *spin_button,
 142                                                     gdouble         step,
 143                                                     gdouble         page);
 144 void            gtk_spin_button_get_increments     (GtkSpinButton  *spin_button,
 145                                                     gdouble        *step,
 146                                                     gdouble        *page);
 147
 148 void            gtk_spin_button_set_range          (GtkSpinButton  *spin_button,
 149                                                     gdouble         min,
 150                                                     gdouble         max);
 151 void            gtk_spin_button_get_range          (GtkSpinButton  *spin_button,
 152                                                     gdouble        *min,
 153                                                     gdouble        *max);
 154
 155 gdouble         gtk_spin_button_get_value          (GtkSpinButton  *spin_button);
 156
 157 gint            gtk_spin_button_get_value_as_int   (GtkSpinButton  *spin_button);
 158
 159 void            gtk_spin_button_set_value          (GtkSpinButton  *spin_button,
 160                                                     gdouble         value);
 161
 162 void            gtk_spin_button_set_update_policy  (GtkSpinButton  *spin_button,
 163                                                     GtkSpinButtonUpdatePolicy  policy);
 164 GtkSpinButtonUpdatePolicy gtk_spin_button_get_update_policy (GtkSpinButton *spin_button);
 165
 166 void            gtk_spin_button_set_numeric        (GtkSpinButton  *spin_button,
 167                                                     gboolean        numeric);
 168 gboolean        gtk_spin_button_get_numeric        (GtkSpinButton  *spin_button);
 169
 170 void            gtk_spin_button_spin               (GtkSpinButton  *spin_button,
 171                                                     GtkSpinType     direction,
 172                                                     gdouble         increment);
 173
 174 void            gtk_spin_button_set_wrap           (GtkSpinButton  *spin_button,
 175                                                     gboolean        wrap);
 176 gboolean        gtk_spin_button_get_wrap           (GtkSpinButton  *spin_button);
 177
 178 void            gtk_spin_button_set_snap_to_ticks  (GtkSpinButton  *spin_button,
 179                                                     gboolean        snap_to_ticks);
 180 gboolean        gtk_spin_button_get_snap_to_ticks  (GtkSpinButton  *spin_button);
 181 void            gtk_spin_button_update             (GtkSpinButton  *spin_button);
 182
 183
 184 #ifndef GTK_DISABLE_DEPRECATED
 185 #define gtk_spin_button_get_value_as_float gtk_spin_button_get_value
 186 #endif
 187
 188 #ifdef __cplusplus
 189 }
 190 #endif /* __cplusplus */
 191
 192
 193 #endif /* __GTK_SPIN_BUTTON_H__ */