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 #if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  31 #error "Only <gtk/gtk.h> can be included directly."
  32 #endif
  33
  34 #ifndef __GTK_SPIN_BUTTON_H__
  35 #define __GTK_SPIN_BUTTON_H__
  36
  37
  38 #include <gtk/gtkentry.h>
  39 #include <gtk/gtkadjustment.h>
  40
  41
  42 G_BEGIN_DECLS
  43
  44 #define GTK_TYPE_SPIN_BUTTON                  (gtk_spin_button_get_type ())
  45 #define GTK_SPIN_BUTTON(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_SPIN_BUTTON, GtkSpinButton))
  46 #define GTK_SPIN_BUTTON_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_SPIN_BUTTON, GtkSpinButtonClass))
  47 #define GTK_IS_SPIN_BUTTON(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_SPIN_BUTTON))
  48 #define GTK_IS_SPIN_BUTTON_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_SPIN_BUTTON))
  49 #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 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 *GSEAL (adjustment);
  80
  81   GdkWindow *GSEAL (panel);
  82
  83   guint32 GSEAL (timer);
  84
  85   gdouble GSEAL (climb_rate);
  86   gdouble GSEAL (timer_step);
  87
  88   GtkSpinButtonUpdatePolicy GSEAL (update_policy);
  89
  90   guint GSEAL (in_child) : 2;
  91   guint GSEAL (click_child) : 2; /* valid: GTK_ARROW_UP=0, GTK_ARROW_DOWN=1 or 2=NONE/BOTH */
  92   guint GSEAL (button) : 2;
  93   guint GSEAL (need_timer) : 1;
  94   guint GSEAL (timer_calls) : 3;
  95   guint GSEAL (digits) : 10;
  96   guint GSEAL (numeric) : 1;
  97   guint GSEAL (wrap) : 1;
  98   guint GSEAL (snap_to_ticks) : 1;
  99 };
 100
 101 struct _GtkSpinButtonClass
 102 {
 103   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
 110   /* Action signals for keybindings, do not connect to these */
 111   void (*change_value) (GtkSpinButton *spin_button,
 112                         GtkScrollType  scroll);
 113
 114   void (*wrapped) (GtkSpinButton *spin_button);
 115
 116   /* Padding for future expansion */
 117   void (*_gtk_reserved1) (void);
 118   void (*_gtk_reserved2) (void);
 119   void (*_gtk_reserved3) (void);
 120 };
 121
 122
 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 GtkWidget*      gtk_spin_button_new_with_range     (gdouble  min,
 135                                                     gdouble  max,
 136                                                     gdouble  step);
 137
 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 void            gtk_spin_button_set_increments     (GtkSpinButton  *spin_button,
 148                                                     gdouble         step,
 149                                                     gdouble         page);
 150 void            gtk_spin_button_get_increments     (GtkSpinButton  *spin_button,
 151                                                     gdouble        *step,
 152                                                     gdouble        *page);
 153
 154 void            gtk_spin_button_set_range          (GtkSpinButton  *spin_button,
 155                                                     gdouble         min,
 156                                                     gdouble         max);
 157 void            gtk_spin_button_get_range          (GtkSpinButton  *spin_button,
 158                                                     gdouble        *min,
 159                                                     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 void            gtk_spin_button_set_update_policy  (GtkSpinButton  *spin_button,
 169                                                     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 void            gtk_spin_button_spin               (GtkSpinButton  *spin_button,
 177                                                     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 void            gtk_spin_button_update             (GtkSpinButton  *spin_button);
 188
 189
 190 #ifndef GTK_DISABLE_DEPRECATED
 191 #define gtk_spin_button_get_value_as_float gtk_spin_button_get_value
 192 #endif
 193
 194 G_END_DECLS
 195
 196 #endif /* __GTK_SPIN_BUTTON_H__ */