/usr/share/gtk-doc/html/pygtk/class-gtkadjustment.html is in python-gtk2-doc 2.24.0-4ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.Adjustment</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" 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-gtkactivatable.html" title="gtk.Activatable"><link rel="next" href="class-gtkalignment.html" title="gtk.Alignment"></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.Adjustment</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkactivatable.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkalignment.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.Adjustment"><a name="class-gtkadjustment"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.Adjustment</h2><p>gtk.Adjustment — an object representing an adjustable bounded
value</p></div><div class="refsect1" title="Synopsis"><a name="id3560759"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.Adjustment</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a></span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtkadjustment.html#constructor-gtkadjustment" title="Constructor">gtk.Adjustment</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>value</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>lower</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>upper</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>step_incr</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>page_incr</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>page_size</code></strong></span><span class="initializer">=0</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkadjustment.html#method-gtkadjustment--set-all" title="gtk.Adjustment.set_all">set_all</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>value</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>lower</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>upper</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>step_increment</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>page_increment</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>page_size</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkadjustment.html#method-gtkadjustment--changed" title="gtk.Adjustment.changed">changed</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkadjustment.html#method-gtkadjustment--value-changed" title="gtk.Adjustment.value_changed">value_changed</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkadjustment.html#method-gtkadjustment--clamp-page" title="gtk.Adjustment.clamp_page">clamp_page</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>lower</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>upper</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkadjustment.html#method-gtkadjustment--get-value" title="gtk.Adjustment.get_value">get_value</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkadjustment.html#method-gtkadjustment--set-value" title="gtk.Adjustment.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-gtkadjustment.html#method-gtkadjustment--configure" title="gtk.Adjustment.configure">configure</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>value</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>lower</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>upper</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>step_increment</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>page_increment</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>page_size</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkadjustment.html#method-gtkadjustment--get-lower" title="gtk.Adjustment.get_lower">get_lower</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkadjustment.html#method-gtkadjustment--set-lower" title="gtk.Adjustment.set_lower">set_lower</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>lower</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkadjustment.html#method-gtkadjustment--get-page-increment" title="gtk.Adjustment.get_page_increment">get_page_increment</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkadjustment.html#method-gtkadjustment--set-page-increment" title="gtk.Adjustment.set_page_increment">set_page_increment</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page_increment</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkadjustment.html#method-gtkadjustment--get-page-size" title="gtk.Adjustment.get_page_size">get_page_size</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkadjustment.html#method-gtkadjustment--set-page-size" title="gtk.Adjustment.set_page_size">set_page_size</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page_size</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkadjustment.html#method-gtkadjustment--get-step-increment" title="gtk.Adjustment.get_step_increment">get_step_increment</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkadjustment.html#method-gtkadjustment--set-step-increment" title="gtk.Adjustment.set_step_increment">set_step_increment</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>step_increment</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkadjustment.html#method-gtkadjustment--get-upper" title="gtk.Adjustment.get_upper">get_upper</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkadjustment.html#method-gtkadjustment--set-upper" title="gtk.Adjustment.set_upper">set_upper</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>upper</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id3012682"></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-gtkadjustment.html" title="gtk.Adjustment">gtk.Adjustment</a>
</pre></div><div class="refsect1" title="gtk.Adjustment Properties"><a name="properties-gtkadjustment"></a><h2>gtk.Adjustment Properties</h2><p><a class="link" href="class-gtkobject.html#properties-gtkobject" title="gtk.Object Properties">gtk.Object Properties</a></p><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>These properties are available in GTK+ 2.4 and above. The GTK+
version is contained in the 3-tuple gtk.gtk_version.</p></div><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col width="1in"><col width="1in"><col width="4in"></colgroup><tbody><tr valign="top"><td valign="top">"lower"</td><td valign="top">Read-Write</td><td valign="top">The minimum value of the adjustment. (float)</td></tr><tr valign="top"><td valign="top">"page-increment"</td><td valign="top">Read-Write</td><td valign="top">The page increment of the adjustment. (float)</td></tr><tr valign="top"><td valign="top">"page-size"</td><td valign="top">Read-Write</td><td valign="top">The page size of the adjustment. (float)</td></tr><tr valign="top"><td valign="top">"step-increment"</td><td valign="top">Read-Write</td><td valign="top">The step increment of the adjustment. (float)</td></tr><tr valign="top"><td valign="top">"upper"</td><td valign="top">Read-Write</td><td valign="top">The maximum value of the adjustment. (float)</td></tr><tr valign="top"><td valign="top">"value"</td><td valign="top">Read-Write</td><td valign="top">The value of the adjustment. (float)</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="Attributes"><a name="id3558798"></a><h2>Attributes</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col width="1in"><col width="1in"><col width="4in"></colgroup><tbody><tr valign="top"><td valign="top">"value"</td><td valign="top">Read-Write</td><td valign="top">the current value (float)</td></tr><tr valign="top"><td valign="top">"lower"</td><td valign="top">Read-Write</td><td valign="top">the minimum value (float)</td></tr><tr valign="top"><td valign="top">"upper"</td><td valign="top">Read-Write</td><td valign="top">the maximum value (float)</td></tr><tr valign="top"><td valign="top">"step_increment"</td><td valign="top">Read-Write</td><td valign="top">the increment to use to make minor changes to the
value. In a <a class="link" href="class-gtkscrollbar.html" title="gtk.Scrollbar"><code class="classname">gtk.Scrollbar</code></a>
this increment is used when the mouse is clicked on the arrows at the top
and bottom of the scrollbar, to scroll by a small amount. (float)</td></tr><tr valign="top"><td valign="top">"page_increment"</td><td valign="top">Read-Write</td><td valign="top">the increment to use to make major changes to the
value. In a <a class="link" href="class-gtkscrollbar.html" title="gtk.Scrollbar"><code class="classname">gtk.Scrollbar</code></a>
this increment is used when the mouse is clicked in the trough, to scroll by
a large amount. (float)</td></tr><tr valign="top"><td valign="top">"page_size"</td><td valign="top">Read-Write</td><td valign="top">a widget specific size. In a <a class="link" href="class-gtkscrollbar.html" title="gtk.Scrollbar"><code class="classname">gtk.Scrollbar</code></a>
this is the size of the area which is currently visible. (float)</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.Adjustment Signal Prototypes"><a name="signal-prototypes-gtkadjustment"></a><h2>gtk.Adjustment 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><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-gtkadjustment.html#signal-gtkadjustment--changed" title='The "changed" gtk.Adjustment Signal'>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>adjustment</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-gtkadjustment.html#signal-gtkadjustment--value-changed" title='The "value-changed" gtk.Adjustment 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>adjustment</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" title="Description"><a name="id3347332"></a><h2>Description</h2><p>The <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
object contains a value which has an associated lower and upper bound,
together with step and page increments, and a page size. It is used in
conjunction with several PyGTK widgets, including <a class="link" href="class-gtkspinbutton.html" title="gtk.SpinButton"><code class="classname">gtk.SpinButton</code></a>,
<a class="link" href="class-gtkviewport.html" title="gtk.Viewport"><code class="classname">gtk.Viewport</code></a>,
and <a class="link" href="class-gtkrange.html" title="gtk.Range"><code class="classname">gtk.Range</code></a> (which
is a base class for <a class="link" href="class-gtkhscrollbar.html" title="gtk.HScrollbar"><code class="classname">gtk.HScrollbar</code></a>,
<a class="link" href="class-gtkvscrollbar.html" title="gtk.VScrollbar"><code class="classname">gtk.VScrollbar</code></a>,
<a class="link" href="class-gtkhscale.html" title="gtk.HScale"><code class="classname">gtk.HScale</code></a>, and
<a class="link" href="class-gtkvscale.html" title="gtk.VScale"><code class="classname">gtk.VScale</code></a>).</p><p>A <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
can be shared by multiple widgets. The <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
object does not update the value itself. Instead it is left up to the
associated widget(s) that use the <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
to control the value.</p><p>The widget using the <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
typically calls the <a class="link" href="class-gtkadjustment.html#method-gtkadjustment--value-changed" title="gtk.Adjustment.value_changed"><code class="methodname">value_changed</code>()</a>
or <a class="link" href="class-gtkadjustment.html#method-gtkadjustment--changed" title="gtk.Adjustment.changed"><code class="methodname">changed</code>()</a>
methods after changing the value or its bounds. This results in the emission
of the "value_changed" or "changed" signal respectively.</p><p>A <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
object contains several attributes that provide access to its value and
bounds:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">value</li><li class="listitem">lower</li><li class="listitem">upper</li><li class="listitem">step_increment</li><li class="listitem">page_increment</li><li class="listitem">page_size</li></ul></div><p>The attribute values can be retrieved and set similar to:</p><pre class="programlisting">
adjustment.upper = 25.0
lower = adjustment.lower
</pre></div><div class="refsect1" title="Constructor"><a name="constructor-gtkadjustment"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.Adjustment</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>value</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>lower</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>upper</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>step_incr</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>page_incr</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>page_size</code></strong></span><span class="initializer">=0</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 initial value.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>lower</code></strong> :</span></p></td><td>the minimum value.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>upper</code></strong> :</span></p></td><td>the maximum value.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>step_incr</code></strong> :</span></p></td><td>the step increment.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>page_incr</code></strong> :</span></p></td><td>the page increment.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>page_size</code></strong> :</span></p></td><td>the page size.</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new gtk.Adjustment object</td></tr></tbody></table><p><code class="function">gtk.Adjustment</code>() creates a new <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
object with the specified attributes. Any attributes not specified are set
to 0.0 by default.</p></div><div class="refsect1" title="Methods"><a name="id3440667"></a><h2>Methods</h2><div class="refsect2" title="gtk.Adjustment.set_all"><a name="method-gtkadjustment--set-all"></a><h3>gtk.Adjustment.set_all</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_all</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>value</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>lower</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>upper</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>step_increment</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>page_increment</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>page_size</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.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>lower</code></strong> :</span></p></td><td>the new minimum value.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>upper</code></strong> :</span></p></td><td>the new maximum value.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>step_increment</code></strong> :</span></p></td><td>the new step increment.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>page_increment</code></strong> :</span></p></td><td>the new page increment.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>page_size</code></strong> :</span></p></td><td>the new page size.</td></tr></tbody></table><p>The <code class="methodname">set_all</code>() method sets the
attributes of the adjustment to the specified values.</p></div><div class="refsect2" title="gtk.Adjustment.changed"><a name="method-gtkadjustment--changed"></a><h3>gtk.Adjustment.changed</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">changed</span>(<span class="methodparam"></span>)</code></pre><p>The <code class="methodname">changed</code>() method emits a "changed"
signal from the adjustment. This must typically be called if any of the
adjustment attributes other than value has changed so that the widget(s)
using the adjustment can reflect the changes. Applications usually will not
need to use this method since setting the attributes directly will automatically
invoke this method.</p></div><div class="refsect2" title="gtk.Adjustment.value_changed"><a name="method-gtkadjustment--value-changed"></a><h3>gtk.Adjustment.value_changed</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">value_changed</span>(<span class="methodparam"></span>)</code></pre><p>The <code class="methodname">value_changed</code>() method emits a
"value_changed" signal from the adjustment. This must typically be called
after the value attribute of the adjustment has changed. Applications
usually will not need to use this method since setting the attribute
directly will automatically invoke this method as will using the <a class="link" href="class-gtkadjustment.html#method-gtkadjustment--set-value" title="gtk.Adjustment.set_value"><code class="methodname">set_value</code>()</a>
method.</p></div><div class="refsect2" title="gtk.Adjustment.clamp_page"><a name="method-gtkadjustment--clamp-page"></a><h3>gtk.Adjustment.clamp_page</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">clamp_page</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>lower</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>upper</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>lower</code></strong> :</span></p></td><td>the lower value</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>upper</code></strong> :</span></p></td><td>the upper value</td></tr></tbody></table><p>The <code class="methodname">clamp_page</code>() method updates the
adjustment value to ensure that the range between
<em class="parameter"><code>lower</code></em> and <em class="parameter"><code>upper</code></em> is in the
current page (i.e. between value and value + page_size). If the range is
larger than the page size, then only the start of it will be in the current
page. A "changed" signal will be emitted if the value is changed.</p></div><div class="refsect2" title="gtk.Adjustment.get_value"><a name="method-gtkadjustment--get-value"></a><h3>gtk.Adjustment.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
adjustment.</td></tr></tbody></table><p>The <code class="methodname">get_value</code>() method gets the current
value of the adjustment.</p></div><div class="refsect2" title="gtk.Adjustment.set_value"><a name="method-gtkadjustment--set-value"></a><h3>gtk.Adjustment.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</td></tr></tbody></table><p>The <code class="methodname">set_value</code>() method sets the value
of the adjustment to the specified <em class="parameter"><code>value</code></em>.</p></div><div class="refsect2" title="gtk.Adjustment.configure"><a name="method-gtkadjustment--configure"></a><h3>gtk.Adjustment.configure</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">configure</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>value</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>lower</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>upper</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>step_increment</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>page_increment</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>page_size</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.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>lower</code></strong> :</span></p></td><td>the new minimum value.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>upper</code></strong> :</span></p></td><td>the new maximum value.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>step_increment</code></strong> :</span></p></td><td>the new step increment.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>page_increment</code></strong> :</span></p></td><td>the new page increment.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>page_size</code></strong> :</span></p></td><td>the new page size.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.14 and above.</p></div><p>The <code class="methodname">configure</code>() method sets all properties of the adjustment at once.</p><p>This method is an alternative to avoid multiple emissions of the "changed" signal. When setting multiple
adjustment properties via their individual setters, multiple "changed" signals will be emitted. However, since the
emission of the "changed" signal is tied to the emission of the "GObject::notify" signals of the changed properties,
it's possible to compress the "changed" signals into one by calling
<PYGTKDOCLINK HREF="method-gobject--freeze-notify"><code class="methodname">gobject.Gobject.freeze_notify</code></PYGTKDOCLINK>() and
<PYGTKDOCLINK HREF="method-gobject--thaw-notify"><code class="methodname">gobject.Gobject.thaw_notify</code></PYGTKDOCLINK>()
around the calls to the individual setters.</p></div><div class="refsect2" title="gtk.Adjustment.get_lower"><a name="method-gtkadjustment--get-lower"></a><h3>gtk.Adjustment.get_lower</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_lower</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 minimum value of the adjustment.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.14 and above.</p></div><p>The <code class="methodname">get_lower</code>() method gets the current minimum
value of the adjustment.</p></div><div class="refsect2" title="gtk.Adjustment.set_lower"><a name="method-gtkadjustment--set-lower"></a><h3>gtk.Adjustment.set_lower</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_lower</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>lower</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>lower</code></strong> :</span></p></td><td>the new minimum value</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.14 and above.</p></div><p>
The <code class="methodname">set_lower</code>() method sets the minimum value of the adjustment.
</p><p>
When setting multiple adjustment properties via their individual setters,
multiple "changed" signals will be emitted. However, since the emission of the
"changed" signal is tied to the emission of the "GObject::notify"
signals of the changed properties, it's possible to compress the "changed"
signals into one by calling gobject.Gobject.freeze_notify() and gobject.Gobject.thaw_notify()
around the calls to the individual setters.
</p><p>
Alternatively, using
<a class="link" href="class-gtkadjustment.html#method-gtkadjustment--configure" title="gtk.Adjustment.configure">gtk.Adjustment.configure</a>()
has the same effect of compressing "changed" emissions.
</p></div><div class="refsect2" title="gtk.Adjustment.get_page_increment"><a name="method-gtkadjustment--get-page-increment"></a><h3>gtk.Adjustment.get_page_increment</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_page_increment</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 page increment of the adjustment.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.14 and above.</p></div><p>The <code class="methodname">get_page_increment</code>() method gets the current page
increment of the adjustment.</p></div><div class="refsect2" title="gtk.Adjustment.set_page_increment"><a name="method-gtkadjustment--set-page-increment"></a><h3>gtk.Adjustment.set_page_increment</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_page_increment</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page_increment</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>page_increment</code></strong> :</span></p></td><td>the new page increment value</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.14 and above.</p></div><p>
The <code class="methodname">set_page_increment</code>() method sets the page increment of the adjustment.
</p><p>
See
<a class="link" href="class-gtkadjustment.html#method-gtkadjustment--get-lower" title="gtk.Adjustment.get_lower">gtk.Adjustment.get_lower</a>()
about how to compress multiple emissions of the "changed" signal when setting multiple adjustment properties.
</p></div><div class="refsect2" title="gtk.Adjustment.get_page_size"><a name="method-gtkadjustment--get-page-size"></a><h3>gtk.Adjustment.get_page_size</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_page_size</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 page size of the adjustment.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.14 and above.</p></div><p>The <code class="methodname">get_page_size</code>() method gets the current page
size of the adjustment.</p></div><div class="refsect2" title="gtk.Adjustment.set_page_size"><a name="method-gtkadjustment--set-page-size"></a><h3>gtk.Adjustment.set_page_size</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_page_size</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>page_size</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>page_size</code></strong> :</span></p></td><td>the new page size value</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.14 and above.</p></div><p>
The <code class="methodname">set_page_size</code>() method sets the page size of the adjustment.
</p><p>
See
<a class="link" href="class-gtkadjustment.html#method-gtkadjustment--get-lower" title="gtk.Adjustment.get_lower">gtk.Adjustment.get_lower</a>()
about how to compress multiple emissions of the "changed" signal when setting multiple adjustment properties.
</p></div><div class="refsect2" title="gtk.Adjustment.get_step_increment"><a name="method-gtkadjustment--get-step-increment"></a><h3>gtk.Adjustment.get_step_increment</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_step_increment</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 step increment of the adjustment.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.14 and above.</p></div><p>The <code class="methodname">get_step_increment</code>() method gets the current step
increment of the adjustment.</p></div><div class="refsect2" title="gtk.Adjustment.set_step_increment"><a name="method-gtkadjustment--set-step-increment"></a><h3>gtk.Adjustment.set_step_increment</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_step_increment</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>step_increment</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_increment</code></strong> :</span></p></td><td>the new step increment value</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.14 and above.</p></div><p>
The <code class="methodname">set_step_increment</code>() method sets the step increment of the adjustment.
</p><p>
See
<a class="link" href="class-gtkadjustment.html#method-gtkadjustment--get-lower" title="gtk.Adjustment.get_lower">gtk.Adjustment.get_lower</a>()
about how to compress multiple emissions of the "changed" signal when setting multiple adjustment properties.
</p></div><div class="refsect2" title="gtk.Adjustment.get_upper"><a name="method-gtkadjustment--get-upper"></a><h3>gtk.Adjustment.get_upper</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_upper</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 minimum value of the adjustment.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.14 and above.</p></div><p>The <code class="methodname">get_upper</code>() method gets the current minimum
value of the adjustment.</p></div><div class="refsect2" title="gtk.Adjustment.set_upper"><a name="method-gtkadjustment--set-upper"></a><h3>gtk.Adjustment.set_upper</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_upper</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>upper</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>upper</code></strong> :</span></p></td><td>the new maximum value</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.14 and above.</p></div><p>
The <code class="methodname">set_upper</code>() method sets the maximum value of the adjustment.
</p><p>
Note that values will be restricted by upper - page-size if the page-size property is nonzero.
</p><p>
See
<a class="link" href="class-gtkadjustment.html#method-gtkadjustment--get-lower" title="gtk.Adjustment.get_lower">gtk.Adjustment.get_lower</a>()
about how to compress multiple emissions of the "changed" signal when setting multiple adjustment properties.
</p></div></div><div class="refsect1" title="Signals"><a name="id3308533"></a><h2>Signals</h2><div class="refsect2" title='The "changed" gtk.Adjustment Signal'><a name="signal-gtkadjustment--changed"></a><h3>The "changed" gtk.Adjustment Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>adjustment</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>adjustment</code></em> :</span></p></td><td>the object 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 "changed" signal is emitted when one (or more) of the
adjustment attributes (except the value attribute) has changed.</p></div><div class="refsect2" title='The "value-changed" gtk.Adjustment Signal'><a name="signal-gtkadjustment--value-changed"></a><h3>The "value-changed" gtk.Adjustment Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>adjustment</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>adjustment</code></em> :</span></p></td><td>the object 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 adjustment value
attribute has changed.</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-gtkactivatable.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-gtkalignment.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.Activatable </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.Alignment</td></tr></table></div></body></html>
|