1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3 * Copyright (C) 2001 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
20 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
21 * file for a list of people on the GTK+ Team. See the ChangeLog
22 * files for a list of changes. These files are distributed with
23 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
28 #include "gtkscrollbar.h"
30 #include "gtkadjustment.h"
32 #include "gtkprivate.h"
34 #include "a11y/gtkscrollbaraccessible.h"
38 * SECTION:gtkscrollbar
39 * @Short_description: A Scrollbar
40 * @Title: GtkScrollbar
41 * @See_also: #GtkAdjustment, #GtkScrolledWindow
43 * The #GtkScrollbar widget is a horizontal or vertical scrollbar,
44 * depending on the value of the #GtkOrientable:orientation property.
46 * The position of the thumb in a scrollbar is controlled by the scroll
47 * adjustments. See #GtkAdjustment for the fields in an adjustment - for
48 * #GtkScrollbar, the #GtkAdjustment:value field represents the position
49 * of the scrollbar, which must be between the #GtkAdjustment:lower field
50 * and #GtkAdjustment:upper - #GtkAdjustment:page-size. The
51 * #GtkAdjustment:page-size field represents the size of the visible
52 * scrollable area. The #GtkAdjustment:step-increment and
53 * #GtkAdjustment:page-increment fields are properties when the user asks to
54 * step down (using the small stepper arrows) or page down (using for
55 * example the <keycap>PageDown</keycap> key).
59 static void gtk_scrollbar_style_updated (GtkWidget *widget);
61 G_DEFINE_TYPE (GtkScrollbar, gtk_scrollbar, GTK_TYPE_RANGE)
64 gtk_scrollbar_class_init (GtkScrollbarClass *class)
66 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
68 widget_class->style_updated = gtk_scrollbar_style_updated;
70 gtk_widget_class_install_style_property (widget_class,
71 g_param_spec_int ("min-slider-length",
72 P_("Minimum Slider Length"),
73 P_("Minimum length of scrollbar slider"),
79 gtk_widget_class_install_style_property (widget_class,
80 g_param_spec_boolean ("fixed-slider-length",
81 P_("Fixed slider size"),
82 P_("Don't change slider size, just lock it to the minimum length"),
86 gtk_widget_class_install_style_property (widget_class,
87 g_param_spec_boolean ("has-backward-stepper",
88 P_("Backward stepper"),
89 P_("Display the standard backward arrow button"),
93 gtk_widget_class_install_style_property (widget_class,
94 g_param_spec_boolean ("has-forward-stepper",
95 P_("Forward stepper"),
96 P_("Display the standard forward arrow button"),
100 gtk_widget_class_install_style_property (widget_class,
101 g_param_spec_boolean ("has-secondary-backward-stepper",
102 P_("Secondary backward stepper"),
103 P_("Display a second backward arrow button on the opposite end of the scrollbar"),
105 GTK_PARAM_READABLE));
107 gtk_widget_class_install_style_property (widget_class,
108 g_param_spec_boolean ("has-secondary-forward-stepper",
109 P_("Secondary forward stepper"),
110 P_("Display a second forward arrow button on the opposite end of the scrollbar"),
112 GTK_PARAM_READABLE));
114 gtk_widget_class_set_accessible_type (widget_class, GTK_TYPE_SCROLLBAR_ACCESSIBLE);
118 gtk_scrollbar_update_style (GtkScrollbar *scrollbar)
122 gboolean has_a, has_b, has_c, has_d;
123 GtkRange *range = GTK_RANGE (scrollbar);
124 GtkWidget *widget = GTK_WIDGET (scrollbar);
126 gtk_widget_style_get (widget,
127 "min-slider-length", &slider_length,
128 "fixed-slider-length", &fixed_size,
129 "has-backward-stepper", &has_a,
130 "has-secondary-forward-stepper", &has_b,
131 "has-secondary-backward-stepper", &has_c,
132 "has-forward-stepper", &has_d,
135 gtk_range_set_min_slider_size (range, slider_length);
136 gtk_range_set_slider_size_fixed (range, fixed_size);
137 _gtk_range_set_steppers (range,
138 has_a, has_b, has_c, has_d);
142 gtk_scrollbar_init (GtkScrollbar *scrollbar)
144 GtkStyleContext *context;
146 context = gtk_widget_get_style_context (GTK_WIDGET (scrollbar));
147 gtk_style_context_add_class (context, GTK_STYLE_CLASS_SCROLLBAR);
148 gtk_scrollbar_update_style (scrollbar);
152 gtk_scrollbar_style_updated (GtkWidget *widget)
154 gtk_scrollbar_update_style (GTK_SCROLLBAR (widget));
155 GTK_WIDGET_CLASS (gtk_scrollbar_parent_class)->style_updated (widget);
160 * @orientation: the scrollbar's orientation.
161 * @adjustment: (allow-none): the #GtkAdjustment to use, or %NULL to create a new adjustment.
163 * Creates a new scrollbar with the given orientation.
165 * Return value: the new #GtkScrollbar.
170 gtk_scrollbar_new (GtkOrientation orientation,
171 GtkAdjustment *adjustment)
173 g_return_val_if_fail (adjustment == NULL || GTK_IS_ADJUSTMENT (adjustment),
176 return g_object_new (GTK_TYPE_SCROLLBAR,
177 "orientation", orientation,
178 "adjustment", adjustment,