<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="class-gtkspinner">
  <refnamediv>
    <refname>gtk.Spinner</refname>
    <refpurpose>show a spinner animation (new in PyGTK 2.22)</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.Spinner</classname></ooclass>
      <ooclass><classname><link linkend="class-gtkdrawingarea">gtk.DrawingArea</link></classname></ooclass>
      <constructorsynopsis language="python">
        <methodname><link linkend="constructor-gtkspinner">gtk.Spinner</link></methodname>
        <methodparam></methodparam>
      </constructorsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkspinner--start">start</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkspinner--stop">stop</link></methodname>
        <methodparam></methodparam>
      </methodsynopsis>
    </classsynopsis>

  </refsect1>

  <refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">GObject</link>
  +-- <link linkend="class-gtkobject">gtk.Object</link>
    +-- <link linkend="class-gtkwidget">gtk.Widget</link>
      +-- <link linkend="class-gtkdrawingarea">gtk.DrawingArea</link>
        +-- <link linkend="class-gtkspinner">gtk.Spinner</link>
</synopsis>

  </refsect1>

  <refsect1>
    <title>Implemented Interfaces</title>
    <para>
      <link linkend="class-gtkspinner"><classname>gtk.Spinner</classname></link>
      implements
      <link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
      <link linkend="class-atkimplementor"><classname>atk.ImplementorIFace</classname></link>
    </para>
  </refsect1>

  <refsect1 id="properties-gtkspinner">
    <title>gtk.Spinner Properties</title>

    <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
    <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>

    <blockquote role="properties">
      <informaltable pgwide="1" frame="none">
        <tgroup cols="3">
          <colspec column="1" colwidth="1in"/>
          <colspec column="2" colwidth="1in"/>
          <colspec column="3" colwidth="4in"/>
          <tbody>
            <row valign="top">
              <entry>"active"</entry>
              <entry>Read-Write</entry>
              <entry>Whether the spinner is active.
              Default value: <literal>False</literal>
              This property is available in GTK+ 2.20 and above.</entry>
            </row>
          </tbody>
        </tgroup>
      </informaltable>
    </blockquote>

  </refsect1>

  <refsect1 id="style-properties-gtkspinner">
    <title>gtk.Spinner Style Properties</title>

    <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>

    <blockquote role="properties">
      <informaltable pgwide="1" frame="none">
        <tgroup cols="3">
          <colspec column="1" colwidth="1in"/>
          <colspec column="2" colwidth="1in"/>
          <colspec column="3" colwidth="4in"/>
          <tbody>
            <row valign="top">
              <entry>"cycle-duration"</entry>
              <entry>Read</entry>
              <entry>The duration in milliseconds for the spinner to complete a full cycle.
              Allowed values: &gt;= 500
              Default value: 1000
              This property is available in GTK+ 2.20 and above.</entry>
            </row>
            <row valign="top">
              <entry>"num-steps"</entry>
              <entry>Read</entry>
              <entry>The number of steps for the spinner to complete a full loop. The animation will complete a full cycle in one second by default (see the "cycle-duration" style property).
              Allowed values: &gt;= 1
              Default value: 12
              This property is available in GTK+ 2.20 and above.</entry>
            </row>
          </tbody>
        </tgroup>
      </informaltable>
    </blockquote>

  </refsect1>

  <refsect1 id="signal-prototypes-gtkspinner">
    <title>gtk.Spinner Signal Prototypes</title>

    <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>

  </refsect1>

  <refsect1>
    <title>Description</title>

    <note>
      <para>This widget is available in PyGTK 2.22 and above.</para>
    </note>

    <para>A GtkSpinner widget displays an icon-size spinning animation. It is often used as an
    alternative to a GtkProgressBar for displaying indefinite activity, instead of actual progress.</para>

    <para>To start the animation, use <link linkend="method-gtkspinner--start"><methodname>start</methodname></link>(),
    to stop it use <link linkend="method-gtkspinner--stop"><methodname>stop</methodname></link>().</para>

  </refsect1>

  <refsect1>
    <title>Constructor</title>

    <programlisting><constructorsynopsis language="python">
        <methodname><link linkend="constructor-gtkspinner">gtk.Spinner</link></methodname>
        <methodparam></methodparam>
      </constructorsynopsis></programlisting>
    <variablelist>
      <varlistentry>
        <term><emphasis>Returns</emphasis>&nbsp;:</term>
        <listitem><simpara>a new <link linkend="class-gtkspinner"><classname>gtk.Spinner</classname></link></simpara></listitem>
      </varlistentry>
    </variablelist>
    <note>
      <para>This constructor is available in PyGTK 2.22 and above.</para>
    </note>

    <para>Returns a new spinner widget. Not yet started.</para>


  </refsect1>

  <refsect1>
    <title>Methods</title>

    <refsect2 id="method-gtkspinner--start">
      <title>gtk.Spinner.start</title>

      <programlisting><methodsynopsis language="python">
          <methodname>start</methodname>
          <methodparam></methodparam>
        </methodsynopsis></programlisting>
      <note>
        <para>This method is available in PyGTK 2.22 and above.</para>
      </note>

      <para>Starts the animation of the spinner.</para>
    </refsect2>

    <refsect2 id="method-gtkspinner--stop">
      <title>gtk.Spinner.stop</title>

      <programlisting><methodsynopsis language="python">
          <methodname>stop</methodname>
          <methodparam></methodparam>
        </methodsynopsis></programlisting>
      <note>
        <para>This method is available in PyGTK 2.22 and above.</para>
      </note>

      <para>Stops the animation of the spinner.</para>
    </refsect2>

  </refsect1>

</refentry>
