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
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.Range</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtkradiotoolbutton.html" title="gtk.RadioToolButton"><link rel="next" href="class-gtkrcstyle.html" title="gtk.RcStyle"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.Range</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkradiotoolbutton.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkrcstyle.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkrange"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.Range</h2><p>gtk.Range — a base class for widgets that allow a user to set a value in
a range.</p></div><div class="refsect1" lang="en"><a name="id3445496"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.Range</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a></span></span>):
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrange.html#method-gtkrange--set-update-policy" title="gtk.Range.set_update_policy">set_update_policy</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>policy</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrange.html#method-gtkrange--get-update-policy" title="gtk.Range.get_update_policy">get_update_policy</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrange.html#method-gtkrange--set-adjustment" title="gtk.Range.set_adjustment">set_adjustment</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>adjustment</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrange.html#method-gtkrange--get-adjustment" title="gtk.Range.get_adjustment">get_adjustment</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrange.html#method-gtkrange--set-inverted" title="gtk.Range.set_inverted">set_inverted</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>setting</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrange.html#method-gtkrange--get-inverted" title="gtk.Range.get_inverted">get_inverted</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrange.html#method-gtkrange--set-increments" title="gtk.Range.set_increments">set_increments</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>step</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrange.html#method-gtkrange--set-range" title="gtk.Range.set_range">set_range</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>min</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>max</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrange.html#method-gtkrange--set-value" title="gtk.Range.set_value">set_value</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>value</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrange.html#method-gtkrange--get-value" title="gtk.Range.get_value">get_value</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrange.html#method-gtkrange--get-fill-level" title="gtk.Range.get_fill_level">get_fill_level</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrange.html#method-gtkrange--set-fill-level" title="gtk.Range.set_fill_level">set_fill_level</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>fill_level</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrange.html#method-gtkrange--get-restrict-to-fill-level" title="gtk.Range.get_restrict_to_fill_level">get_restrict_to_fill_level</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrange.html#method-gtkrange--set-restrict-to-fill-level" title="gtk.Range.set_restrict_to_fill_level">set_restrict_to_fill_level</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>restrict_to_fill_level</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrange.html#method-gtkrange--get-show-fill-level" title="gtk.Range.get_show_fill_level">get_show_fill_level</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkrange.html#method-gtkrange--set-show-fill-level" title="gtk.Range.set_show_fill_level">set_show_fill_level</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>show_fill_level</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3445943"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
+-- <a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
+-- <a class="link" href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
+-- <a class="link" href="class-gtkrange.html" title="gtk.Range">gtk.Range</a>
</pre></div><div class="refsect1" lang="en"><a name="id3445982"></a><h2>Implemented Interfaces</h2><p>
<a class="link" href="class-gtkrange.html" title="gtk.Range"><code class="classname">gtk.Range</code></a>
implements
<a class="link" href="class-gtkbuildable.html" title="gtk.Buildable"><code class="classname">gtk.Buildable</code></a>
</p></div><div class="refsect1" lang="en"><a name="properties-gtkrange"></a><h2>gtk.Range Properties</h2><p><a class="link" href="class-gtkobject.html#properties-gtkobject" title="gtk.Object Properties">gtk.Object Properties</a></p><p><a class="link" href="class-gtkwidget.html#properties-gtkwidget" title="gtk.Widget Properties">gtk.Widget Properties</a></p><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"adjustment"</td><td valign="top">Read-Write</td><td valign="top">The <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
that contains the current value of this range object</td></tr><tr valign="top"><td valign="top">"fill-level"</td><td valign="top">Read-Write</td><td valign="top">The fill level (e.g. prebuffering of a network stream).
See <code class="methodname"><a class="link" href="class-gtkrange.html#method-gtkrange--set-fill-level" title="gtk.Range.set_fill_level">gtk.Range.set_fill_level</a></code>().
Default value: 1.79769e+308. Available in GTK+ 2.12.</td></tr><tr valign="top"><td valign="top">"inverted"</td><td valign="top">Read-Write</td><td valign="top">If <code class="literal">True</code>, the slider movement is
reversed e.g right-to-left instead of left-to-right</td></tr><tr valign="top"><td valign="top">"lower-stepper-sensitivity"</td><td valign="top">Read-Write</td><td valign="top">The sensitivity policy for the stepper that points to the
adjustment's lower side</td></tr><tr valign="top"><td valign="top">"restrict-to-fill-level"</td><td valign="top">Read-Write</td><td valign="top">The restrict-to-fill-level property controls whether slider movement is restricted to
an upper boundary set by the fill level. See
<code class="methodname"><a class="link" href="class-gtkrange.html#method-gtkrange--get-restrict-to-fill-level" title="gtk.Range.get_restrict_to_fill_level">gtk.Range.get_restrict_to_fill_level</a></code>().
Default value: True. Available in GTK+ 2.12.</td></tr><tr valign="top"><td valign="top">"update-policy"</td><td valign="top">Read-Write</td><td valign="top">How the range should be updated on the screen:
<code class="literal">gtk.UPDATE_CONTINUOUS</code>,
<code class="literal">gtk.UPDATE_DISCONTINUOUS</code>,
<code class="literal">gtk.UPDATE_DELAYED</code>.</td></tr><tr valign="top"><td valign="top">"show-fill-level"</td><td valign="top">Read-Write</td><td valign="top">The show-fill-level property controls whether fill level indicator graphics are displayed on the trough. See gtk_range_set_show_fill_level().
<code class="methodname"><a class="link" href="class-gtkrange.html#method-gtkrange--set-show-fill-level" title="gtk.Range.set_show_fill_level">gtk.Range.set_show_fill_level</a></code>().
Default value: False. Available in GTK+ 2.12.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="style-properties-gtkrange"></a><h2>gtk.Range Style Properties</h2><p><a class="link" href="class-gtkwidget.html#style-properties-gtkwidget" title="gtk.Widget Style Properties">gtk.Widget Style Properties</a></p><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"activate-slider"</td><td valign="top">Read</td><td valign="top">With this option set to <code class="literal">True</code>,
sliders will be drawn <code class="literal">ACTIVE</code> and with
shadow <code class="literal">IN</code> while they are dragged</td></tr><tr valign="top"><td valign="top">"arrow-displacement-x"</td><td valign="top">Read</td><td valign="top">The distance horizontally to move the arrow when the
button is depressed</td></tr><tr valign="top"><td valign="top">"arrow-displacement-y"</td><td valign="top">Read</td><td valign="top">The distance vertically to move the arrow when the
button is depressed</td></tr><tr valign="top"><td valign="top">"slider-width"</td><td valign="top">Read</td><td valign="top">The width of scrollbar or scale thumb</td></tr><tr valign="top"><td valign="top">"stepper-size"</td><td valign="top">Read</td><td valign="top">The length of step buttons at ends</td></tr><tr valign="top"><td valign="top">"stepper-spacing"</td><td valign="top">Read</td><td valign="top">The spacing between step buttons and thumb</td></tr><tr valign="top"><td valign="top">"trough-border"</td><td valign="top">Read</td><td valign="top">The spacing between thumb or steppers and outer trough
bevel</td></tr><tr valign="top"><td valign="top">"trough-side-details"</td><td valign="top">Read</td><td valign="top">This property is available in GTK+ 2.10 and above.</td></tr><tr valign="top"><td valign="top">"trough-under-steppers"</td><td valign="top">Read</td><td valign="top">if <code class="literal">True</code> draw the trough across the
full length of the range or to exclude the steppers and their
spacing. Note that setting the "stepper-spacing" style
property to any value > 0 will automatically enable
"trough-under-steppers" too. This property is available in
GTK+ 2.10 and above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtkrange"></a><h2>gtk.Range Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><p><a class="link" href="class-gtkobject.html#signal-prototypes-gtkobject" title="gtk.Object Signal Prototypes">gtk.Object Signal Prototypes</a></p><p><a class="link" href="class-gtkwidget.html#signal-prototypes-gtkwidget" title="gtk.Widget Signal Prototypes">gtk.Widget Signal Prototypes</a></p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gtkrange.html#signal-gtkrange--adjust-bounds" title='The "adjust-bounds" gtk.Range Signal'>adjust-bounds</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>range</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>value</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkrange.html#signal-gtkrange--change-value" title='The "change-value" gtk.Range Signal'>change-value</a></span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>range</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>scroll</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>value</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>arg1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>arg2</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkrange.html#signal-gtkrange--move-slider" title='The "move-slider" gtk.Range Signal'>move-slider</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>range</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>scrolltype</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><p><span class="term">"<a class="link" href="class-gtkrange.html#signal-gtkrange--value-changed" title='The "value-changed" gtk.Range Signal'>value-changed</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>range</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id3446882"></a><h2>Description</h2><p>The <a class="link" href="class-gtkrange.html" title="gtk.Range"><code class="classname">gtk.Range</code></a> is the base
class for the <a class="link" href="class-gtkscale.html" title="gtk.Scale"><code class="classname">gtk.Scale</code></a> and <a class="link" href="class-gtkscrollbar.html" title="gtk.Scrollbar"><code class="classname">gtk.Scrollbar</code></a>
widgets. The <a class="link" href="class-gtkrange.html" title="gtk.Range"><code class="classname">gtk.Range</code></a> provides
the common functionality for these widgets that allow a user to set a value
in a range of values. The <a class="link" href="class-gtkscale.html" title="gtk.Scale"><code class="classname">gtk.Scale</code></a> works in
conjunction with a <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
which provides the range information.</p></div><div class="refsect1" lang="en"><a name="id3446939"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkrange--set-update-policy"></a><h3>gtk.Range.set_update_policy</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_update_policy</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>policy</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>policy</code></strong> :</span></p></td><td>the update policy:
<code class="literal">gtk.UPDATE_CONTINUOUS</code>,
<code class="literal">gtk.UPDATE_DISCONTINUOUS</code>,
<code class="literal">gtk.UPDATE_DELAYED</code></td></tr></tbody></table><p>The <code class="methodname">set_update_policy</code>() method sets the
"update-policy" property to the value specified by
<em class="parameter"><code>policy</code></em>. The update policy has the following values
and effects:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><code class="literal">gtk.UPDATE_CONTINUOUS</code></span></p></td><td>anytime the range slider is moved, the range value will
change and the "value_changed" signal will be emitted.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.UPDATE_DELAYED</code></span></p></td><td>the value will be updated after a brief timeout where
no slider motion occurs, so value changes are delayed slightly rather than
continuously updated.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.UPDATE_DISCONTINUOUS</code></span></p></td><td>the value will only be updated when the user releases
the button and ends the slider drag operation.</td></tr></tbody></table><p></p></div><div class="refsect2" lang="en"><a name="method-gtkrange--get-update-policy"></a><h3>gtk.Range.get_update_policy</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_update_policy</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the current update policy</td></tr></tbody></table><p>The <code class="methodname">get_update_policy</code>() method gets the
value of the "update-policy" property. The update policy is one of:
<code class="literal">gtk.UPDATE_CONTINUOUS</code>,
<code class="literal">gtk.UPDATE_DISCONTINUOUS</code> or
<code class="literal">gtk.UPDATE_DELAYED</code>. See the <a class="link" href="class-gtkrange.html#method-gtkrange--set-update-policy" title="gtk.Range.set_update_policy"><code class="methodname">set_update_policy</code>()</a>
method for details.</p></div><div class="refsect2" lang="en"><a name="method-gtkrange--set-adjustment"></a><h3>gtk.Range.set_adjustment</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_adjustment</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>adjustment</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>adjustment</code></strong> :</span></p></td><td>a <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a></td></tr></tbody></table><p>The <code class="methodname">set_adjustment</code>() method sets the
"adjustment" property to the value specified by
<em class="parameter"><code>adjustment</code></em>. The <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
is used as the "model" object for this range widget.
<em class="parameter"><code>adjustment</code></em> indicates the current range value, the
minimum and maximum range values, the step and page increments used for
keybindings and scrolling, and the page size. The page size is normally 0
for <a class="link" href="class-gtkscale.html" title="gtk.Scale"><code class="classname">gtk.Scale</code></a>
and nonzero for <a class="link" href="class-gtkscrollbar.html" title="gtk.Scrollbar"><code class="classname">gtk.Scrollbar</code></a>,
and indicates the size of the visible area of the widget being scrolled. The
page size affects the size of the scrollbar slider.</p></div><div class="refsect2" lang="en"><a name="method-gtkrange--get-adjustment"></a><h3>gtk.Range.get_adjustment</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_adjustment</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a></td></tr></tbody></table><p>The <code class="methodname">get_adjustment</code>() method returns the
value of the "adjustment" property. See the <a class="link" href="class-gtkrange.html#method-gtkrange--set-adjustment" title="gtk.Range.set_adjustment"><code class="methodname">set_adjustment</code>()</a>
method for details.</p></div><div class="refsect2" lang="en"><a name="method-gtkrange--set-inverted"></a><h3>gtk.Range.set_inverted</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_inverted</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>setting</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>setting</code></strong> :</span></p></td><td>if <code class="literal">True</code> invert the
range</td></tr></tbody></table><p>The <code class="methodname">set_inverted</code>() method sets the
"inverted" property to the value specified by
<em class="parameter"><code>setting</code></em>. If <em class="parameter"><code>setting</code></em> is
<code class="literal">True</code> the normal motion of the range widget is reversed.
Ranges normally move from lower to higher values as the slider moves from
top to bottom or left to right. Inverted ranges have higher values at the
top or left rather than on the bottom or right.</p></div><div class="refsect2" lang="en"><a name="method-gtkrange--get-inverted"></a><h3>gtk.Range.get_inverted</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_inverted</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the range is
inverted</td></tr></tbody></table><p>The <code class="methodname">get_inverted</code>() method returns the
value of the "inverted" property that was set by the <a class="link" href="class-gtkrange.html#method-gtkrange--set-inverted" title="gtk.Range.set_inverted"><code class="methodname">set_inverted</code>()</a>
method.</p></div><div class="refsect2" lang="en"><a name="method-gtkrange--set-increments"></a><h3>gtk.Range.set_increments</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_increments</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>step</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>page</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>step</code></strong> :</span></p></td><td>the step size</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>page</code></strong> :</span></p></td><td>the page size</td></tr></tbody></table><p>The <code class="methodname">set_increments</code>() method sets the
step and page sizes for the range to the values specified by
<em class="parameter"><code>step</code></em> and <em class="parameter"><code>page</code></em> respectively.
The step size is used when the user clicks the <a class="link" href="class-gtkscrollbar.html" title="gtk.Scrollbar"><code class="classname">gtk.Scrollbar</code></a>
arrows or moves <a class="link" href="class-gtkscale.html" title="gtk.Scale"><code class="classname">gtk.Scale</code></a> via the
arrow keys. The page size is used for example when moving via <span class="keycap"><strong>Page
Up</strong></span> or <span class="keycap"><strong>Page Down</strong></span> keys.</p></div><div class="refsect2" lang="en"><a name="method-gtkrange--set-range"></a><h3>gtk.Range.set_range</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_range</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>min</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>max</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>min</code></strong> :</span></p></td><td>the minimum range value</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>max</code></strong> :</span></p></td><td>the maximum range value</td></tr></tbody></table><p>The <code class="methodname">set_range</code>() method sets the minimum
and maximum allowable values for the <a class="link" href="class-gtkrange.html" title="gtk.Range"><code class="classname">gtk.Range</code></a> to that
values specified by <em class="parameter"><code>min</code></em> and
<em class="parameter"><code>max</code></em> respectively. If the range has a non-zero page
size, it is also forced to be between <em class="parameter"><code>min</code></em> and
<em class="parameter"><code>max</code></em>.</p></div><div class="refsect2" lang="en"><a name="method-gtkrange--set-value"></a><h3>gtk.Range.set_value</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_value</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>value</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>value</code></strong> :</span></p></td><td>the new value of the range</td></tr></tbody></table><p>The <code class="methodname">set_value</code>() method sets the current
value of the range to the value specified by <em class="parameter"><code>value</code></em>.
<em class="parameter"><code>value</code></em> will be forced inside the minimum or maximum
range values. The range emits the "value_changed" signal if the value
changes.</p></div><div class="refsect2" lang="en"><a name="method-gtkrange--get-value"></a><h3>gtk.Range.get_value</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_value</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the current value of the
range.</td></tr></tbody></table><p>The <code class="methodname">get_value</code>() method gets the current
value of the range.</p><div class="refsect2" lang="en"><a name="method-gtkrange--set-fill-level"></a><h3>gtk.Range.set_fill_level</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_fill_level</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>fill_level</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>fill_level</code></strong> :</span></p></td><td>the new position of the fill level indicator.</td></tr></tbody></table><p>
The <code class="methodname">set_fill_level</code>() method sets
the new position of the fill level indicator.
</p><p>
The "fill level" is probably best described by its most prominent use case,
which is an indicator for the amount of pre-buffering in a streaming media
player. In that use case, the value of the range would indicate the current
play position, and the fill level would be the position up to which the
file/stream has been downloaded.
</p><p>
This amount of prebuffering can be displayed on the range's trough and is
themeable separately from the trough. To enable fill level display, use
<code class="methodname"><a class="link" href="class-gtkrange.html#method-gtkrange--set-show-fill-level" title="gtk.Range.set_show_fill_level">gtk.Range.set_show_fill_level</a></code>().
The range defaults to not showing the fill level.
</p><p>
Additionally, it's possible to restrict the range's slider position to values
which are smaller than the fill level. This is controller by
<code class="methodname"><a class="link" href="class-gtkrange.html#method-gtkrange--set-restrict-to-fill-level" title="gtk.Range.set_restrict_to_fill_level">gtk.Range.set_restrict_to_fill_level</a></code>()
and is by default enabled.
</p></div><div class="refsect2" lang="en"><a name="method-gtkrange--get-fill-level"></a><h3>gtk.Range.get_fill_level</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_fill_level</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>The current fill level.</td></tr></tbody></table><p>
The <code class="methodname">get_fill_level</code>() method gets the current
position of the fill level indicator.
</p></div></div><div class="refsect2" lang="en"><a name="method-gtkrange--set-restrict-to-fill-level"></a><h3>gtk.Range.set_restrict_to_fill_level</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_restrict_to_fill_level</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>restrict_to_fill_level</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>restrict_to_fill_level</code></strong> :</span></p></td><td>Whether the fill level restricts slider movement.</td></tr></tbody></table><p>
The <code class="methodname">set_restrict_to_fill_level</code>() method sets
whether the slider is restricted to the fill level. See
<code class="methodname"><a class="link" href="class-gtkrange.html#method-gtkrange--set-fill-level" title="gtk.Range.set_fill_level">gtk.Range.set_fill_level</a></code>()
for a general description of the fill level concept.
</p></div><div class="refsect2" lang="en"><a name="method-gtkrange--get-restrict-to-fill-level"></a><h3>gtk.Range.get_restrict_to_fill_level</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_restrict_to_fill_level</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if range is
restricted to the fill level.</td></tr></tbody></table><p>
The <code class="methodname">get_restrict_to_fill_level</code>() method gets
whether the range is restricted to the fill level.
</p></div><div class="refsect2" lang="en"><a name="method-gtkrange--set-show-fill-level"></a><h3>gtk.Range.set_show_fill_level</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_show_fill_level</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>show_fill_level</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>show_fill_level</code></strong> :</span></p></td><td>Whether a fill level indicator graphics is shown.</td></tr></tbody></table><p>
The <code class="methodname">set_show_fill_level</code>() method sets
whether a graphical fill level is show on the trough. See
<code class="methodname"><a class="link" href="class-gtkrange.html#method-gtkrange--set-fill-level" title="gtk.Range.set_fill_level">gtk.Range.set_fill_level</a></code>()
for a general description of the fill level concept.
</p></div><div class="refsect2" lang="en"><a name="method-gtkrange--get-show-fill-level"></a><h3>gtk.Range.get_show_fill_level</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_show_fill_level</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if range shows the
fill level.</td></tr></tbody></table><p>
The <code class="methodname">get_show_fill_level</code>() method gets
whether the range displays the fill level graphically.
</p></div></div><div class="refsect1" lang="en"><a name="id3448451"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkrange--adjust-bounds"></a><h3>The "adjust-bounds" gtk.Range Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>range</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>value</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>range</code></em> :</span></p></td><td>the range that received the
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td><td>the value</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
any)</td></tr></tbody></table><p>The "adjust-bounds" signal is emitted when the range is adjusted
by user action. Note the value can be more or less than the range since it
depends on the mouse position.</p></div><div class="refsect2" lang="en"><a name="signal-gtkrange--change-value"></a><h3>The "change-value" gtk.Range Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>range</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>scroll</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>value</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>range</code></em> :</span></p></td><td>the range that received the signal. the object
which received the signal.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>scroll</code></em> :</span></p></td><td>the type of scroll action that was performed -
one of the <a class="xref" href="gtk-constants.html#gtk-scroll-type-constants" title="GTK Scroll Type Constants">GTK Scroll Type Constants</a>..</td></tr><tr><td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td><td>the new value resulting from the scroll
action.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if any)</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> to prevent other
handlers from being invoked for the signal or
<code class="literal">False</code> to propagate the signal
further.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This signal is available in GTK+ 2.6 and above.</p></div><p>The "change-value" signal is emitted when a scroll action is
performed on a range. It allows an application to determine the type
of scroll event that occurred and the resultant new value. The
application can handle the event itself and return
<code class="literal">True</code> to prevent further processing. Or, by
returning <code class="literal">False</code>, it can pass the event to other
handlers until the default GTK+ handler is reached.</p><p>The value parameter is unrounded. An application that overrides
the "change-value" signal is responsible for clamping the value to the
desired number of decimal digits.</p><p>It is not possible to use delayed update policies in an
overridden "change-value" handler.</p></div><div class="refsect2" lang="en"><a name="signal-gtkrange--move-slider"></a><h3>The "move-slider" gtk.Range Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>range</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>scrolltype</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>range</code></em> :</span></p></td><td>the range that received the
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>scrolltype</code></em> :</span></p></td><td>the scroll type issued because a key was
pressed by the user; one of the <a class="xref" href="gtk-constants.html#gtk-scroll-type-constants" title="GTK Scroll Type Constants">GTK Scroll Type Constants</a>.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
any)</td></tr></tbody></table><p>The "move-slider" signal is emitted when the user presses a key
(e.g. <span class="keycap"><strong>Page Up</strong></span>, <span class="keycap"><strong>Home</strong></span>, <span class="keycap"><strong>Right
Arrow</strong></span>) to move the slider.</p></div><div class="refsect2" lang="en"><a name="signal-gtkrange--value-changed"></a><h3>The "value-changed" gtk.Range Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>range</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><em class="parameter"><code>range</code></em> :</span></p></td><td>the range that received the
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
any)</td></tr></tbody></table><p>The "value-changed" signal is emitted when the range value is
changed either programmatically or by user action.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-gtkradiotoolbutton.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="gtk-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-gtkrcstyle.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.RadioToolButton </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.RcStyle</td></tr></table></div></body></html>
|
