<?xml version="1.0"?>
<!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="EphySpinner">
<refmeta>
<refentrytitle role="top_of_page" id="EphySpinner.top_of_page">EphySpinner</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>EPIPHANY Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>EphySpinner</refname>
<refpurpose></refpurpose>
</refnamediv>

<refsynopsisdiv id="EphySpinner.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="EphySpinner-struct">EphySpinner</link>;
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="ephy-spinner-new">ephy_spinner_new</link>                    (void);
<link linkend="void">void</link>                <link linkend="ephy-spinner-start">ephy_spinner_start</link>                  (<link linkend="EphySpinner">EphySpinner</link> *throbber);
<link linkend="void">void</link>                <link linkend="ephy-spinner-stop">ephy_spinner_stop</link>                   (<link linkend="EphySpinner">EphySpinner</link> *throbber);
<link linkend="void">void</link>                <link linkend="ephy-spinner-set-size">ephy_spinner_set_size</link>               (<link linkend="EphySpinner">EphySpinner</link> *spinner,
                                                         <link linkend="GtkIconSize">GtkIconSize</link> size);
</synopsis>
</refsynopsisdiv>

<refsect1 id="EphySpinner.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
         +----<link linkend="GtkObject">GtkObject</link>
               +----<link linkend="GtkWidget">GtkWidget</link>
                     +----EphySpinner
</synopsis>
</refsect1>



<refsect1 id="EphySpinner.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
EphySpinner implements
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
</refsect1>





<refsect1 id="EphySpinner.description" role="desc">
<title role="desc.title">Description</title>

<para>
</para>
</refsect1>

<refsect1 id="EphySpinner.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="EphySpinner-struct" role="struct">
<title>EphySpinner</title>
<indexterm zone="EphySpinner-struct"><primary>EphySpinner</primary></indexterm>
<programlisting>typedef struct _EphySpinner EphySpinner;</programlisting>
<para>
</para></refsect2>
<refsect2 id="ephy-spinner-new" role="function">
<title>ephy_spinner_new ()</title>
<indexterm zone="ephy-spinner-new"><primary>ephy_spinner_new</primary></indexterm>
<programlisting><link linkend="GtkWidget">GtkWidget</link> *         ephy_spinner_new                    (void);</programlisting>
<para>
Creates a new <link linkend="EphySpinner."><type>EphySpinner.</type></link> The spinner is a widget
that gives the user feedback about network status with
an animated image.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the spinner <link linkend="GtkWidget"><type>GtkWidget</type></link>

</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="ephy-spinner-start" role="function">
<title>ephy_spinner_start ()</title>
<indexterm zone="ephy-spinner-start"><primary>ephy_spinner_start</primary></indexterm>
<programlisting><link linkend="void">void</link>                ephy_spinner_start                  (<link linkend="EphySpinner">EphySpinner</link> *throbber);</programlisting>
<para>
Starts the spinner animation.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>throbber</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="ephy-spinner-stop" role="function">
<title>ephy_spinner_stop ()</title>
<indexterm zone="ephy-spinner-stop"><primary>ephy_spinner_stop</primary></indexterm>
<programlisting><link linkend="void">void</link>                ephy_spinner_stop                   (<link linkend="EphySpinner">EphySpinner</link> *throbber);</programlisting>
<para>
Stops the spinner animation.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>throbber</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="ephy-spinner-set-size" role="function">
<title>ephy_spinner_set_size ()</title>
<indexterm zone="ephy-spinner-set-size"><primary>ephy_spinner_set_size</primary></indexterm>
<programlisting><link linkend="void">void</link>                ephy_spinner_set_size               (<link linkend="EphySpinner">EphySpinner</link> *spinner,
                                                         <link linkend="GtkIconSize">GtkIconSize</link> size);</programlisting>
<para>
Set the size of the spinner to <parameter>size</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>spinner</parameter>&#160;:</term>
<listitem><simpara> an <link linkend="EphySpinner"><type>EphySpinner</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>size</parameter>&#160;:</term>
<listitem><simpara> a new size for the spinner, as a <link linkend="GtkIconSize"><type>GtkIconSize</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
