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

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GTK+ Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
  28 #error "Only <gtk/gtk.h> can be included directly."
  29 #endif
  30
  31 #ifndef __GTK_RANGE_H__
  32 #define __GTK_RANGE_H__
  33
  34
  35 #include <gtk/gtkadjustment.h>
  36 #include <gtk/gtkwidget.h>
  37
  38
  39 G_BEGIN_DECLS
  40
  41
  42 #define GTK_TYPE_RANGE            (gtk_range_get_type ())
  43 #define GTK_RANGE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_RANGE, GtkRange))
  44 #define GTK_RANGE_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_RANGE, GtkRangeClass))
  45 #define GTK_IS_RANGE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_RANGE))
  46 #define GTK_IS_RANGE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_RANGE))
  47 #define GTK_RANGE_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_RANGE, GtkRangeClass))
  48
  49 typedef struct _GtkRange              GtkRange;
  50 typedef struct _GtkRangePrivate       GtkRangePrivate;
  51 typedef struct _GtkRangeClass         GtkRangeClass;
  52
  53 struct _GtkRange
  54 {
  55   GtkWidget widget;
  56
  57   GtkRangePrivate *priv;
  58 };
  59
  60 struct _GtkRangeClass
  61 {
  62   GtkWidgetClass parent_class;
  63
  64   /* what detail to pass to GTK drawing functions */
  65   gchar *slider_detail;
  66   gchar *stepper_detail;
  67
  68   void (* value_changed)    (GtkRange     *range);
  69   void (* adjust_bounds)    (GtkRange     *range,
  70                              gdouble       new_value);
  71
  72   /* action signals for keybindings */
  73   void (* move_slider)      (GtkRange     *range,
  74                              GtkScrollType scroll);
  75
  76   /* Virtual functions */
  77   void (* get_range_border) (GtkRange     *range,
  78                              GtkBorder    *border_);
  79
  80   gboolean (* change_value) (GtkRange     *range,
  81                              GtkScrollType scroll,
  82                              gdouble       new_value);
  83
  84   /* Padding for future expansion */
  85   void (*_gtk_reserved1) (void);
  86   void (*_gtk_reserved2) (void);
  87   void (*_gtk_reserved3) (void);
  88   void (*_gtk_reserved4) (void);
  89 };
  90
  91
  92 GType              gtk_range_get_type                      (void) G_GNUC_CONST;
  93
  94 void               gtk_range_set_adjustment                (GtkRange      *range,
  95                                                             GtkAdjustment *adjustment);
  96 GtkAdjustment*     gtk_range_get_adjustment                (GtkRange      *range);
  97
  98 void               gtk_range_set_inverted                  (GtkRange      *range,
  99                                                             gboolean       setting);
 100 gboolean           gtk_range_get_inverted                  (GtkRange      *range);
 101
 102 void               gtk_range_set_flippable                 (GtkRange      *range,
 103                                                             gboolean       flippable);
 104 gboolean           gtk_range_get_flippable                 (GtkRange      *range);
 105
 106 void               gtk_range_set_slider_size_fixed         (GtkRange      *range,
 107                                                             gboolean       size_fixed);
 108 gboolean           gtk_range_get_slider_size_fixed         (GtkRange      *range);
 109
 110 void               gtk_range_set_min_slider_size           (GtkRange      *range,
 111                                                             gint           min_size);
 112 gint               gtk_range_get_min_slider_size           (GtkRange      *range);
 113
 114 void               gtk_range_get_range_rect                (GtkRange      *range,
 115                                                             GdkRectangle  *range_rect);
 116 void               gtk_range_get_slider_range              (GtkRange      *range,
 117                                                             gint          *slider_start,
 118                                                             gint          *slider_end);
 119
 120 void               gtk_range_set_lower_stepper_sensitivity (GtkRange      *range,
 121                                                             GtkSensitivityType sensitivity);
 122 GtkSensitivityType gtk_range_get_lower_stepper_sensitivity (GtkRange      *range);
 123 void               gtk_range_set_upper_stepper_sensitivity (GtkRange      *range,
 124                                                             GtkSensitivityType sensitivity);
 125 GtkSensitivityType gtk_range_get_upper_stepper_sensitivity (GtkRange      *range);
 126
 127 void               gtk_range_set_increments                (GtkRange      *range,
 128                                                             gdouble        step,
 129                                                             gdouble        page);
 130 void               gtk_range_set_range                     (GtkRange      *range,
 131                                                             gdouble        min,
 132                                                             gdouble        max);
 133 void               gtk_range_set_value                     (GtkRange      *range,
 134                                                             gdouble        value);
 135 gdouble            gtk_range_get_value                     (GtkRange      *range);
 136
 137 void               gtk_range_set_show_fill_level           (GtkRange      *range,
 138                                                             gboolean       show_fill_level);
 139 gboolean           gtk_range_get_show_fill_level           (GtkRange      *range);
 140 void               gtk_range_set_restrict_to_fill_level    (GtkRange      *range,
 141                                                             gboolean       restrict_to_fill_level);
 142 gboolean           gtk_range_get_restrict_to_fill_level    (GtkRange      *range);
 143 void               gtk_range_set_fill_level                (GtkRange      *range,
 144                                                             gdouble        fill_level);
 145 gdouble            gtk_range_get_fill_level                (GtkRange      *range);
 146 void               gtk_range_set_round_digits              (GtkRange      *range,
 147                                                             gint           round_digits);
 148 gint                gtk_range_get_round_digits              (GtkRange      *range);
 149
 150 /* internal API */
 151 gdouble            _gtk_range_get_wheel_delta              (GtkRange      *range,
 152                                                             GdkScrollDirection direction);
 153 void               _gtk_range_set_has_origin               (GtkRange      *range,
 154                                                             gboolean       has_origin);
 155 gboolean           _gtk_range_get_has_origin               (GtkRange      *range);
 156 void               _gtk_range_set_stop_values              (GtkRange      *range,
 157                                                             gdouble       *values,
 158                                                             gint           n_values);
 159 gint               _gtk_range_get_stop_positions           (GtkRange      *range,
 160                                                             gint         **values);
 161 void               _gtk_range_set_steppers                 (GtkRange      *range,
 162                                                             gboolean       has_a,
 163                                                             gboolean       has_b,
 164                                                             gboolean       has_c,
 165                                                             gboolean       has_d);
 166
 167 G_END_DECLS
 168
 169
 170 #endif /* __GTK_RANGE_H__ */