Commit 96f2f2ff authored by Javier Jardón's avatar Javier Jardón

gtkscrollbar: Move documentation to inline comments

parent ec0c7395
......@@ -36,6 +36,7 @@ gtkrecentchooserwidget.sgml
gtkrecentmanager.sgml
gtkscale.sgml
gtkscalebutton.sgml
gtkscrollbar.sgml
gtkscrolledwindow.sgml
gtkseparator.sgml
gtkseparatormenuitem.sgml
......
<!-- ##### SECTION Title ##### -->
GtkScrollbar
<!-- ##### SECTION Short_Description ##### -->
Base class for GtkHScrollbar and GtkVScrollbar
<!-- ##### SECTION Long_Description ##### -->
<para>
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.
</para>
<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>
<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>
<varlistentry>
<term>#GtkHScrollbar</term>
<listitem><para>a horizontal scrollbar.</para></listitem>
</varlistentry>
<varlistentry>
<term>#GtkVScrollbar</term>
<listitem><para>a vertical scrollbar.</para></listitem>
</varlistentry>
<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>
</variablelist>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### SECTION Image ##### -->
<!-- ##### STRUCT GtkScrollbar ##### -->
<para>
The #GtkScrollbar struct does not contain any public data.
</para>
<!-- ##### ARG GtkScrollbar:fixed-slider-length ##### -->
<para>
</para>
<!-- ##### ARG GtkScrollbar:has-backward-stepper ##### -->
<para>
</para>
<!-- ##### ARG GtkScrollbar:has-forward-stepper ##### -->
<para>
</para>
<!-- ##### ARG GtkScrollbar:has-secondary-backward-stepper ##### -->
<para>
</para>
<!-- ##### ARG GtkScrollbar:has-secondary-forward-stepper ##### -->
<para>
</para>
<!-- ##### ARG GtkScrollbar:min-slider-length ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_scrollbar_new ##### -->
<para>
</para>
@orientation:
@adjustment:
@Returns:
......@@ -31,6 +31,31 @@
#include "gtkintl.h"
#include "gtkprivate.h"
/**
* 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_set (GtkWidget *widget,
GtkStyle *previous);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment