<?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-gtkcellrendererspinner">

  <refnamediv>
    <refname>gtk.CellRendererSpinner</refname>
      <refpurpose>an object that renders a spinning animation in a cell (new in PyGTK 2.22)</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.CellRendererSpinner</classname></ooclass>
      <ooclass><classname><link linkend="class-gtkcellrenderer">gtk.CellRenderer</link></classname></ooclass>
      <constructorsynopsis language="python">
        <methodname><link linkend="constructor-gtkcellrendererspinner">gtk.CellRendererSpinner</link></methodname>
        <methodparam></methodparam>
      </constructorsynopsis>
</classsynopsis>

  </refsect1>

  <refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-gtkobject">gtk.Object</link>
    +-- <link linkend="class-gtkcellrenderer">gtk.CellRenderer</link>
      +-- <link linkend="class-gtkcellrendererspinner">gtk.CellRendererSpinner</link>
</synopsis>

  </refsect1>

  <refsect1 id="properties-gtkcellrendererspinner">
    <title>gtk.CellRendererSpinner Properties</title>

    <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
    <para><link linkend="properties-gtkcellrenderer">gtk.CellRenderer Properties</link></para>
    <para><link linkend="properties-gtkcellrenderertext">gtk.CellRendererText 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>Wheter the spinner is active (ie. shown) in the cell. Default value: <literal>False</literal></entry>
	    </row>

	    <row valign="top">
	      <entry>"pulse"</entry>
	      <entry>Read-Write</entry>
	      <entry>Pulse of the spinner. Increment this value to draw the next frame of the spinner animation. Usually, you would update this value in a timeout. Default value: 0</entry>
	    </row>

	    <row valign="top">
	      <entry>"size"</entry>
	      <entry>Read-Write</entry>
	      <entry>One of the <xref linkend="gtk-icon-size-constants" endterm="gtk-icon-size-constants-title"></xref> that specifies the size of the renderer spinner. Default value: gtk.ICON_SIZE_MENU</entry>
	    </row>

	  </tbody>
	</tgroup>
      </informaltable>
    </blockquote>

  </refsect1>

  <refsect1 id="signal-prototypes-gtkcellrendererspinner">
    <title>gtk.CellRendererSpin 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-gtkcellrenderer">gtk.CellRenderer Signal Prototypes</link></para>
</refsect1>

  <refsect1>
    <title>Description</title>

    <para><link linkend="class-gtkcellrendererspinner"><classname>gtk.CellRendererSpinner</classname></link> renders a spinning
    animation in a cell, very similar to <link linkend="class-gtkspinner"><classname>gtk.Spinner</classname></link>. It can
    often be used as an alternative to a <link linkend="class-gtkcellrendererprogress"><classname>gtk.CellRendererProgress</classname></link>
    for displaying indefinite activity, instead of actual progress.</para>

    <para>To start the animation in a cell, set the "active" property to <literal>True</literal> and increment the "pulse" property
    at regular intervals. The usual way to set the cell renderer properties for each cell is to bind them to columns in your tree
    model using e.g. <link linkend="method-gtktreeviewcolumn--add-attribute"><methodname>gtk.TreeViewColumn.add_attribute</methodname></link>().</para>

  </refsect1>

  <refsect1>
    <title>Constructor</title>

    <refsect2 id="constructor-gtkcellrendererspinner">
      <title>gtk.CellRendererSpinner</title>

      <programlisting><constructorsynopsis language="python">
        <methodname>gtk.CellRendererSpinner</methodname>
        <methodparam></methodparam>
      </constructorsynopsis></programlisting>

      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a new <link
          linkend="class-gtkcellrendererspinner"><classname>gtk.CellRendererSpinner</classname></link></simpara></listitem>
        </varlistentry>
      </variablelist>

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

      <para>Creates a new <link
      linkend="class-gtkcellrendererspinner"><classname>gtk.CellRendererSpinner</classname></link>.</para>

    </refsect2>

  </refsect1>

</refentry>
