gtkrange.h 8.86 KB
Newer Older
Cody Russell's avatar
Cody Russell committed
1
/* GTK - The GIMP Toolkit
Elliot Lee's avatar
Elliot Lee committed
2 3 4
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10 11
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
15 16 17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
18
 */
19 20

/*
21
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22 23
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
24
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
25 26
 */

27 28 29 30
#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif

Elliot Lee's avatar
Elliot Lee committed
31 32 33 34 35 36 37 38
#ifndef __GTK_RANGE_H__
#define __GTK_RANGE_H__


#include <gtk/gtkadjustment.h>
#include <gtk/gtkwidget.h>


39
G_BEGIN_DECLS
Elliot Lee's avatar
Elliot Lee committed
40 41


42
#define GTK_TYPE_RANGE            (gtk_range_get_type ())
Manish Singh's avatar
Manish Singh committed
43 44 45 46 47
#define GTK_RANGE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_RANGE, GtkRange))
#define GTK_RANGE_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_RANGE, GtkRangeClass))
#define GTK_IS_RANGE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_RANGE))
#define GTK_IS_RANGE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_RANGE))
#define GTK_RANGE_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_RANGE, GtkRangeClass))
Elliot Lee's avatar
Elliot Lee committed
48

49 50 51
/* These two are private/opaque types, ignore */
typedef struct _GtkRangeLayout    GtkRangeLayout;
typedef struct _GtkRangeStepTimer GtkRangeStepTimer;
Elliot Lee's avatar
Elliot Lee committed
52 53 54 55 56 57 58 59

typedef struct _GtkRange        GtkRange;
typedef struct _GtkRangeClass   GtkRangeClass;

struct _GtkRange
{
  GtkWidget widget;

Tim Janik's avatar
Tim Janik committed
60 61
  GtkAdjustment *GSEAL (adjustment);
  GtkUpdateType GSEAL (update_policy);
62
  guint GSEAL (inverted) : 1;
63 64

  /*< protected >*/
65

66
  guint GSEAL (flippable) : 1;
67

68 69 70
  /* Steppers are: < > ---- < >
   *               a b      c d
   */
71

72 73 74 75
  guint GSEAL (has_stepper_a) : 1;
  guint GSEAL (has_stepper_b) : 1;
  guint GSEAL (has_stepper_c) : 1;
  guint GSEAL (has_stepper_d) : 1;
76

77
  guint GSEAL (need_recalc) : 1;
78

79
  guint GSEAL (slider_size_fixed) : 1;
80

Tim Janik's avatar
Tim Janik committed
81
  gint GSEAL (min_slider_size);
Elliot Lee's avatar
Elliot Lee committed
82

Tim Janik's avatar
Tim Janik committed
83
  GtkOrientation GSEAL (orientation);
Elliot Lee's avatar
Elliot Lee committed
84

85
  /* Area of entire stepper + trough assembly in widget->window coords */
Tim Janik's avatar
Tim Janik committed
86
  GdkRectangle GSEAL (range_rect);
87
  /* Slider range along the long dimension, in widget->window coords */
88 89
  gint GSEAL (slider_start);
  gint GSEAL (slider_end);
90 91

  /* Round off value to this many digits, -1 for no rounding */
Tim Janik's avatar
Tim Janik committed
92
  gint GSEAL (round_digits);
93

94
  /*< private >*/
95 96
  guint GSEAL (trough_click_forward) : 1;  /* trough click was on the forward side of slider */
  guint GSEAL (update_pending) : 1;        /* need to emit value_changed */
Tim Janik's avatar
Tim Janik committed
97 98 99 100 101 102
  GtkRangeLayout *GSEAL (layout);
  GtkRangeStepTimer *GSEAL (timer);
  gint GSEAL (slide_initial_slider_position);
  gint GSEAL (slide_initial_coordinate);
  guint GSEAL (update_timeout_id);
  GdkWindow *GSEAL (event_window);
Elliot Lee's avatar
Elliot Lee committed
103 104 105 106 107 108
};

struct _GtkRangeClass
{
  GtkWidgetClass parent_class;

109 110 111
  /* what detail to pass to GTK drawing functions */
  gchar *slider_detail;
  gchar *stepper_detail;
112 113

