/usr/share/gtk-doc/html/pygtk/class-gtkspinbutton.html is in python-gtk2-doc 2.24.0-5.1ubuntu2.
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 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 171 172 173 174 175 176 177 178 179 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.SpinButton</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-gtksocket.html" title="gtk.Socket"><link rel="next" href="class-gtkspinner.html" title="gtk.Spinner"></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.SpinButton</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtksocket.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkspinner.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.SpinButton"><a name="class-gtkspinbutton"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.SpinButton</h2><p>gtk.SpinButton — retrieve an integer or floating-point number from the
user.</p></div><div class="refsect1" title="Synopsis"><a name="id3901513"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.SpinButton</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkentry.html" title="gtk.Entry">gtk.Entry</a></span></span>):
<code class="constructorsynopsis"> <span class="methodname"><a class="link" href="class-gtkspinbutton.html#constructor-gtkspinbutton" title="Constructor">gtk.SpinButton</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>adjustment</code></strong></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>climb_rate</code></strong></span><span class="initializer">=0.0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>digits</code></strong></span><span class="initializer">=0</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkspinbutton.html#method-gtkspinbutton--configure" title="gtk.SpinButton.configure">configure</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>adjustment</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>climb_rate</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>digits</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkspinbutton.html#method-gtkspinbutton--set-adjustment" title="gtk.SpinButton.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-gtkspinbutton.html#method-gtkspinbutton--get-adjustment" title="gtk.SpinButton.get_adjustment">get_adjustment</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkspinbutton.html#method-gtkspinbutton--set-digits" title="gtk.SpinButton.set_digits">set_digits</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>digits</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkspinbutton.html#method-gtkspinbutton--get-digits" title="gtk.SpinButton.get_digits">get_digits</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkspinbutton.html#method-gtkspinbutton--set-increments" title="gtk.SpinButton.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-gtkspinbutton.html#method-gtkspinbutton--get-increments" title="gtk.SpinButton.get_increments">get_increments</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkspinbutton.html#method-gtkspinbutton--set-range" title="gtk.SpinButton.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-gtkspinbutton.html#method-gtkspinbutton--get-range" title="gtk.SpinButton.get_range">get_range</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkspinbutton.html#method-gtkspinbutton--get-value" title="gtk.SpinButton.get_value">get_value</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkspinbutton.html#method-gtkspinbutton--get-value-as-int" title="gtk.SpinButton.get_value_as_int">get_value_as_int</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkspinbutton.html#method-gtkspinbutton--set-value" title="gtk.SpinButton.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-gtkspinbutton.html#method-gtkspinbutton--set-update-policy" title="gtk.SpinButton.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-gtkspinbutton.html#method-gtkspinbutton--get-update-policy" title="gtk.SpinButton.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-gtkspinbutton.html#method-gtkspinbutton--set-numeric" title="gtk.SpinButton.set_numeric">set_numeric</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>numeric</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkspinbutton.html#method-gtkspinbutton--get-numeric" title="gtk.SpinButton.get_numeric">get_numeric</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkspinbutton.html#method-gtkspinbutton--spin" title="gtk.SpinButton.spin">spin</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>direction</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>increment</code></strong></span><span class="initializer">=1.0</span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkspinbutton.html#method-gtkspinbutton--set-wrap" title="gtk.SpinButton.set_wrap">set_wrap</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>wrap</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkspinbutton.html#method-gtkspinbutton--get-wrap" title="gtk.SpinButton.get_wrap">get_wrap</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkspinbutton.html#method-gtkspinbutton--set-snap-to-ticks" title="gtk.SpinButton.set_snap_to_ticks">set_snap_to_ticks</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>snap_to_ticks</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkspinbutton.html#method-gtkspinbutton--get-snap-to-ticks" title="gtk.SpinButton.get_snap_to_ticks">get_snap_to_ticks</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-gtkspinbutton.html#method-gtkspinbutton--update" title="gtk.SpinButton.update">update</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id3902203"></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-gtkentry.html" title="gtk.Entry">gtk.Entry</a> (implements <a class="link" href="class-gtkeditable.html" title="gtk.Editable">gtk.Editable</a>, <a class="link" href="class-gtkcelleditable.html" title="gtk.CellEditable">gtk.CellEditable</a>)
+-- <a class="link" href="class-gtkspinbutton.html" title="gtk.SpinButton">gtk.SpinButton</a>
</pre></div><div class="refsect1" title="Implemented Interfaces"><a name="id3902261"></a><h2>Implemented Interfaces</h2><p>
<a class="link" href="class-gtkspinbutton.html" title="gtk.SpinButton"><code class="classname">gtk.SpinButton</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" title="gtk.SpinButton Properties"><a name="properties-gtkspinbutton"></a><h2>gtk.SpinButton 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><p><a class="link" href="class-gtkentry.html#properties-gtkentry" title="gtk.Entry Properties">gtk.Entry 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 width="1in"><col width="1in"><col width="4in"></colgroup><tbody><tr valign="top"><td valign="top">"adjustment"</td><td valign="top">Read-Write</td><td valign="top">The adjustment that holds the value of the
spinbutton</td></tr><tr valign="top"><td valign="top">"climb-rate"</td><td valign="top">Read-Write</td><td valign="top">The acceleration rate when you hold down a
button</td></tr><tr valign="top"><td valign="top">"digits"</td><td valign="top">Read-Write</td><td valign="top">The number of decimal places to display</td></tr><tr valign="top"><td valign="top">"numeric"</td><td valign="top">Read-Write</td><td valign="top">If <code class="literal">True</code>, non-numeric characters
should be ignored</td></tr><tr valign="top"><td valign="top">"snap-to-ticks"</td><td valign="top">Read-Write</td><td valign="top">If <code class="literal">True</code>, erroneous values are
automatically changed to a spin button's nearest step increment</td></tr><tr valign="top"><td valign="top">"update-policy"</td><td valign="top">Read-Write</td><td valign="top">either <code class="literal">gtk.UPDATE_ALWAYS</code> (the spin
button should update always), or <code class="literal">gtk.UPDATE_IF_VALID</code> the
spin button should update only when the value is legal)</td></tr><tr valign="top"><td valign="top">"value"</td><td valign="top">Read-Write</td><td valign="top">the current value</td></tr><tr valign="top"><td valign="top">"wrap"</td><td valign="top">Read-Write</td><td valign="top">If <code class="literal">True</code>, a spin button should wrap
upon reaching its limits</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.SpinButton Style Properties"><a name="style-properties-gtkspinbutton"></a><h2>gtk.SpinButton 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><p><a class="link" href="class-gtkentry.html#style-properties-gtkentry" title="gtk.Entry Style Properties">gtk.Entry 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 width="1in"><col width="1in"><col width="4in"></colgroup><tbody><tr valign="top"><td valign="top">"shadow-type"</td><td valign="top">Read</td><td valign="top">the shadow type of the spinbutton - one of:
<code class="literal">gtk.SHADOW_NONE</code>, <code class="literal">gtk.SHADOW_IN</code>,
<code class="literal">gtk.SHADOW_OUT</code>, <code class="literal">gtk.SHADOW_ETCHED_IN</code>
or <code class="literal">gtk.SHADOW_ETCHED_OUT</code></td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.SpinButton Signal Prototypes"><a name="signal-prototypes-gtkspinbutton"></a><h2>gtk.SpinButton 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><p><a class="link" href="class-gtkentry.html#signal-prototypes-gtkentry" title="gtk.Entry Signal Prototypes">gtk.Entry Signal Prototypes</a></p><p><a class="link" href="class-gtkeditable.html#signal-prototypes-gtkeditable" title="gtk.Editable Signal Prototypes">gtk.Editable Signal Prototypes</a></p><p><a class="link" href="class-gtkcelleditable.html#signal-prototypes-gtkcelleditable" title="gtk.CellEditable Signal Prototypes">gtk.CellEditable 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-gtkspinbutton.html#signal-gtkspinbutton--change-value" title='The "change-value" gtk.SpinButton 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>spinbutton</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-gtkspinbutton.html#signal-gtkspinbutton--input" title='The "input" gtk.SpinButton Signal'>input</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>spinbutton</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>value_ptr</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-gtkspinbutton.html#signal-gtkspinbutton--output" title='The "output" gtk.SpinButton Signal'>output</a>"</span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>spinbutton</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-gtkspinbutton.html#signal-gtkspinbutton--value-changed" title='The "value-changed" gtk.SpinButton 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>spinbutton</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-gtkspinbutton.html#signal-gtkspinbutton--wrapped" title='The "wrapped" gtk.SpinButton Signal'>wrapped</a></span></p></td><td><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>spinbutton</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="id3903051"></a><h2>Description</h2><p>A <a class="link" href="class-gtkspinbutton.html" title="gtk.SpinButton"><code class="classname">gtk.SpinButton</code></a>
is a subclass of <a class="link" href="class-gtkentry.html" title="gtk.Entry"><code class="classname">gtk.Entry</code></a> that
provides a way for a user to set the value of some numeric attribute within
a predefined range. Rather than having to directly type a number into a
<a class="link" href="class-gtkentry.html" title="gtk.Entry"><code class="classname">gtk.Entry</code></a>, a
<a class="link" href="class-gtkspinbutton.html" title="gtk.SpinButton"><code class="classname">gtk.SpinButton</code></a>
allows the user to click on one of two arrows to increment or decrement the
displayed value. A value can still be typed in and validated. A <a class="link" href="class-gtkspinbutton.html" title="gtk.SpinButton"><code class="classname">gtk.SpinButton</code></a>
uses a <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
to specify the range and value of interest. See the <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
section for more details about an adjustment's properties.</p></div><div class="refsect1" title="Constructor"><a name="constructor-gtkspinbutton"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis"> <span class="methodname">gtk.SpinButton</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>adjustment</code></strong></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>climb_rate</code></strong></span><span class="initializer">=0.0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>digits</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>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>
or None to create a new adjustment</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>climb_rate</code></strong> :</span></p></td><td>the acceleration factor</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>digits</code></strong> :</span></p></td><td>the number of decimal places to
display</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new <a class="link" href="class-gtkspinbutton.html" title="gtk.SpinButton"><code class="classname">gtk.SpinButton</code></a>
widget</td></tr></tbody></table><p>Creates a new <a class="link" href="class-gtkspinbutton.html" title="gtk.SpinButton"><code class="classname">gtk.SpinButton</code></a>
widget using the <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
specified by <em class="parameter"><code>adjustment</code></em>, the acceleration factor
specified by <em class="parameter"><code>climb_rate</code></em> and displaying the number of
decimals specified by <em class="parameter"><code>digits</code></em>. If
<em class="parameter"><code>adjustment</code></em> is <code class="literal">None</code> or is not
specified a new <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
will be created. If <em class="parameter"><code>climb_rate</code></em> is not specified it
defaults to 0.0. If <em class="parameter"><code>digits</code></em> is not specified it
defaults to 0.</p></div><div class="refsect1" title="Methods"><a name="id3903356"></a><h2>Methods</h2><div class="refsect2" title="gtk.SpinButton.configure"><a name="method-gtkspinbutton--configure"></a><h3>gtk.SpinButton.configure</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">configure</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>adjustment</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>climb_rate</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>digits</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>
or None to create a new adjustment</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>climb_rate</code></strong> :</span></p></td><td>the acceleration factor</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>digits</code></strong> :</span></p></td><td>the number of decimal places to
display</td></tr></tbody></table><p>The <code class="methodname">configure</code>() method changes the
properties of an existing spin button by associating the <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
specified by <em class="parameter"><code>adjustment</code></em>, setting the acceleration
rate to the c value specified by <em class="parameter"><code>climb_rate</code></em> and
setting the number of decimal places to display to the value specified by
<em class="parameter"><code>digits</code></em>. If <em class="parameter"><code>adjustment</code></em> is
<code class="literal">None</code> a new <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
will be created. </p></div><div class="refsect2" title="gtk.SpinButton.set_adjustment"><a name="method-gtkspinbutton--set-adjustment"></a><h3>gtk.SpinButton.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>
to replace the existing adjustment</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> replacing the current adjustment object
associated with the spinbutton.</p></div><div class="refsect2" title="gtk.SpinButton.get_adjustment"><a name="method-gtkspinbutton--get-adjustment"></a><h3>gtk.SpinButton.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>the <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
object associated with the spinbutton</td></tr></tbody></table><p>The <code class="methodname">get_adjustment</code>() method returns the
value of the "adjustment" property.</p></div><div class="refsect2" title="gtk.SpinButton.set_digits"><a name="method-gtkspinbutton--set-digits"></a><h3>gtk.SpinButton.set_digits</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_digits</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>digits</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>digits</code></strong> :</span></p></td><td>the number of decimal places to be displayed
for the spin button's value</td></tr></tbody></table><p>The <code class="methodname">set_digits</code>() method sets the
"digits" property to the value specified by <em class="parameter"><code>digits</code></em>.
The value of "digits" determines the number of decimal places (up to 20
digits) to be displayed by the spinbutton.</p></div><div class="refsect2" title="gtk.SpinButton.get_digits"><a name="method-gtkspinbutton--get-digits"></a><h3>gtk.SpinButton.get_digits</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_digits</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 number of decimal places to be
displayed</td></tr></tbody></table><p>The <code class="methodname">get_digits</code>() method returns the
value of the "digits" property. The value of "digits" determines the number
of decimal places the spinbutton displays. See the <a class="link" href="class-gtkspinbutton.html#method-gtkspinbutton--set-digits" title="gtk.SpinButton.set_digits"><code class="methodname">set_digits</code>()</a>
method for more detail.</p></div><div class="refsect2" title="gtk.SpinButton.set_increments"><a name="method-gtkspinbutton--set-increments"></a><h3>gtk.SpinButton.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>increment applied for each
<span class="mousebutton">left</span> mousebutton press.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>page</code></strong> :</span></p></td><td>increment applied for each
<span class="mousebutton">middle</span> mousebutton press.</td></tr></tbody></table><p>The <code class="methodname">set_increments</code>() method sets the
<code class="literal">step_increment</code> and <code class="literal">page_increment</code>
attributes of the <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
associated with the spinbutton to the values specified by
<em class="parameter"><code>step</code></em> and <em class="parameter"><code>page</code></em> respectively.
These affect how quickly the value changes when the spin button's arrows are
activated.</p></div><div class="refsect2" title="gtk.SpinButton.get_increments"><a name="method-gtkspinbutton--get-increments"></a><h3>gtk.SpinButton.get_increments</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_increments</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 tuple containing the step and page
increments</td></tr></tbody></table><p>The <code class="methodname">get_increments</code>() method returns a
tuple containing the values of the <code class="literal">step_increment</code> and
<code class="literal">page_increment</code> attributes of the <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
associated with the spinbutton. See the <a class="link" href="class-gtkspinbutton.html#method-gtkspinbutton--set-increments" title="gtk.SpinButton.set_increments"><code class="methodname">set_increments</code>()</a>
method for more detail.</p></div><div class="refsect2" title="gtk.SpinButton.set_range"><a name="method-gtkspinbutton--set-range"></a><h3>gtk.SpinButton.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 allowable
value</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>max</code></strong> :</span></p></td><td>the maximum allowable
value</td></tr></tbody></table><p>The <code class="methodname">set_range</code>() method sets the minimum
and maximum allowable values for spinbutton by setting the
<code class="literal">lower</code> and <code class="literal">upper</code> attributes of the
associated <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
to the values of <em class="parameter"><code>min</code></em> and <em class="parameter"><code>max</code></em>
respectively.</p></div><div class="refsect2" title="gtk.SpinButton.get_range"><a name="method-gtkspinbutton--get-range"></a><h3>gtk.SpinButton.get_range</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_range</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 tuple containing the minimum and maximum
allowed values</td></tr></tbody></table><p>The <code class="methodname">get_range</code>() method returns a tuple
containing the range allowed for the spinbutton. See the <a class="link" href="class-gtkspinbutton.html#method-gtkspinbutton--set-range" title="gtk.SpinButton.set_range"><code class="methodname">set_range</code>()</a>
method for more detail.</p></div><div class="refsect2" title="gtk.SpinButton.get_value"><a name="method-gtkspinbutton--get-value"></a><h3>gtk.SpinButton.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 value of the
spin_button</td></tr></tbody></table><p>The <code class="methodname">get_value</code>() method returns the
value of the "value" property of the spinbutton (really the
<code class="literal">value</code> attribute of the associated <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>).</p></div><div class="refsect2" title="gtk.SpinButton.get_value_as_int"><a name="method-gtkspinbutton--get-value-as-int"></a><h3>gtk.SpinButton.get_value_as_int</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_value_as_int</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 value of the spinbutton as an
integer</td></tr></tbody></table><p>The <code class="methodname">get_value_as_int</code>() method returns
the value of the spinbutton represented as an integer.</p></div><div class="refsect2" title="gtk.SpinButton.set_value"><a name="method-gtkspinbutton--set-value"></a><h3>gtk.SpinButton.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 "value" property to the value specified by
<em class="parameter"><code>value</code></em> (sets the <code class="literal">value</code> attribute of
the associated <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>.</p></div><div class="refsect2" title="gtk.SpinButton.set_update_policy"><a name="method-gtkspinbutton--set-update-policy"></a><h3>gtk.SpinButton.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 new update policy</td></tr></tbody></table><p>The <code class="methodname">set_update_policy</code>() method sets the
"update-policy" property to the value of <em class="parameter"><code>policy</code></em>. The
value of <em class="parameter"><code>policy</code></em> is either of:</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_ALWAYS</code></span></p></td><td>the value is always displayed.</td></tr><tr><td><p><span class="term"><code class="literal">gtk.UPDATE_IF_VALID</code></span></p></td><td>the value is only displayed if it is valid within the
bounds of the spinbutton's <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>.</td></tr></tbody></table><p></p></div><div class="refsect2" title="gtk.SpinButton.get_update_policy"><a name="method-gtkspinbutton--get-update-policy"></a><h3>gtk.SpinButton.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 returns
the value of the "update-policy" property that determines the update
behavior of a spin button. See the <a class="link" href="class-gtkspinbutton.html#method-gtkspinbutton--set-update-policy" title="gtk.SpinButton.set_update_policy"><code class="methodname">set_update_policy</code>()</a>
method for more detail.</p></div><div class="refsect2" title="gtk.SpinButton.set_numeric"><a name="method-gtkspinbutton--set-numeric"></a><h3>gtk.SpinButton.set_numeric</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_numeric</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>numeric</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>numeric</code></strong> :</span></p></td><td>a flag indicating if only numeric entry is
allowed.</td></tr></tbody></table><p>The <code class="methodname">set_numeric</code>() method sets the value
of the "numeric" property to the value of <em class="parameter"><code>numeric</code></em>. If
<em class="parameter"><code>numeric</code></em> is <code class="literal">True</code> only numeric text
can be typed into the spin button.</p></div><div class="refsect2" title="gtk.SpinButton.get_numeric"><a name="method-gtkspinbutton--get-numeric"></a><h3>gtk.SpinButton.get_numeric</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_numeric</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 only numeric text
can be entered</td></tr></tbody></table><p>The <code class="methodname">get_numeric</code>() method returns the
value of the "numeric" preoperty. See the <a class="link" href="class-gtkspinbutton.html#method-gtkspinbutton--set-numeric" title="gtk.SpinButton.set_numeric"><code class="methodname">set_numeric</code>()</a>
method for more detail.</p></div><div class="refsect2" title="gtk.SpinButton.spin"><a name="method-gtkspinbutton--spin"></a><h3>gtk.SpinButton.spin</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">spin</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>direction</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>increment</code></strong></span><span class="initializer">=1.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>direction</code></strong> :</span></p></td><td>the direction to spin.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>increment</code></strong> :</span></p></td><td>the step increment to apply in the specified
direction.</td></tr></tbody></table><p>The <code class="methodname">spin</code>() method increments or
decrements a spin button's value in the direction specified by
<em class="parameter"><code>direction</code></em> with a step size specified by
<em class="parameter"><code>increment</code></em>. The value of
<em class="parameter"><code>increment</code></em> is only used if direction is
<code class="literal">gtk.SPIN_USER_DEFINED</code>. The value of
<em class="parameter"><code>direction</code></em> must be one of:</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.SPIN_STEP_FORWARD</code></span></p></td><td>forward by step_increment</td></tr><tr><td><p><span class="term"><code class="literal">gtk.SPIN_STEP_BACKWARD</code></span></p></td><td>backward by step_increment</td></tr><tr><td><p><span class="term"><code class="literal">gtk.SPIN_PAGE_FORWARD</code></span></p></td><td>forward by step_increment</td></tr><tr><td><p><span class="term"><code class="literal">gtk.SPIN_PAGE_BACKWARD</code></span></p></td><td>backward by step_increment</td></tr><tr><td><p><span class="term"><code class="literal">gtk.SPIN_HOME</code></span></p></td><td>move to minimum value</td></tr><tr><td><p><span class="term"><code class="literal">gtk.SPIN_END</code></span></p></td><td>move to maximum value</td></tr><tr><td><p><span class="term"><code class="literal">gtk.SPIN_USER_DEFINED</code></span></p></td><td>add <em class="parameter"><code>increment</code></em> to the
value</td></tr></tbody></table><p></p></div><div class="refsect2" title="gtk.SpinButton.set_wrap"><a name="method-gtkspinbutton--set-wrap"></a><h3>gtk.SpinButton.set_wrap</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_wrap</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>wrap</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>wrap</code></strong> :</span></p></td><td>if <code class="literal">True</code> wrapping is
performed.</td></tr></tbody></table><p>The <code class="methodname">set_wrap</code>() method sets the "wrap"
property to the value of <em class="parameter"><code>wrap</code></em>. If
<em class="parameter"><code>wrap</code></em> is <code class="literal">True</code> the spin button value
wraps around to the opposite limit when the upper or lower limit of the
range is exceeded.</p></div><div class="refsect2" title="gtk.SpinButton.get_wrap"><a name="method-gtkspinbutton--get-wrap"></a><h3>gtk.SpinButton.get_wrap</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_wrap</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 spin button
wraps</td></tr></tbody></table><p>The <code class="methodname">get_wrap</code>() method returns the value
of the "wrap" property. If the value of "wrap" is <code class="literal">True</code>
the spinbutton's value wraps around to the opposite limit when the upper or
lower limit of the range is exceeded. See the <a class="link" href="class-gtkspinbutton.html#method-gtkspinbutton--set-wrap" title="gtk.SpinButton.set_wrap"><code class="methodname">set_wrap</code>()</a>
method.</p></div><div class="refsect2" title="gtk.SpinButton.set_snap_to_ticks"><a name="method-gtkspinbutton--set-snap-to-ticks"></a><h3>gtk.SpinButton.set_snap_to_ticks</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_snap_to_ticks</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>snap_to_ticks</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>snap_to_ticks</code></strong> :</span></p></td><td>if <code class="literal">True</code> invalid values
should be corrected.</td></tr></tbody></table><p>The <code class="methodname">set_snap_to_ticks</code>() method sets the
"snap-to-ticks" property to the value of
<em class="parameter"><code>snap_to_ticks</code></em>. If
<em class="parameter"><code>snap_to_ticks</code></em> is <code class="literal">True</code> values are
corrected to the nearest step increment when a spin button is activated
after providing an invalid value.</p></div><div class="refsect2" title="gtk.SpinButton.get_snap_to_ticks"><a name="method-gtkspinbutton--get-snap-to-ticks"></a><h3>gtk.SpinButton.get_snap_to_ticks</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">get_snap_to_ticks</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 values are snapped
to the nearest step.</td></tr></tbody></table><p>The <code class="methodname">get_snap_to_ticks</code>() method returns
the value of the "snap-to-ticks" property. If the value of "snap-to-ticks"
is <code class="literal">True</code> the input values are corrected to the nearest
step. See the <a class="link" href="class-gtkspinbutton.html#method-gtkspinbutton--set-snap-to-ticks" title="gtk.SpinButton.set_snap_to_ticks"><code class="methodname">set_snap_to_ticks</code>()</a>
method.</p></div><div class="refsect2" title="gtk.SpinButton.update"><a name="method-gtkspinbutton--update"></a><h3>gtk.SpinButton.update</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">update</span>(<span class="methodparam"></span>)</code></pre><p>The <code class="methodname">update</code>() method manually forces an
update of the spin button.</p></div></div><div class="refsect1" title="Signals"><a name="id3905577"></a><h2>Signals</h2><div class="refsect2" title='The "change-value" gtk.SpinButton Signal'><a name="signal-gtkspinbutton--change-value"></a><h3>The "change-value" gtk.SpinButton Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>spinbutton</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>spinbutton</code></em> :</span></p></td><td>the spinbutton that received the
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>scrolltype</code></em> :</span></p></td><td>the scrolltype:
<code class="literal">gtk.SCROLL_STEP_UP</code>,
<code class="literal">gtk.SCROLL_STEP_DOWN</code>,
<code class="literal">gtk.SCROLL_PAGE_UP</code>, <code class="literal">gtk.SCROLL_PAGE_DOWN,
<code class="literal">gtk.SCROLL_START</code> or
<code class="literal">gtk.SCROLL_END</code></code></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 "change-value" signal is emitted when the spinbutton value is
changed by keyboard action using the <span class="keycap"><strong>Up Arrow</strong></span>, <span class="keycap"><strong>Down Arrow</strong></span>,
<span class="keycap"><strong>Page Up</strong></span>, <span class="keycap"><strong>Page
Down</strong></span>, <span class="keycap"><strong>Control</strong></span>+<span class="keycap"><strong>Page Up</strong></span>
or <span class="keycap"><strong>Control</strong></span>+<span class="keycap"><strong>Page
Down</strong></span> keys.</p></div><div class="refsect2" title='The "input" gtk.SpinButton Signal'><a name="signal-gtkspinbutton--input"></a><h3>The "input" gtk.SpinButton Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>spinbutton</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>value_ptr</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>spinbutton</code></em> :</span></p></td><td>the spinbutton that received the
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>value_ptr</code></em> :</span></p></td><td>a pointer to 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><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if the input value was
retrieved and handled; <code class="literal">False</code> if not handled and
-1 if an error occurred during processing.</td></tr></tbody></table><p>The "input" signal is emitted when the value changes. The
value_ptr is a GPointer to the value that cannot be accessed from PyGTK.
This signal cannot be handled in PyGTK.</p></div><div class="refsect2" title='The "output" gtk.SpinButton Signal'><a name="signal-gtkspinbutton--output"></a><h3>The "output" gtk.SpinButton Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>spinbutton</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>spinbutton</code></em> :</span></p></td><td>the spinbutton 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><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if no further
processing is required.</td></tr></tbody></table><p>The "output" signal is emitted when the spinbutton display value
is changed either by setting a new value or changing the digits and on
realizing the widget. Returns <code class="literal">True</code> if the handler
successfully set the text and no further processing is required.</p></div><div class="refsect2" title='The "value-changed" gtk.SpinButton Signal'><a name="signal-gtkspinbutton--value-changed"></a><h3>The "value-changed" gtk.SpinButton Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>spinbutton</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>spinbutton</code></em> :</span></p></td><td>the spinbutton 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 any of the settings (i.e. value, digits) that change the display of the spinbutton are changed.</p></div><div class="refsect2" title='The "wrapped" gtk.SpinButton Signal'><a name="signal-gtkspinbutton--wrapped"></a><h3>The "wrapped" gtk.SpinButton Signal</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>spinbutton</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>spinbutton</code></em> :</span></p></td><td>the object which received the signal
the object which 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><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This signal is available in GTK+ 2.10 and above.</p></div><p>The "wrapped" signal is emitted right after the spinbutton wraps
from its maximum to minimum value or vice-versa.</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-gtksocket.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-gtkspinner.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.Socket </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.Spinner</td></tr></table></div></body></html>
|