gtk2/gtk/gtkrange.h
2011-01-15 00:26:08 -05:00

216 lines
9.2 KiB
C

/* GTK - The GIMP Toolkit
* Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
/*
* Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
* file for a list of people on the GTK+ Team. See the ChangeLog
* files for a list of changes. These files are distributed with
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif
#ifndef __GTK_RANGE_H__
#define __GTK_RANGE_H__
#include <gtk/gtkadjustment.h>
#include <gtk/gtkwidget.h>
G_BEGIN_DECLS
#define GTK_TYPE_RANGE (gtk_range_get_type ())
#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))
/* These two are private/opaque types, ignore */
typedef struct _GtkRangeLayout GtkRangeLayout;
typedef struct _GtkRangeStepTimer GtkRangeStepTimer;
typedef struct _GtkRange GtkRange;
typedef struct _GtkRangeClass GtkRangeClass;
struct _GtkRange
{
GtkWidget widget;
GtkAdjustment *GSEAL (adjustment);
GtkUpdateType GSEAL (update_policy);
guint GSEAL (inverted) : 1;
/*< protected >*/
guint GSEAL (flippable) : 1;
/* Steppers are: < > ---- < >
* a b c d
*/
guint GSEAL (has_stepper_a) : 1;
guint GSEAL (has_stepper_b) : 1;
guint GSEAL (has_stepper_c) : 1;
guint GSEAL (has_stepper_d) : 1;
guint GSEAL (need_recalc) : 1;
guint GSEAL (slider_size_fixed) : 1;
gint GSEAL (min_slider_size);
GtkOrientation GSEAL (orientation);
/* Area of entire stepper + trough assembly in widget->window coords */
GdkRectangle GSEAL (range_rect);
/* Slider range along the long dimension, in widget->window coords */
gint GSEAL (slider_start);
gint GSEAL (slider_end);
/* Round off value to this many digits, -1 for no rounding */
gint GSEAL (round_digits);
/*< private >*/
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 */
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);
};
struct _GtkRangeClass
{
GtkWidgetClass parent_class;
/* what detail to pass to GTK drawing functions */
gchar *slider_detail;
gchar *stepper_detail;
void (* value_changed) (GtkRange *range);
void (* adjust_bounds) (GtkRange *range,
gdouble new_value);
/* action signals for keybindings */
void (* move_slider) (GtkRange *range,
GtkScrollType scroll);
/* Virtual functions */
void (* get_range_border) (GtkRange *range,
GtkBorder *border_);
gboolean (* change_value) (GtkRange *range,
GtkScrollType scroll,
gdouble new_value);
/* Padding for future expansion */
void (*_gtk_reserved1) (void);
void (*_gtk_reserved2) (void);
void (*_gtk_reserved3) (void);
};
GType gtk_range_get_type (void) G_GNUC_CONST;
#ifndef GTK_DISABLE_DEPRECATED
void gtk_range_set_update_policy (GtkRange *range,
GtkUpdateType policy);
GtkUpdateType gtk_range_get_update_policy (GtkRange *range);
#endif /* GTK_DISABLE_DEPRECATED */
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);
void gtk_range_set_flippable (GtkRange *range,
gboolean flippable);
gboolean gtk_range_get_flippable (GtkRange *range);
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);
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);
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);
void gtk_range_set_round_digits (GtkRange *range,
gint round_digits);
gint gtk_range_get_round_digits (GtkRange *range);
/* internal API */
gdouble _gtk_range_get_wheel_delta (GtkRange *range,
GdkScrollDirection direction);
void _gtk_range_set_stop_values (GtkRange *range,
gdouble *values,
gint n_values);
gint _gtk_range_get_stop_positions (GtkRange *range,
gint **values);
G_END_DECLS
#endif /* __GTK_RANGE_H__ */