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 G_BEGIN_DECLS
  40
  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))
  47
  48 #define GTK_INPUT_ERROR -1
  49
  50 typedef enum
  51 {
  52   GTK_UPDATE_ALWAYS,
  53   GTK_UPDATE_IF_VALID
  54 } GtkSpinButtonUpdatePolicy;
  55
  56 typedef enum
  57 {
  58   GTK_SPIN_STEP_FORWARD,
  59   GTK_SPIN_STEP_BACKWARD,
  60   GTK_SPIN_PAGE_FORWARD,
  61   GTK_SPIN_PAGE_BACKWARD,
  62   GTK_SPIN_HOME,
  63   GTK_SPIN_END,
  64   GTK_SPIN_USER_DEFINED
  65 } GtkSpinType;
  66
  67
  68 typedef struct _GtkSpinButton       GtkSpinButton;
  69 typedef struct _GtkSpinButtonClass  GtkSpinButtonClass;
  70
  71
  72 struct _GtkSpinButton
  73 {
  74   GtkEntry entry;
  75
  76   GtkAdjustment *adjustment;
  77
  78   GdkWindow *panel;
  79
  80   guint32 timer;
  81
  82   gdouble climb_rate;
  83   gdouble timer_step;
  84
  85   GtkSpinButtonUpdatePolicy update_policy;
  86
  87   guint in_child : 2;
  88   guint click_child : 2; /* valid: GTK_ARROW_UP=0, GTK_ARROW_DOWN=1 or 2=NONE/BOTH */
  89   guint button : 2;
  90   guint need_timer : 1;
  91   guint timer_calls : 3;
  92   guint digits : 10;
  93   guint numeric : 1;
  94   guint wrap : 1;
  95   guint snap_to_ticks : 1;
  96 };
  97
  98 struct _GtkSpinButtonClass
  99 {
 100   GtkEntryClass parent_class;
 101
 102   gint (*input)  (GtkSpinButton *spin_button,
 103                   gdouble       *new_value);
 104   gint (*output) (GtkSpinButton *spin_button);
 105   void (*value_changed) (GtkSpinButton *spin_button);
 106
 107   /* Action signals for keybindings, do not connect to these */
 108   void (*change_value) (GtkSpinButton *spin_button,
 109                         GtkScrollType  scroll);
 110
 111   /* Padding for future expansion */
 112   void (*_gtk_reserved1) (void);
 113   void (*_gtk_reserved2) (void);
 114   void (*_gtk_reserved3) (void);
 115   void (*_gtk_reserved4) (void);
 116 };
 117
 118
 119 GType           gtk_spin_button_get_type           (void) G_GNUC_CONST;
 120
 121 void            gtk_spin_button_configure          (GtkSpinButton  *spin_button,
 122                                                     GtkAdjustment  *adjustment,
 123                                                     gdouble         climb_rate,
 124                                                     guint           digits);
 125
 126 GtkWidget*      gtk_spin_button_new                (GtkAdjustment  *adjustment,
 127                                                     gdouble         climb_rate,
 128                                                     guint           digits);
 129
 130 GtkWidget*      gtk_spin_button_new_with_range     (gdouble  min,
 131                                                     gdouble  max,
 132                                                     gdouble  step);
 133
 134 void            gtk_spin_button_set_adjustment     (GtkSpinButton  *spin_button,
 135                                                     GtkAdjustment  *adjustment);
 136
 137 GtkAdjustment*  gtk_spin_button_get_adjustment     (GtkSpinButton  *spin_button);
 138
 139 void            gtk_spin_button_set_digits         (GtkSpinButton  *spin_button,
 140                                                     guint           digits);
 141 guint           gtk_spin_button_get_digits         (GtkSpinButton  *spin_button);
 142
 143 void            gtk_spin_button_set_increments     (GtkSpinButton  *spin_button,
 144                                                     gdouble         step,
 145                                                     gdouble         page);
 146 void            gtk_spin_button_get_increments     (GtkSpinButton  *spin_button,
 147                                                     gdouble        *step,
 148                                                     gdouble        *page);
 149
 150 void            gtk_spin_button_set_range          (GtkSpinButton  *spin_button,
 151                                                     gdouble         min,
 152                                                     gdouble         max);
 153 void            gtk_spin_button_get_range          (GtkSpinButton  *spin_button,
 154                                                     gdouble        *min,
 155                                                     gdouble        *max);
 156
 157 gdouble         gtk_spin_button_get_value          (GtkSpinButton  *spin_button);
 158
 159 gint            gtk_spin_button_get_value_as_int   (GtkSpinButton  *spin_button);
 160
 161 void            gtk_spin_button_set_value          (GtkSpinButton  *spin_button,
 162                                                     gdouble         value);
 163
 164 void            gtk_spin_button_set_update_policy  (GtkSpinButton  *spin_button,
 165                                                     GtkSpinButtonUpdatePolicy  policy);
 166 GtkSpinButtonUpdatePolicy gtk_spin_button_get_update_policy (GtkSpinButton *spin_button);
 167
 168 void            gtk_spin_button_set_numeric        (GtkSpinButton  *spin_button,
 169                                                     gboolean        numeric);
 170 gboolean        gtk_spin_button_get_numeric        (GtkSpinButton  *spin_button);
 171
 172 void            gtk_spin_button_spin               (GtkSpinButton  *spin_button,
 173                                                     GtkSpinType     direction,
 174                                                     gdouble         increment);
 175
 176 void            gtk_spin_button_set_wrap           (GtkSpinButton  *spin_button,
 177                                                     gboolean        wrap);
 178 gboolean        gtk_spin_button_get_wrap           (GtkSpinButton  *spin_button);
 179
 180 void            gtk_spin_button_set_snap_to_ticks  (GtkSpinButton  *spin_button,
 181                                                     gboolean        snap_to_ticks);
 182 gboolean        gtk_spin_button_get_snap_to_ticks  (GtkSpinButton  *spin_button);
 183 void            gtk_spin_button_update             (GtkSpinButton  *spin_button);
 184
 185
 186 #ifndef GTK_DISABLE_DEPRECATED
 187 #define gtk_spin_button_get_value_as_float gtk_spin_button_get_value
 188 #endif
 189
 190 G_END_DECLS
 191
 192 #endif /* __GTK_SPIN_BUTTON_H__ */