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

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

      type="guide" style="task"

      id="progressbar.py">

  <info>

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

    <link type="guide" xref="beginner.py#display-widgets"/>

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

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

    <credit type="author copyright">

      <name>Marta Maria Casetti</name>

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

      <years>2012</years>

    </credit>

    <desc>A widget which indicates progress visually.</desc>

  </info>

  <title>ProgressBar</title>

  <media type="video" mime="application/ogv" src="media/progressbar.ogv">

    <tt:tt xmlns:tt="http://www.w3.org/ns/ttml">

      <tt:body>

        <tt:div begin="0s" end="6s">

          <tt:p>

              Pressing any key stops and starts this ProgressBar.

          </tt:p>

        </tt:div>

      </tt:body>

    </tt:tt>

  </media>

  
This ProgressBar is stopped and started by pressing any key.

  <links type="section" />

  <section id="code">

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

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

  </section>

  <section id="methods">

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

  <list>

    <item>
Instead of pulse(), that makes the bar go back and forth, if we want the ProgressBar to "fill in" a fraction (a float between 0.0 and 1.0 included) of the bar that has been completed, use set_fraction(fraction).
</item>

    <item>
To set a text and show it (superimposed over the bar) use set_text("text") and set_show_text(True). If a text is not set and set_show_text(True) the text will be the percentage of the work that has been completed.
</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/GtkProgressBar.html">GtkProgressBar</link>
</item>

    <item>
<link href="http://developer.gnome.org/glib/stable/glib-The-Main-Event-Loop.html">GLib - The Main Event Loop</link>
</item>

    <item>
<link href="http://developer.gnome.org/gdk/stable/gdk-Keyboard-Handling">Gdk - Key Values</link>
</item>

  </list>

  </section>

</page>