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_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 /**
  52  * GTK_INPUT_ERROR:
  53  *
  54  * Constant to return from a signal handler for the #GtkSpinButton::input
  55  * signal in case of conversion failure.
  56  */
  57 #define GTK_INPUT_ERROR -1
  58
  59 /**
  60  * GtkSpinButtonUpdatePolicy:
  61  * @GTK_UPDATE_ALWAYS: When refreshing your #GtkSpinButton, the value is
  62  *     always displayed
  63  * @GTK_UPDATE_IF_VALID: When refreshing your #GtkSpinButton, the value is
  64  *     only displayed if it is valid within the bounds of the spin button's
  65  *     adjustment
  66  *
  67  * The spin button update policy determines whether the spin button displays
  68  * values even if they are outside the bounds of its adjustment.
  69  * See gtk_spin_button_set_update_policy().
  70  */
  71 typedef enum
  72 {
  73   GTK_UPDATE_ALWAYS,
  74   GTK_UPDATE_IF_VALID
  75 } GtkSpinButtonUpdatePolicy;
  76
  77 /**
  78  * GtkSpinType:
  79  * @GTK_SPIN_STEP_FORWARD: Increment by the adjustments step increment.
  80  * @GTK_SPIN_STEP_BACKWARD: Decrement by the adjustments step increment.
  81  * @GTK_SPIN_PAGE_FORWARD: Increment by the adjustments page increment.
  82  * @GTK_SPIN_PAGE_BACKWARD: Decrement by the adjustments page increment.
  83  * @GTK_SPIN_HOME: Go to the adjustments lower bound.
  84  * @GTK_SPIN_END: Go to the adjustments upper bound.
  85  * @GTK_SPIN_USER_DEFINED: Change by a specified amount.
  86  *
  87  * The values of the GtkSpinType enumeration are used to specify the
  88  * change to make in gtk_spin_button_spin().
  89  */
  90 typedef enum
  91 {
  92   GTK_SPIN_STEP_FORWARD,
  93   GTK_SPIN_STEP_BACKWARD,
  94   GTK_SPIN_PAGE_FORWARD,
  95   GTK_SPIN_PAGE_BACKWARD,
  96   GTK_SPIN_HOME,
  97   GTK_SPIN_END,
  98   GTK_SPIN_USER_DEFINED
  99 } GtkSpinType;
 100
 101
 102 typedef struct _GtkSpinButton              GtkSpinButton;
 103 typedef struct _GtkSpinButtonPrivate       GtkSpinButtonPrivate;
 104 typedef struct _GtkSpinButtonClass         GtkSpinButtonClass;
 105
 106 /**
 107  * GtkSpinButton:
 108  *
 109  * The #GtkSpinButton struct contains only private data and should
 110  * not be directly modified.
 111  */
 112 struct _GtkSpinButton
 113 {
 114   GtkEntry entry;
 115
 116   /*< private >*/
 117   GtkSpinButtonPrivate *priv;
 118 };
 119
 120 struct _GtkSpinButtonClass
 121 {
 122   GtkEntryClass parent_class;
 123
 124   gint (*input)  (GtkSpinButton *spin_button,
 125                   gdouble       *new_value);
 126   gint (*output) (GtkSpinButton *spin_button);
 127   void (*value_changed) (GtkSpinButton *spin_button);
 128
 129   /* Action signals for keybindings, do not connect to these */
 130   void (*change_value) (GtkSpinButton *spin_button,
 131                         GtkScrollType  scroll);
 132
 133   void (*wrapped) (GtkSpinButton *spin_button);
 134
 135   /* Padding for future expansion */
 136   void (*_gtk_reserved1) (void);
 137   void (*_gtk_reserved2) (void);
 138   void (*_gtk_reserved3) (void);
 139   void (*_gtk_reserved4) (void);
 140 };
 141
 142
 143 GType           gtk_spin_button_get_type           (void) G_GNUC_CONST;
 144
 145 void            gtk_spin_button_configure          (GtkSpinButton  *spin_button,
 146                                                     GtkAdjustment  *adjustment,
 147                                                     gdouble         climb_rate,
 148                                                     guint           digits);
 149
 150 GtkWidget*      gtk_spin_button_new                (GtkAdjustment  *adjustment,
 151                                                     gdouble         climb_rate,
 152                                                     guint           digits);
 153
 154 GtkWidget*      gtk_spin_button_new_with_range     (gdouble  min,
 155                                                     gdouble  max,
 156                                                     gdouble  step);
 157
 158 void            gtk_spin_button_set_adjustment     (GtkSpinButton  *spin_button,
 159                                                     GtkAdjustment  *adjustment);
 160
 161 GtkAdjustment*  gtk_spin_button_get_adjustment     (GtkSpinButton  *spin_button);
 162
 163 void            gtk_spin_button_set_digits         (GtkSpinButton  *spin_button,
 164                                                     guint           digits);
 165 guint           gtk_spin_button_get_digits         (GtkSpinButton  *spin_button);
 166
 167 void            gtk_spin_button_set_increments     (GtkSpinButton  *spin_button,
 168                                                     gdouble         step,
 169                                                     gdouble         page);
 170 void            gtk_spin_button_get_increments     (GtkSpinButton  *spin_button,
 171                                                     gdouble        *step,
 172                                                     gdouble        *page);
 173
 174 void            gtk_spin_button_set_range          (GtkSpinButton  *spin_button,
 175                                                     gdouble         min,
 176                                                     gdouble         max);
 177 void            gtk_spin_button_get_range          (GtkSpinButton  *spin_button,
 178                                                     gdouble        *min,
 179                                                     gdouble        *max);
 180
 181 gdouble         gtk_spin_button_get_value          (GtkSpinButton  *spin_button);
 182
 183 gint            gtk_spin_button_get_value_as_int   (GtkSpinButton  *spin_button);
 184
 185 void            gtk_spin_button_set_value          (GtkSpinButton  *spin_button,
 186                                                     gdouble         value);
 187
 188 void            gtk_spin_button_set_update_policy  (GtkSpinButton  *spin_button,
 189                                                     GtkSpinButtonUpdatePolicy  policy);
 190 GtkSpinButtonUpdatePolicy gtk_spin_button_get_update_policy (GtkSpinButton *spin_button);
 191
 192 void            gtk_spin_button_set_numeric        (GtkSpinButton  *spin_button,
 193                                                     gboolean        numeric);
 194 gboolean        gtk_spin_button_get_numeric        (GtkSpinButton  *spin_button);
 195
 196 void            gtk_spin_button_spin               (GtkSpinButton  *spin_button,
 197                                                     GtkSpinType     direction,
 198                                                     gdouble         increment);
 199
 200 void            gtk_spin_button_set_wrap           (GtkSpinButton  *spin_button,
 201                                                     gboolean        wrap);
 202 gboolean        gtk_spin_button_get_wrap           (GtkSpinButton  *spin_button);
 203
 204 void            gtk_spin_button_set_snap_to_ticks  (GtkSpinButton  *spin_button,
 205                                                     gboolean        snap_to_ticks);
 206 gboolean        gtk_spin_button_get_snap_to_ticks  (GtkSpinButton  *spin_button);
 207 void            gtk_spin_button_update             (GtkSpinButton  *spin_button);
 208
 209 /* private */
 210 GdkWindow*      _gtk_spin_button_get_panel         (GtkSpinButton  *spin_button);
 211
 212 G_END_DECLS
 213
 214 #endif /* __GTK_SPIN_BUTTON_H__ */