<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Graphics.UI.Gtk.Display.Spinner</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Graphics-UI-Gtk-Display-Spinner.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Graphics-UI-Gtk-Display-Spinner.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">gtk-0.12.0: Binding to the Gtk+ graphical user interface library.</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>portable (depends on GHC)</td></tr><tr><th>Stability</th><td>provisional</td></tr><tr><th>Maintainer</th><td>gtk2hs-users@lists.sourceforge.net</td></tr></table><p class="caption">Graphics.UI.Gtk.Display.Spinner</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Detail
</a></li><li><a href="#g:2">Types
</a></li><li><a href="#g:3">Constructors
</a></li><li><a href="#g:4">Methods
</a></li><li><a href="#g:5">Attributes
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Report messages of minor importance to the user
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:Spinner">Spinner</a> </li><li class="src short"><span class="keyword">class</span> <a href="Graphics-UI-Gtk-Misc-DrawingArea.html#t:DrawingAreaClass">DrawingAreaClass</a> o => <a href="#t:SpinnerClass">SpinnerClass</a> o </li><li class="src short"><a href="#v:spinnerNew">spinnerNew</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-Display-Spinner.html#t:Spinner">Spinner</a></li><li class="src short"><a href="#v:spinnerStart">spinnerStart</a> :: <a href="Graphics-UI-Gtk-Display-Spinner.html#t:SpinnerClass">SpinnerClass</a> spinner => spinner -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:spinnerStop">spinnerStop</a> :: <a href="Graphics-UI-Gtk-Display-Spinner.html#t:SpinnerClass">SpinnerClass</a> spinner => spinner -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:spinnerActive">spinnerActive</a> :: <a href="Graphics-UI-Gtk-Display-Spinner.html#t:SpinnerClass">SpinnerClass</a> spinner => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> spinner <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li></ul></div><div id="interface"><h1 id="g:1">Detail
</h1><div class="doc"><p>A <code><a href="Graphics-UI-Gtk-Display-Spinner.html#t:Spinner">Spinner</a></code> widget displays an icon-size spinning animation. It is often used as an alternative to
a <code><a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBar">ProgressBar</a></code> for displaying indefinite activity, instead of actual progress.
</p><p>To start the animation, use <code><a href="Graphics-UI-Gtk-Display-Spinner.html#v:spinnerStart">spinnerStart</a></code>.
</p></div><h1 id="g:2">Types
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Spinner" class="def">Spinner</a> <a href="src/Graphics-UI-Gtk-Types.html#Spinner" class="link">Source</a></p><div class="subs instances"><p id="control.i:Spinner" class="caption collapser" onclick="toggleSection('i:Spinner')">Instances</p><div id="section.i:Spinner" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Graphics-UI-Gtk-Display-Spinner.html#t:Spinner">Spinner</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Ord.html#t:Ord">Ord</a> <a href="Graphics-UI-Gtk-Display-Spinner.html#t:Spinner">Spinner</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> <a href="Graphics-UI-Gtk-Display-Spinner.html#t:Spinner">Spinner</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Display-Spinner.html#t:SpinnerClass">SpinnerClass</a> <a href="Graphics-UI-Gtk-Display-Spinner.html#t:Spinner">Spinner</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Misc-DrawingArea.html#t:DrawingAreaClass">DrawingAreaClass</a> <a href="Graphics-UI-Gtk-Display-Spinner.html#t:Spinner">Spinner</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> <a href="Graphics-UI-Gtk-Display-Spinner.html#t:Spinner">Spinner</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Abstract-Object.html#t:ObjectClass">ObjectClass</a> <a href="Graphics-UI-Gtk-Display-Spinner.html#t:Spinner">Spinner</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">class</span> <a href="Graphics-UI-Gtk-Misc-DrawingArea.html#t:DrawingAreaClass">DrawingAreaClass</a> o => <a name="t:SpinnerClass" class="def">SpinnerClass</a> o <a href="src/Graphics-UI-Gtk-Types.html#SpinnerClass" class="link">Source</a></p><div class="subs instances"><p id="control.i:SpinnerClass" class="caption collapser" onclick="toggleSection('i:SpinnerClass')">Instances</p><div id="section.i:SpinnerClass" class="show"><table><tr><td class="src"><a href="Graphics-UI-Gtk-Display-Spinner.html#t:SpinnerClass">SpinnerClass</a> <a href="Graphics-UI-Gtk-Display-Spinner.html#t:Spinner">Spinner</a></td><td class="doc empty"> </td></tr></table></div></div></div><h1 id="g:3">Constructors
</h1><div class="top"><p class="src"><a name="v:spinnerNew" class="def">spinnerNew</a> :: <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-Display-Spinner.html#t:Spinner">Spinner</a><a href="src/Graphics-UI-Gtk-Display-Spinner.html#spinnerNew" class="link">Source</a></p><div class="doc"><p>Returns a new spinner widget. Not yet started.
</p></div></div><h1 id="g:4">Methods
</h1><div class="top"><p class="src"><a name="v:spinnerStart" class="def">spinnerStart</a> :: <a href="Graphics-UI-Gtk-Display-Spinner.html#t:SpinnerClass">SpinnerClass</a> spinner => spinner -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/Graphics-UI-Gtk-Display-Spinner.html#spinnerStart" class="link">Source</a></p><div class="doc"><p>Starts the animation of the spinner.
</p></div></div><div class="top"><p class="src"><a name="v:spinnerStop" class="def">spinnerStop</a> :: <a href="Graphics-UI-Gtk-Display-Spinner.html#t:SpinnerClass">SpinnerClass</a> spinner => spinner -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/ghc-prim-0.2.0.0/GHC-Unit.html#t:-40--41-">()</a><a href="src/Graphics-UI-Gtk-Display-Spinner.html#spinnerStop" class="link">Source</a></p><div class="doc"><p>Stops the animation of the spinner.
</p></div></div><h1 id="g:5">Attributes
</h1><div class="top"><p class="src"><a name="v:spinnerActive" class="def">spinnerActive</a> :: <a href="Graphics-UI-Gtk-Display-Spinner.html#t:SpinnerClass">SpinnerClass</a> spinner => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> spinner <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Graphics-UI-Gtk-Display-Spinner.html#spinnerActive" class="link">Source</a></p><div class="doc"><p>Whether the spinner is active.
</p><p>Default value: <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#v:False">False</a></code>
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
