Minor documentation improvements

[~andy/gtk] / gtk / gtkscrollbar.c

diff --git a/gtk/gtkscrollbar.c b/gtk/gtkscrollbar.c
index 34ef5b60ce2b1b4bca8d911f4c9e3f5f9af33b10..4a852f2bed3aca7332c3bb9681af1181cf763990 100644 (file)
--- a/gtk/gtkscrollbar.c
+++ b/gtk/gtkscrollbar.c
@@ -31,8 +31,32 @@
 #include "gtkintl.h"
 #include "gtkprivate.h"
 
-static void gtk_scrollbar_style_set (GtkWidget *widget,
-                                     GtkStyle  *previous);
+
+/**
+ * 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)
 
@@ -41,9 +65,7 @@ gtk_scrollbar_class_init (GtkScrollbarClass *class)
 {
   GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
 
-  widget_class->style_set = gtk_scrollbar_style_set;
-
-  GTK_RANGE_CLASS (class)->stepper_detail = "Xscrollbar";
+  widget_class->style_updated = gtk_scrollbar_style_updated;
 
   gtk_widget_class_install_style_property (widget_class,
                                           g_param_spec_int ("min-slider-length",
@@ -93,11 +115,14 @@ gtk_scrollbar_class_init (GtkScrollbarClass *class)
 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_set (GtkWidget *widget,
-                         GtkStyle  *previous)
+gtk_scrollbar_style_updated (GtkWidget *widget)
 {
   GtkRange *range = GTK_RANGE (widget);
   gint slider_length;
@@ -113,15 +138,12 @@ gtk_scrollbar_style_set (GtkWidget *widget,
                         "has-forward-stepper", &has_d,
                         NULL);
 
-  range->min_slider_size = slider_length;
-  range->slider_size_fixed = fixed_size;
-
-  range->has_stepper_a = has_a;
-  range->has_stepper_b = has_b;
-  range->has_stepper_c = has_c;
-  range->has_stepper_d = has_d;
+  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_set (widget, previous);
+  GTK_WIDGET_CLASS (gtk_scrollbar_parent_class)->style_updated (widget);
 }
 
 /**