Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkscrollbar.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkScrollbar
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Base class for GtkHScrollbar and GtkVScrollbar
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 The #GtkScrollbar widget is an abstract base class for #GtkHScrollbar and
  10 #GtkVScrollbar. It is not very useful in itself.
  11 </para>
  12
  13 <para>
  14 The position of the thumb in a scrollbar is controlled by the scroll
  15 adjustments. See #GtkAdjustment for the fields in an adjustment - for
  16 #GtkScrollbar, the "value" field represents the position of the
  17 scrollbar, which must be between the "lower" field and "upper -
  18 page_size." The "page_size" field represents the size of the visible
  19 scrollable area. The "step_increment" and "page_increment" fields are
  20 used when the user asks to step down (using the small stepper arrows)
  21 or page down (using for example the PageDown key).
  22 </para>
  23
  24 <!-- ##### SECTION See_Also ##### -->
  25 <para>
  26 <variablelist>
  27
  28 <varlistentry>
  29 <term>#GtkHScrollbar</term>
  30 <listitem><para>a horizontal scrollbar.</para></listitem>
  31 </varlistentry>
  32
  33 <varlistentry>
  34 <term>#GtkVScrollbar</term>
  35 <listitem><para>a vertical scrollbar.</para></listitem>
  36 </varlistentry>
  37
  38 <varlistentry>
  39 <term>#GtkAdjustment</term>
  40 <listitem><para>connects scrollbars to the widget being scrolled.</para></listitem>
  41 </varlistentry>
  42
  43 <varlistentry>
  44 <term>#GtkScrolledWindow</term>
  45 <listitem><para>convenient widget for setting up scrolling.</para></listitem>
  46 </varlistentry>
  47
  48 </variablelist>
  49 </para>
  50
  51 <!-- ##### SECTION Stability_Level ##### -->
  52
  53
  54 <!-- ##### STRUCT GtkScrollbar ##### -->
  55 <para>
  56 The #GtkScrollbar struct does not contain any public data.
  57 </para>
  58
  59
  60 <!-- ##### ARG GtkScrollbar:fixed-slider-length ##### -->
  61 <para>
  62
  63 </para>
  64
  65 <!-- ##### ARG GtkScrollbar:has-backward-stepper ##### -->
  66 <para>
  67
  68 </para>
  69
  70 <!-- ##### ARG GtkScrollbar:has-forward-stepper ##### -->
  71 <para>
  72
  73 </para>
  74
  75 <!-- ##### ARG GtkScrollbar:has-secondary-backward-stepper ##### -->
  76 <para>
  77
  78 </para>
  79
  80 <!-- ##### ARG GtkScrollbar:has-secondary-forward-stepper ##### -->
  81 <para>
  82
  83 </para>
  84
  85 <!-- ##### ARG GtkScrollbar:min-slider-length ##### -->
  86 <para>
  87
  88 </para>
  89