gtkscrollbar.sgml 2.02 KB
Newer Older
Owen Taylor's avatar
Owen Taylor committed
1 2 3 4
<!-- ##### SECTION Title ##### -->
GtkScrollbar

<!-- ##### SECTION Short_Description ##### -->
Damon Chaplin's avatar
Damon Chaplin committed
5
base class for #GtkHScrollbar and GtkVScrollbar.
Owen Taylor's avatar
Owen Taylor committed
6 7 8

<!-- ##### SECTION Long_Description ##### -->
<para>
Damon Chaplin's avatar
Damon Chaplin committed
9 10
The #GtkScrollbar widget is an abstract base class for #GtkHScrollbar and
#GtkVScrollbar. It is not very useful in itself.
Owen Taylor's avatar
Owen Taylor committed
11 12
</para>

13 14 15 16 17 18 19 20 21 22 23
<para>
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 "value" field represents the position of the
scrollbar, which must be between the "lower" field and "upper -
page_size." The "page_size" field represents the size of the visible
scrollable area. The "step_increment" and "page_increment" fields are
used when the user asks to step down (using the small stepper arrows)
or page down (using for example the PageDown key).
</para>

Owen Taylor's avatar
Owen Taylor committed
24 25
<!-- ##### SECTION See_Also ##### -->
<para>
Damon Chaplin's avatar
Damon Chaplin committed
26 27 28 29 30 31
<variablelist>

<varlistentry>
<term>#GtkHScrollbar</term>
<listitem><para>a horizontal scrollbar.</para></listitem>
</varlistentry>
Owen Taylor's avatar
Owen Taylor committed
32

Damon Chaplin's avatar
Damon Chaplin committed
33 34 35 36 37
<varlistentry>
<term>#GtkVScrollbar</term>
<listitem><para>a vertical scrollbar.</para></listitem>
</varlistentry>

38 39 40 41 42 43 44 45 46 47
<varlistentry>
<term>#GtkAdjustment</term>
<listitem><para>connects scrollbars to the widget being scrolled.</para></listitem>
</varlistentry>

<varlistentry>
<term>#GtkScrolledWindow</term>
<listitem><para>convenient widget for setting up scrolling.</para></listitem>
</varlistentry>

Damon Chaplin's avatar
Damon Chaplin committed
48
</variablelist>
Owen Taylor's avatar
Owen Taylor committed
49 50 51 52
</para>

<!-- ##### STRUCT GtkScrollbar ##### -->
<para>
Damon Chaplin's avatar
Damon Chaplin committed
53
The #GtkScrollbar struct does not contain any public data.
Owen Taylor's avatar
Owen Taylor committed
54 55 56
</para>


Soeren Sandmann's avatar
Soeren Sandmann committed
57
<!-- ##### ARG GtkScrollbar:has-forward-stepper ##### -->
58 59 60 61
<para>

</para>

Soeren Sandmann's avatar
Soeren Sandmann committed
62
<!-- ##### ARG GtkScrollbar:has-secondary-backward-stepper ##### -->
63 64 65 66
<para>

</para>

Soeren Sandmann's avatar
Soeren Sandmann committed
67
<!-- ##### ARG GtkScrollbar:has-backward-stepper ##### -->
68 69 70 71
<para>

</para>

72
<!-- ##### ARG GtkScrollbar:has-secondary-forward-stepper ##### -->
73 74 75 76
<para>

</para>

Soeren Sandmann's avatar
Soeren Sandmann committed
77
<!-- ##### ARG GtkScrollbar:min-slider-length ##### -->
78 79 80 81
<para>

</para>

Soeren Sandmann's avatar
Soeren Sandmann committed
82
<!-- ##### ARG GtkScrollbar:fixed-slider-length ##### -->
83 84 85 86
<para>

</para>