  void (* value_changed)    (GtkRange     *range);
114 115
  void (* adjust_bounds)    (GtkRange     *range,
                             gdouble	   new_value);
116

117 118
  /* action signals for keybindings */
  void (* move_slider)      (GtkRange     *range,
119 120 121 122
                             GtkScrollType scroll);

  /* Virtual functions */
  void (* get_range_border) (GtkRange     *range,
123
                             GtkBorder    *border_);
124

125 126 127 128
  gboolean (* change_value) (GtkRange     *range,
                             GtkScrollType scroll,
                             gdouble       new_value);

129 130 131 132
  /* Padding for future expansion */
  void (*_gtk_reserved1) (void);
  void (*_gtk_reserved2) (void);
  void (*_gtk_reserved3) (void);
Elliot Lee's avatar
Elliot Lee committed
133 134 135
};


136 137 138 139 140 141 142 143 144 145 146 147 148 149
GType              gtk_range_get_type                      (void) G_GNUC_CONST;

void               gtk_range_set_update_policy             (GtkRange      *range,
                                                            GtkUpdateType  policy);
GtkUpdateType      gtk_range_get_update_policy             (GtkRange      *range);

void               gtk_range_set_adjustment                (GtkRange      *range,
                                                            GtkAdjustment *adjustment);
GtkAdjustment*     gtk_range_get_adjustment                (GtkRange      *range);

void               gtk_range_set_inverted                  (GtkRange      *range,
                                                            gboolean       setting);
gboolean           gtk_range_get_inverted                  (GtkRange      *range);

150 151 152 153
void               gtk_range_set_flippable                 (GtkRange      *range,
                                                            gboolean       flippable);
gboolean           gtk_range_get_flippable                 (GtkRange      *range);

154 155 156 157 158 159 160 161 162 163 164 165 166 167
void               gtk_range_set_slider_size_fixed         (GtkRange      *range,
                                                            gboolean       size_fixed);
gboolean           gtk_range_get_slider_size_fixed         (GtkRange      *range);

void               gtk_range_set_min_slider_size           (GtkRange      *range,
                                                            gboolean       min_size);
gint               gtk_range_get_min_slider_size           (GtkRange      *range);

void               gtk_range_get_range_rect                (GtkRange      *range,
                                                            GdkRectangle  *range_rect);
void               gtk_range_get_slider_range              (GtkRange      *range,
                                                            gint          *slider_start,
                                                            gint          *slider_end);

168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
void               gtk_range_set_lower_stepper_sensitivity (GtkRange      *range,
                                                            GtkSensitivityType sensitivity);
GtkSensitivityType gtk_range_get_lower_stepper_sensitivity (GtkRange      *range);
void               gtk_range_set_upper_stepper_sensitivity (GtkRange      *range,
                                                            GtkSensitivityType sensitivity);
GtkSensitivityType gtk_range_get_upper_stepper_sensitivity (GtkRange      *range);

void               gtk_range_set_increments                (GtkRange      *range,
                                                            gdouble        step,
                                                            gdouble        page);
void               gtk_range_set_range                     (GtkRange      *range,
                                                            gdouble        min,
                                                            gdouble        max);
void               gtk_range_set_value                     (GtkRange      *range,
                                                            gdouble        value);
gdouble            gtk_range_get_value                     (GtkRange      *range);

185 186 187 188 189 190 191 192 193 194
void               gtk_range_set_show_fill_level           (GtkRange      *range,
                                                            gboolean       show_fill_level);
gboolean           gtk_range_get_show_fill_level           (GtkRange      *range);
void               gtk_range_set_restrict_to_fill_level    (GtkRange      *range,
                                                            gboolean       restrict_to_fill_level);
gboolean           gtk_range_get_restrict_to_fill_level    (GtkRange      *range);
void               gtk_range_set_fill_level                (GtkRange      *range,
                                                            gdouble        fill_level);
gdouble            gtk_range_get_fill_level                (GtkRange      *range);

195
/* internal API */
196
gdouble            _gtk_range_get_wheel_delta              (GtkRange      *range,
197
                                                            GdkScrollDirection direction);
198

199 200 201 202 203 204
void               _gtk_range_set_stop_values              (GtkRange      *range,
                                                            gdouble       *values,
                                                            gint           n_values);
gint               _gtk_range_get_stop_positions           (GtkRange      *range,
                                                            gint         **values);          

205 206

G_END_DECLS
Elliot Lee's avatar
Elliot Lee committed
207 208 209


#endif /* __GTK_RANGE_H__ */