/* GTK - The GIMP Toolkit
* Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
+ * Copyright (C) 2001 Red Hat, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* 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/.
+ * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
+#include "config.h"
+
#include "gtkscrollbar.h"
+#include "gtkintl.h"
+#include "gtkprivate.h"
-static void gtk_scrollbar_class_init (GtkScrollbarClass *klass);
-static void gtk_scrollbar_init (GtkScrollbar *scrollbar);
-GtkType
-gtk_scrollbar_get_type (void)
-{
- static GtkType scrollbar_type = 0;
-
- if (!scrollbar_type)
- {
- static const GtkTypeInfo scrollbar_info =
- {
- "GtkScrollbar",
- sizeof (GtkScrollbar),
- sizeof (GtkScrollbarClass),
- (GtkClassInitFunc) gtk_scrollbar_class_init,
- (GtkObjectInitFunc) gtk_scrollbar_init,
- /* reserved_1 */ NULL,
- /* reserved_2 */ NULL,
- (GtkClassInitFunc) NULL,
- };
-
- scrollbar_type = gtk_type_unique (GTK_TYPE_RANGE, &scrollbar_info);
- }
-
- return scrollbar_type;
-}
+/**
+ * SECTION:gtkscrollbar
+ * @Short_description: Base class for GtkHScrollbar and GtkVScrollbar
+ * @Title: GtkScrollbar
+ * @See_also: #GtkHScrollbar, #GtkVScrollbar, #GtkAdjustment,
+ * #GtkScrolledWindow
+ *
+ * The #GtkScrollbar widget is the base class for #GtkHScrollbar and
+ * #GtkVScrollbar. It can be used in the same way as these, by setting
+ * the "orientation" property appropriately.
+ *
+ * The position of the thumb in a scrollbar is controlled by the scroll
+ * adjustments. See #GtkAdjustment for the fields in an adjustment - for
+ * #GtkScrollbar, the #GtkAdjustment.value field represents the position
+ * of the scrollbar, which must be between the #GtkAdjustment.lower field
+ * and #GtkAdjustment.upper - #GtkAdjustment.page_size. The
+ * #GtkAdjustment.page_size field represents the size of the visible
+ * scrollable area. The #GtkAdjustment.step_increment and
+ * #GtkAdjustment.page_increment fields are used when the user asks to
+ * step down (using the small stepper arrows) or page down (using for
+ * example the <keycap>PageDown</keycap> key).
+ */
+
+
+static void gtk_scrollbar_style_updated (GtkWidget *widget);
+
+G_DEFINE_TYPE (GtkScrollbar, gtk_scrollbar, GTK_TYPE_RANGE)
static void
gtk_scrollbar_class_init (GtkScrollbarClass *class)
{
+ GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
+
+ widget_class->style_updated = gtk_scrollbar_style_updated;
+
+ gtk_widget_class_install_style_property (widget_class,
+ g_param_spec_int ("min-slider-length",
+ P_("Minimum Slider Length"),
+ P_("Minimum length of scrollbar slider"),
+ 0,
+ G_MAXINT,
+ 21,
+ GTK_PARAM_READABLE));
+
+ gtk_widget_class_install_style_property (widget_class,
+ g_param_spec_boolean ("fixed-slider-length",
+ P_("Fixed slider size"),
+ P_("Don't change slider size, just lock it to the minimum length"),
+ FALSE,
+ GTK_PARAM_READABLE));
+
+ gtk_widget_class_install_style_property (widget_class,
+ g_param_spec_boolean ("has-backward-stepper",
+ P_("Backward stepper"),
+ P_("Display the standard backward arrow button"),
+ TRUE,
+ GTK_PARAM_READABLE));
+
+ gtk_widget_class_install_style_property (widget_class,
+ g_param_spec_boolean ("has-forward-stepper",
+ P_("Forward stepper"),
+ P_("Display the standard forward arrow button"),
+ TRUE,
+ GTK_PARAM_READABLE));
+
+ gtk_widget_class_install_style_property (widget_class,
+ g_param_spec_boolean ("has-secondary-backward-stepper",
+ P_("Secondary backward stepper"),
+ P_("Display a second backward arrow button on the opposite end of the scrollbar"),
+ FALSE,
+ GTK_PARAM_READABLE));
+
+ gtk_widget_class_install_style_property (widget_class,
+ g_param_spec_boolean ("has-secondary-forward-stepper",
+ P_("Secondary forward stepper"),
+ P_("Display a second forward arrow button on the opposite end of the scrollbar"),
+ FALSE,
+ GTK_PARAM_READABLE));
}
static void
gtk_scrollbar_init (GtkScrollbar *scrollbar)
{
+ GtkStyleContext *context;
+
+ context = gtk_widget_get_style_context (GTK_WIDGET (scrollbar));
+ gtk_style_context_add_class (context, GTK_STYLE_CLASS_SCROLLBAR);
+}
+
+static void
+gtk_scrollbar_style_updated (GtkWidget *widget)
+{
+ GtkRange *range = GTK_RANGE (widget);
+ gint slider_length;
+ gboolean fixed_size;
+ gboolean has_a, has_b, has_c, has_d;
+
+ gtk_widget_style_get (widget,
+ "min-slider-length", &slider_length,
+ "fixed-slider-length", &fixed_size,
+ "has-backward-stepper", &has_a,
+ "has-secondary-forward-stepper", &has_b,
+ "has-secondary-backward-stepper", &has_c,
+ "has-forward-stepper", &has_d,
+ NULL);
+
+ gtk_range_set_min_slider_size (range, slider_length);
+ gtk_range_set_slider_size_fixed (range, fixed_size);
+ _gtk_range_set_steppers (range,
+ has_a, has_b, has_c, has_d);
+
+ GTK_WIDGET_CLASS (gtk_scrollbar_parent_class)->style_updated (widget);
+}
+
+/**
+ * gtk_scrollbar_new:
+ * @orientation: the scrollbar's orientation.
+ * @adjustment: (allow-none): the #GtkAdjustment to use, or %NULL to create a new adjustment.
+ *
+ * Creates a new scrollbar with the given orientation.
+ *
+ * Return value: the new #GtkScrollbar.
+ *
+ * Since: 3.0
+ **/
+GtkWidget *
+gtk_scrollbar_new (GtkOrientation orientation,
+ GtkAdjustment *adjustment)
+{
+ g_return_val_if_fail (adjustment == NULL || GTK_IS_ADJUSTMENT (adjustment),
+ NULL);
+
+ return g_object_new (GTK_TYPE_SCROLLBAR,
+ "orientation", orientation,
+ "adjustment", adjustment,
+ NULL);
}
projects / ~andy / gtk / blobdiff