<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
<!ENTITY pi "&#960;">
<!ENTITY solidus "&#8260;">
]>
<refentry id="GtkCellRendererSpinner">
<refmeta>
<refentrytitle role="top_of_page" id="GtkCellRendererSpinner.top_of_page">GtkCellRendererSpinner</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK4 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GtkCellRendererSpinner</refname>
<refpurpose>Renders a spinning animation in a cell</refpurpose>
</refnamediv>

<refsect1 id="GtkCellRendererSpinner.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_proto_type" colwidth="150px"/>
<colspec colname="functions_proto_name"/>
<tbody>
<row><entry role="function_type"><link linkend="GtkCellRenderer"><returnvalue>GtkCellRenderer</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-cell-renderer-spinner-new">gtk_cell_renderer_spinner_new</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkCellRendererSpinner.properties" role="properties">
<title role="properties.title">Properties</title>
<informaltable frame="none">
<tgroup cols="3">
<colspec colname="properties_type" colwidth="150px"/>
<colspec colname="properties_name" colwidth="300px"/>
<colspec colname="properties_flags" colwidth="200px"/>
<tbody>
<row><entry role="property_type"><link linkend="gboolean"><type>gboolean</type></link></entry><entry role="property_name"><link linkend="GtkCellRendererSpinner--active">active</link></entry><entry role="property_flags">Read / Write</entry></row>
<row><entry role="property_type"><link linkend="guint"><type>guint</type></link></entry><entry role="property_name"><link linkend="GtkCellRendererSpinner--pulse">pulse</link></entry><entry role="property_flags">Read / Write</entry></row>
<row><entry role="property_type"><link linkend="GtkIconSize"><type>GtkIconSize</type></link></entry><entry role="property_name"><link linkend="GtkCellRendererSpinner--size">size</link></entry><entry role="property_flags">Read / Write</entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkCellRendererSpinner.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="other_proto_type" colwidth="150px"/>
<colspec colname="other_proto_name"/>
<tbody>
<row><entry role="datatype_keyword"></entry><entry role="function_name"><link linkend="GtkCellRendererSpinner-struct">GtkCellRendererSpinner</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkCellRendererSpinner.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen>    <link linkend="GObject">GObject</link>
    <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> <link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
        <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> <link linkend="GtkCellRenderer">GtkCellRenderer</link>
            <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> GtkCellRendererSpinner
</screen>
</refsect1>

<refsect1 id="GtkCellRendererSpinner.includes"><title>Includes</title><synopsis>#include &lt;gtk/gtk.h&gt;
</synopsis></refsect1>

<refsect1 id="GtkCellRendererSpinner.description" role="desc">
<title role="desc.title">Description</title>
<para>GtkCellRendererSpinner renders a spinning animation in a cell, very
similar to <link linkend="GtkSpinner"><type>GtkSpinner</type></link>. It can often be used as an alternative
to a <link linkend="GtkCellRendererProgress"><type>GtkCellRendererProgress</type></link> for displaying indefinite activity,
instead of actual progress.</para>
<para>To start the animation in a cell, set the <link linkend="GtkCellRendererSpinner--active"><type>“active”</type></link>
property to <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> and increment the <link linkend="GtkCellRendererSpinner--pulse"><type>“pulse”</type></link> 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="gtk-tree-view-column-add-attribute"><function>gtk_tree_view_column_add_attribute()</function></link>.</para>

</refsect1>
<refsect1 id="GtkCellRendererSpinner.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="gtk-cell-renderer-spinner-new" role="function">
<title>gtk_cell_renderer_spinner_new&#160;()</title>
<indexterm zone="gtk-cell-renderer-spinner-new"><primary>gtk_cell_renderer_spinner_new</primary></indexterm>
<programlisting language="C"><link linkend="GtkCellRenderer"><returnvalue>GtkCellRenderer</returnvalue></link>&#160;*
gtk_cell_renderer_spinner_new (<parameter><type>void</type></parameter>);</programlisting>
<para>Returns a new cell renderer which will show a spinner to indicate
activity.</para>
<refsect3 id="gtk-cell-renderer-spinner-new.returns" role="returns">
<title>Returns</title>
<para> a new <link linkend="GtkCellRenderer"><type>GtkCellRenderer</type></link></para>
</refsect3></refsect2>

</refsect1>
<refsect1 id="GtkCellRendererSpinner.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="GtkCellRendererSpinner-struct" role="struct">
<title>GtkCellRendererSpinner</title>
<indexterm zone="GtkCellRendererSpinner-struct"><primary>GtkCellRendererSpinner</primary></indexterm>
<programlisting language="C">typedef struct _GtkCellRendererSpinner GtkCellRendererSpinner;</programlisting>
</refsect2>

</refsect1>
<refsect1 id="GtkCellRendererSpinner.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GtkCellRendererSpinner--active" role="property"><title>The <literal>“active”</literal> property</title>
<indexterm zone="GtkCellRendererSpinner--active"><primary>GtkCellRendererSpinner:active</primary></indexterm>
<programlisting>  “active”                   <link linkend="gboolean"><type>gboolean</type></link></programlisting>
<para>Whether the spinner is active (ie. shown) in the cell.</para><para>Owner: GtkCellRendererSpinner</para>
<para>Flags: Read / Write</para>
<para>Default value: FALSE</para>
</refsect2>
<refsect2 id="GtkCellRendererSpinner--pulse" role="property"><title>The <literal>“pulse”</literal> property</title>
<indexterm zone="GtkCellRendererSpinner--pulse"><primary>GtkCellRendererSpinner:pulse</primary></indexterm>
<programlisting>  “pulse”                    <link linkend="guint"><type>guint</type></link></programlisting>
<para>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.</para>
<para>By default, the <link linkend="GtkSpinner"><type>GtkSpinner</type></link> widget draws one full cycle of the animation,
consisting of 12 frames, in 750 milliseconds.</para>
<para>Owner: GtkCellRendererSpinner</para>
<para>Flags: Read / Write</para>
<para>Default value: 0</para>
</refsect2>
<refsect2 id="GtkCellRendererSpinner--size" role="property"><title>The <literal>“size”</literal> property</title>
<indexterm zone="GtkCellRendererSpinner--size"><primary>GtkCellRendererSpinner:size</primary></indexterm>
<programlisting>  “size”                     <link linkend="GtkIconSize"><type>GtkIconSize</type></link></programlisting>
<para>The <link linkend="GtkIconSize"><type>GtkIconSize</type></link> value that specifies the size of the rendered spinner.</para>
<para>Owner: GtkCellRendererSpinner</para>
<para>Flags: Read / Write</para>
<para>Default value: GTK_ICON_SIZE_INHERIT</para>
</refsect2>

</refsect1>
<refsect1 id="GtkCellRendererSpinner.see-also">
<title>See Also</title>
<para><link linkend="GtkSpinner"><type>GtkSpinner</type></link>, <link linkend="GtkCellRendererProgress"><type>GtkCellRendererProgress</type></link></para>

</refsect1>

</refentry>
