xmlns:its="http://www.w3.org/2005/11/its"

      xmlns:xi="http://www.w3.org/2001/XInclude"

      type="guide" style="task"

      id="spinbutton.py">

  <info>

    <title type="text">SpinButton (Python)</title>

    <link type="guide" xref="beginner.py#entry"/>

    <link type="seealso" xref="signals-callbacks.py"/>

    <link type="next" xref="entry.py" />    

    <revision version="0.2" date="2012-06-23" status="draft"/>

    <credit type="author copyright">

      <name>Marta Maria Casetti</name>

      <email its:translate="no">mmcasetti@gmail.com</email>

      <years>2012</years>

    </credit>

    <desc>Retrieve an integer or floating-point number from the user.</desc>

  </info>

  <title>SpinButton</title>

  <media type="image" mime="image/png" src="media/spinbutton.png"/>

  
Choose a number, by entering it or by clicking on the -/+ buttons!

  <links type="section" />

  <section id="code">

    <title>Code used to generate this example</title>

    <xi:include href="samples/spinbutton.py" parse="text"><xi:fallback/></xi:include>

  </section>

  <section id="methods">

    <title>Useful methods for a SpinButton widget</title>

    
A Gtk.Adjustment is needed to construct the Gtk.SpinButton. This is the representation of a value with a lower and upper bound, together with step and page increments, and a page size, and it is constructed as Gtk.Adjustment(value, lower, upper, step_increment, page_increment, page_size) where the fields are of type float; step_increment is the increment/decrement that is obtained by using the cursor keys or the buttons of the spinbutton. Note that page_increment and page_size are not used in this case, and they should be set to 0.

    
In line 23 the signal "value-changed" is connected to the callback function spin_selected() using widget.connect(signal, callback function). See <link xref="signals-callbacks.py"/> for a more detailed explanation.

    <list>

      <item>
If you want the value of the spinbutton to wrap around when they exceed the maximum or the minimum, set set_wrap(True). The "wrapped" signal is emitted when this happens.
</item>

      <item>
set_digits(digits) sets the precision to be displayed by the spinbutton, up to 20 digits.
</item>

      <item>
To get the value of the spinbutton as an integer, use get_value_as_int().
</item>

    </list>

  </section>

  <section id="references">

    <title>API References</title>

    
In this sample we used the following:

    <list>

      <item>
<link href="http://developer.gnome.org/gtk3/unstable/GtkSpinButton.html">GtkSpinButton</link>
</item>

      <item>
<link href="http://developer.gnome.org/gtk3/unstable/GtkAdjustment.html">GtkAdjustment</link>
</item>

    </list>

  </section>

</page>