1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-gtkscrollbar">
<refnamediv>
<refname>gtk.Scrollbar</refname>
<refpurpose>a base class for scrollbar widgets.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.Scrollbar</classname></ooclass>
<ooclass><classname><link
linkend="class-gtkrange">gtk.Range</link></classname></ooclass>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gtkobject">gtk.Object</link>
+-- <link linkend="class-gtkwidget">gtk.Widget</link>
+-- <link linkend="class-gtkrange">gtk.Range</link>
+-- <link linkend="class-gtkscrollbar">gtk.Scrollbar</link>
</synopsis>
</refsect1>
<refsect1>
<title>Implemented Interfaces</title>
<para>
<link linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link>
implements
<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
</para>
</refsect1>
<refsect1 id="properties-gtkscrollbar">
<title>gtk.Scrollbar Properties</title>
<para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
<para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
<para><link linkend="properties-gtkrange">gtk.Range Properties</link></para>
</refsect1>
<refsect1 id="style-properties-gtkscrollbar">
<title>gtk.Scrollbar Style Properties</title>
<para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
<para><link linkend="style-properties-gtkrange">gtk.Range Style Properties</link></para>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
<tgroup cols="3">
<colspec column="1" colwidth="1in"/>
<colspec column="2" colwidth="1in"/>
<colspec column="3" colwidth="4in"/>
<tbody>
<row valign="top">
<entry>"fixed-slider-length"</entry>
<entry>Read</entry>
<entry>If <literal>True</literal> don't change the slider
size, just lock it to the minimum length</entry>
</row>
<row valign="top">
<entry>"has-backward-stepper"</entry>
<entry>Read</entry>
<entry>If <literal>True</literal> display the standard
backward arrow button</entry>
</row>
<row valign="top">
<entry>"has-forward-stepper"</entry>
<entry>Read</entry>
<entry>If <literal>True</literal> display the standard forward
arrow button</entry>
</row>
<row valign="top">
<entry>"has-secondary-backward-stepper"</entry>
<entry>Read</entry>
<entry>If <literal>True</literal> display a second backward
arrow button on the opposite end of the scrollbar</entry>
</row>
<row valign="top">
<entry>"has-secondary-forward-stepper"</entry>
<entry>Read</entry>
<entry>If <literal>True</literal> display a secondary forward
arrow button on the opposite end of the scrollbar</entry>
</row>
<row valign="top">
<entry>min-slider-length""</entry>
<entry>Read</entry>
<entry>The minimum length of scrollbar slider</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="signal-prototypes-gtkscrollbar">
<title>gtk.Scrollbar Signal Prototypes</title>
<para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkrange">gtk.Range Signal Prototypes</link></para>
</refsect1>
<refsect1>
<title>Description</title>
<para>The <link
linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link>
widget is an abstract base class for <link
linkend="class-gtkhscrollbar"><classname>gtk.HScrollbar</classname></link>
and <link
linkend="class-gtkvscrollbar"><classname>gtk.VScrollbar</classname></link>.
The position of the thumb in a scrollbar is controlled by the scroll
adjustments. The <link
linkend="class-gtkscrollbar"><classname>gtk.Scrollbar</classname></link> uses the attributes in an adjustment (see <link
linkend="class-gtkadjustment"><classname>gtk.Adjustment</classname></link>) as follows:</para>
<itemizedlist>
<listitem>
<simpara>the <literal>adjustment.lower</literal> attribute is the
minimum value of the scroll region</simpara>
</listitem>
<listitem>
<simpara>the <literal>adjustment.upper</literal> attribute is the
maximum value of the scroll region</simpara>
</listitem>
<listitem>
<simpara>the <literal>adjustment.value</literal> attribute
represents the position of the scrollbar, which must be between
<literal>adjustment.lower</literal> and <literal>adjustment.upper</literal>
- <literal>adjustment.page_size</literal></simpara>
</listitem>
<listitem>
<simpara>the <literal>adjustment.page_size</literal> attribute
represents the size of the visible scrollable area</simpara>
</listitem>
<listitem>
<simpara>the <literal>adjustment.step_increment</literal> attribute
is the distance to scroll when the small stepper arrows are clicked</simpara>
</listitem>
<listitem>
<simpara>the <literal>adjustment.page_increment</literal> attribute
is the distance to scroll when the <keycap>Page Up</keycap> or <keycap>Page
Down</keycap> keys are pressed</simpara>
</listitem>
</itemizedlist>
</refsect1>
</refentry>
|