<?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="GtkSpinner">
<refmeta>
<refentrytitle role="top_of_page" id="GtkSpinner.top_of_page">GtkSpinner</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK4 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GtkSpinner</refname>
<refpurpose>Show a spinner animation</refpurpose>
</refnamediv>

<refsect1 id="GtkSpinner.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="GtkWidget"><returnvalue>GtkWidget</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-spinner-new">gtk_spinner_new</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-spinner-start">gtk_spinner_start</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-spinner-stop">gtk_spinner_stop</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-spinner-set-spinning">gtk_spinner_set_spinning</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-spinner-get-spinning">gtk_spinner_get_spinning</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkSpinner.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="GtkSpinner--spinning">spinning</link></entry><entry role="property_flags">Read / Write</entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkSpinner.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="GtkSpinner-struct">GtkSpinner</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkSpinner.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="GtkWidget">GtkWidget</link>
            <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> GtkSpinner
</screen>
</refsect1>
<refsect1 id="GtkSpinner.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GtkSpinner implements
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>,  <link linkend="GtkBuildable">GtkBuildable</link> and  <link linkend="GtkConstraintTarget">GtkConstraintTarget</link>.</para>

</refsect1>

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

<refsect1 id="GtkSpinner.description" role="desc">
<title role="desc.title">Description</title>
<para>A GtkSpinner widget displays an icon-size spinning animation.
It is often used as an alternative to a <link linkend="GtkProgressBar"><type>GtkProgressBar</type></link> for
displaying indefinite activity, instead of actual progress.</para>
<para>To start the animation, use <link linkend="gtk-spinner-start"><function>gtk_spinner_start()</function></link>, to stop it
use <link linkend="gtk-spinner-stop"><function>gtk_spinner_stop()</function></link>.</para>
<refsect2><title>CSS nodes</title><para>GtkSpinner has a single CSS node with the name spinner.
When the animation is active, the :checked pseudoclass is
added to this node.</para>
</refsect2>

</refsect1>
<refsect1 id="GtkSpinner.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="gtk-spinner-new" role="function">
<title>gtk_spinner_new&#160;()</title>
<indexterm zone="gtk-spinner-new"><primary>gtk_spinner_new</primary></indexterm>
<programlisting language="C"><link linkend="GtkWidget"><returnvalue>GtkWidget</returnvalue></link>&#160;*
gtk_spinner_new (<parameter><type>void</type></parameter>);</programlisting>
<para>Returns a new spinner widget. Not yet started.</para>
<refsect3 id="gtk-spinner-new.returns" role="returns">
<title>Returns</title>
<para> a new <link linkend="GtkSpinner"><type>GtkSpinner</type></link></para>
</refsect3></refsect2>
<refsect2 id="gtk-spinner-start" role="function">
<title>gtk_spinner_start&#160;()</title>
<indexterm zone="gtk-spinner-start"><primary>gtk_spinner_start</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_spinner_start (<parameter><link linkend="GtkSpinner"><type>GtkSpinner</type></link> *spinner</parameter>);</programlisting>
<para>Starts the animation of the spinner.</para>
<refsect3 id="gtk-spinner-start.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>spinner</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkSpinner"><type>GtkSpinner</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-spinner-stop" role="function">
<title>gtk_spinner_stop&#160;()</title>
<indexterm zone="gtk-spinner-stop"><primary>gtk_spinner_stop</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_spinner_stop (<parameter><link linkend="GtkSpinner"><type>GtkSpinner</type></link> *spinner</parameter>);</programlisting>
<para>Stops the animation of the spinner.</para>
<refsect3 id="gtk-spinner-stop.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>spinner</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkSpinner"><type>GtkSpinner</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-spinner-set-spinning" role="function">
<title>gtk_spinner_set_spinning&#160;()</title>
<indexterm zone="gtk-spinner-set-spinning"><primary>gtk_spinner_set_spinning</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_spinner_set_spinning (<parameter><link linkend="GtkSpinner"><type>GtkSpinner</type></link> *spinner</parameter>,
                          <parameter><link linkend="gboolean"><type>gboolean</type></link> spinning</parameter>);</programlisting>
<para>Sets the activity of the spinner.</para>
<refsect3 id="gtk-spinner-set-spinning.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>spinner</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkSpinner"><type>GtkSpinner</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>spinning</para></entry>
<entry role="parameter_description"><para>whether the spinner should be spinning</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-spinner-get-spinning" role="function">
<title>gtk_spinner_get_spinning&#160;()</title>
<indexterm zone="gtk-spinner-get-spinning"><primary>gtk_spinner_get_spinning</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_spinner_get_spinning (<parameter><link linkend="GtkSpinner"><type>GtkSpinner</type></link> *spinner</parameter>);</programlisting>
<para>Returns whether the spinner is spinning.</para>
<refsect3 id="gtk-spinner-get-spinning.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>spinner</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkSpinner"><type>GtkSpinner</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-spinner-get-spinning.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the spinner is active</para>
</refsect3></refsect2>

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

</refsect1>
<refsect1 id="GtkSpinner.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GtkSpinner--spinning" role="property"><title>The <literal>“spinning”</literal> property</title>
<indexterm zone="GtkSpinner--spinning"><primary>GtkSpinner:spinning</primary></indexterm>
<programlisting>  “spinning”                 <link linkend="gboolean"><type>gboolean</type></link></programlisting>
<para>Whether the spinner is spinning.</para><para>Owner: GtkSpinner</para>
<para>Flags: Read / Write</para>
<para>Default value: FALSE</para>
</refsect2>

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

</refsect1>

</refentry>
