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, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 /*
  22  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  23  * file for a list of people on the GTK+ Team.  See the ChangeLog
  24  * files for a list of changes.  These files are distributed with
  25  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  26  */
  27
  28 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  29 #error "Only <gtk/gtk.h> can be included directly."
  30 #endif
  31
  32 #ifndef __GTK_SPIN_BUTTON_H__
  33 #define __GTK_SPIN_BUTTON_H__
  34
  35
  36 #include <gtk/gtkentry.h>
  37 #include <gtk/gtkadjustment.h>
  38
  39
  40 G_BEGIN_DECLS
  41
  42 #define GTK_TYPE_SPIN_BUTTON                  (gtk_spin_button_get_type ())
  43 #define GTK_SPIN_BUTTON(obj)                  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_SPIN_BUTTON, GtkSpinButton))
  44 #define GTK_SPIN_BUTTON_CLASS(klass)          (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_SPIN_BUTTON, GtkSpinButtonClass))
  45 #define GTK_IS_SPIN_BUTTON(obj)               (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_SPIN_BUTTON))
  46 #define GTK_IS_SPIN_BUTTON_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_SPIN_BUTTON))
  47 #define GTK_SPIN_BUTTON_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_SPIN_BUTTON, GtkSpinButtonClass))
  48
  49 /**
  50  * GTK_INPUT_ERROR:
  51  *
  52  * Constant to return from a signal handler for the #GtkSpinButton::input
  53  * signal in case of conversion failure.
  54  */
  55 #define GTK_INPUT_ERROR -1
  56
  57 /**
  58  * GtkSpinButtonUpdatePolicy:
  59  * @GTK_UPDATE_ALWAYS: When refreshing your #GtkSpinButton, the value is
  60  *     always displayed
  61  * @GTK_UPDATE_IF_VALID: When refreshing your #GtkSpinButton, the value is
  62  *     only displayed if it is valid within the bounds of the spin button's
  63  *     adjustment
  64  *
  65  * The spin button update policy determines whether the spin button displays
  66  * values even if they are outside the bounds of its adjustment.
  67  * See gtk_spin_button_set_update_policy().
  68  */
  69 typedef enum
  70 {
  71   GTK_UPDATE_ALWAYS,
  72   GTK_UPDATE_IF_VALID
  73 } GtkSpinButtonUpdatePolicy;
  74
  75 /**
  76  * GtkSpinType:
  77  * @GTK_SPIN_STEP_FORWARD: Increment by the adjustments step increment.
  78  * @GTK_SPIN_STEP_BACKWARD: Decrement by the adjustments step increment.
  79  * @GTK_SPIN_PAGE_FORWARD: Increment by the adjustments page increment.
  80  * @GTK_SPIN_PAGE_BACKWARD: Decrement by the adjustments page increment.
  81  * @GTK_SPIN_HOME: Go to the adjustments lower bound.
  82  * @GTK_SPIN_END: Go to the adjustments upper bound.
  83  * @GTK_SPIN_USER_DEFINED: Change by a specified amount.
  84  *
  85  * The values of the GtkSpinType enumeration are used to specify the
  86  * change to make in gtk_spin_button_spin().
  87  */
  88 typedef enum
  89 {
  90   GTK_SPIN_STEP_FORWARD,
  91   GTK_SPIN_STEP_BACKWARD,
  92   GTK_SPIN_PAGE_FORWARD,
  93   GTK_SPIN_PAGE_BACKWARD,
  94   GTK_SPIN_HOME,
  95   GTK_SPIN_END,
  96   GTK_SPIN_USER_DEFINED
  97 } GtkSpinType;
  98
  99
 100 typedef struct _GtkSpinButton              GtkSpinButton;
 101 typedef struct _GtkSpinButtonPrivate       GtkSpinButtonPrivate;
 102 typedef struct _GtkSpinButtonClass         GtkSpinButtonClass;
 103
 104 /**
 105  * GtkSpinButton:
 106  *
 107  * The #GtkSpinButton struct contains only private data and should
 108  * not be directly modified.
 109  */
 110 struct _GtkSpinButton
 111 {
 112   GtkEntry entry;
 113
 114   /*< private >*/
 115   GtkSpinButtonPrivate *priv;
 116 };
 117
 118 struct _GtkSpinButtonClass
 119 {
 120   GtkEntryClass parent_class;
 121
 122   gint (*input)  (GtkSpinButton *spin_button,
 123                   gdouble       *new_value);
 124   gint (*output) (GtkSpinButton *spin_button);
 125   void (*value_changed) (GtkSpinButton *spin_button);
 126
 127   /* Action signals for keybindings, do not connect to these */
 128   void (*change_value) (GtkSpinButton *spin_button,
 129                         GtkScrollType  scroll);
 130
 131   void (*wrapped) (GtkSpinButton *spin_button);
 132
 133   /* Padding for future expansion */
 134   void (*_gtk_reserved1) (void);
 135   void (*_gtk_reserved2) (void);
 136   void (*_gtk_reserved3) (void);
 137   void (*_gtk_reserved4) (void);
 138 };
 139
 140
 141 GType           gtk_spin_button_get_type           (void) G_GNUC_CONST;
 142
 143 void            gtk_spin_button_configure          (GtkSpinButton  *spin_button,
 144                                                     GtkAdjustment  *adjustment,
 145                                                     gdouble         climb_rate,
 146                                                     guint           digits);
 147
 148 GtkWidget*      gtk_spin_button_new                (GtkAdjustment  *adjustment,
 149                                                     gdouble         climb_rate,
 150                                                     guint           digits);
 151
 152 GtkWidget*      gtk_spin_button_new_with_range     (gdouble  min,
 153                                                     gdouble  max,
 154                                                     gdouble  step);
 155
 156 void            gtk_spin_button_set_adjustment     (GtkSpinButton  *spin_button,
 157                                                     GtkAdjustment  *adjustment);
 158
 159 GtkAdjustment*  gtk_spin_button_get_adjustment     (GtkSpinButton  *spin_button);
 160
 161 void            gtk_spin_button_set_digits         (GtkSpinButton  *spin_button,
 162                                                     guint           digits);
 163 guint           gtk_spin_button_get_digits         (GtkSpinButton  *spin_button);
 164
 165 void            gtk_spin_button_set_increments     (GtkSpinButton  *spin_button,
 166                                                     gdouble         step,
 167                                                     gdouble         page);
 168 void            gtk_spin_button_get_increments     (GtkSpinButton  *spin_button,
 169                                                     gdouble        *step,
 170                                                     gdouble        *page);
 171
 172 void            gtk_spin_button_set_range          (GtkSpinButton  *spin_button,
 173                                                     gdouble         min,
 174                                                     gdouble         max);
 175 void            gtk_spin_button_get_range          (GtkSpinButton  *spin_button,
 176                                                     gdouble        *min,
 177                                                     gdouble        *max);
 178
 179 gdouble         gtk_spin_button_get_value          (GtkSpinButton  *spin_button);
 180
 181 gint            gtk_spin_button_get_value_as_int   (GtkSpinButton  *spin_button);
 182
 183 void            gtk_spin_button_set_value          (GtkSpinButton  *spin_button,
 184                                                     gdouble         value);
 185
 186 void            gtk_spin_button_set_update_policy  (GtkSpinButton  *spin_button,
 187                                                     GtkSpinButtonUpdatePolicy  policy);
 188 GtkSpinButtonUpdatePolicy gtk_spin_button_get_update_policy (GtkSpinButton *spin_button);
 189
 190 void            gtk_spin_button_set_numeric        (GtkSpinButton  *spin_button,
 191                                                     gboolean        numeric);
 192 gboolean        gtk_spin_button_get_numeric        (GtkSpinButton  *spin_button);
 193
 194 void            gtk_spin_button_spin               (GtkSpinButton  *spin_button,
 195                                                     GtkSpinType     direction,
 196                                                     gdouble         increment);
 197
 198 void            gtk_spin_button_set_wrap           (GtkSpinButton  *spin_button,
 199                                                     gboolean        wrap);
 200 gboolean        gtk_spin_button_get_wrap           (GtkSpinButton  *spin_button);
 201
 202 void            gtk_spin_button_set_snap_to_ticks  (GtkSpinButton  *spin_button,
 203                                                     gboolean        snap_to_ticks);
 204 gboolean        gtk_spin_button_get_snap_to_ticks  (GtkSpinButton  *spin_button);
 205 void            gtk_spin_button_update             (GtkSpinButton  *spin_button);
 206
 207 /* private */
 208 void            _gtk_spin_button_get_panels        (GtkSpinButton  *spin_button,
 209                                                     GdkWindow     **down_panel,
 210                                                     GdkWindow     **up_panel);
 211
 212 G_END_DECLS
 213
 214 #endif /* __GTK_SPIN_BUTTON_H__ */