<!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.ModelView.CellRendererSpinner</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-ModelView-CellRendererSpinner.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Graphics-UI-Gtk-ModelView-CellRendererSpinner.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.ModelView.CellRendererSpinner</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">Class Hierarchy
</a></li><li><a href="#g:3">Types
</a></li><li><a href="#g:4">Constructors
</a></li><li><a href="#g:5">Attributes
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Renders a spinning animation in a cell
</p><ul><li> Module available since Gtk+ version 2.20
</li></ul></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:CellRendererSpinner">CellRendererSpinner</a> </li><li class="src short"><span class="keyword">class</span> <a href="Graphics-UI-Gtk-ModelView-CellRenderer.html#t:CellRendererClass">CellRendererClass</a> o => <a href="#t:CellRendererSpinnerClass">CellRendererSpinnerClass</a> o </li><li class="src short"><a href="#v:castToCellRendererSpinner">castToCellRendererSpinner</a> :: <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> obj => obj -> <a href="Graphics-UI-Gtk-ModelView-CellRendererSpinner.html#t:CellRendererSpinner">CellRendererSpinner</a></li><li class="src short"><a href="#v:toCellRendererSpinner">toCellRendererSpinner</a> :: <a href="Graphics-UI-Gtk-ModelView-CellRendererSpinner.html#t:CellRendererSpinnerClass">CellRendererSpinnerClass</a> o => o -> <a href="Graphics-UI-Gtk-ModelView-CellRendererSpinner.html#t:CellRendererSpinner">CellRendererSpinner</a></li><li class="src short"><a href="#v:cellRendererSpinnerNew">cellRendererSpinnerNew</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-ModelView-CellRendererSpinner.html#t:CellRendererSpinner">CellRendererSpinner</a></li><li class="src short"><a href="#v:cellRendererSpinnerActive">cellRendererSpinnerActive</a> :: <a href="Graphics-UI-Gtk-ModelView-CellRendererSpinner.html#t:CellRendererSpinnerClass">CellRendererSpinnerClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:cellRendererSpinnerPulse">cellRendererSpinnerPulse</a> :: <a href="Graphics-UI-Gtk-ModelView-CellRendererSpinner.html#t:CellRendererSpinnerClass">CellRendererSpinnerClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:cellRendererSpinnerSize">cellRendererSpinnerSize</a> :: <a href="Graphics-UI-Gtk-ModelView-CellRendererSpinner.html#t:CellRendererSpinnerClass">CellRendererSpinnerClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="Graphics-UI-Gtk-MenuComboToolbar-ToolItem.html#t:IconSize">IconSize</a></li></ul></div><div id="interface"><h1 id="g:1">Detail
</h1><div class="doc"><p><code><a href="Graphics-UI-Gtk-ModelView-CellRendererSpinner.html#t:CellRendererSpinner">CellRendererSpinner</a></code> renders a spinning animation in a cell, very similar to <code><a href="Graphics-UI-Gtk-Display-Spinner.html#t:Spinner">Spinner</a></code>. It can
often be used as an alternative to a <code><a href="Graphics-UI-Gtk-ModelView-CellRendererProgress.html#t:CellRendererProgress">CellRendererProgress</a></code> for displaying indefinite activity,
instead of actual progress.
</p><p>To start the animation in a cell, set the <a href="active.html">active</a> property to <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#v:True">True</a></code> and increment the <a href="pulse.html">pulse</a>
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. <code>treeViewColumnAddAttribute</code>.
</p></div><h1 id="g:2">Class Hierarchy
</h1><div class="doc"><pre>
| <code><a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObject">GObject</a></code>
| +----<code><a href="Graphics-UI-Gtk-Abstract-Object.html#t:Object">Object</a></code>
| +----<code><a href="Graphics-UI-Gtk-ModelView-CellRenderer.html#t:CellRenderer">CellRenderer</a></code>
| +----<code><a href="Graphics-UI-Gtk-ModelView-CellRendererSpinner.html#t:CellRendererSpinner">CellRendererSpinner</a></code>
</pre></div><h1 id="g:3">Types
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:CellRendererSpinner" class="def">CellRendererSpinner</a> <a href="src/Graphics-UI-Gtk-Types.html#CellRendererSpinner" class="link">Source</a></p><div class="subs instances"><p id="control.i:CellRendererSpinner" class="caption collapser" onclick="toggleSection('i:CellRendererSpinner')">Instances</p><div id="section.i:CellRendererSpinner" 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-ModelView-CellRendererSpinner.html#t:CellRendererSpinner">CellRendererSpinner</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-ModelView-CellRendererSpinner.html#t:CellRendererSpinner">CellRendererSpinner</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-ModelView-CellRendererSpinner.html#t:CellRendererSpinner">CellRendererSpinner</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-ModelView-CellRendererSpinner.html#t:CellRendererSpinnerClass">CellRendererSpinnerClass</a> <a href="Graphics-UI-Gtk-ModelView-CellRendererSpinner.html#t:CellRendererSpinner">CellRendererSpinner</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-ModelView-CellRenderer.html#t:CellRendererClass">CellRendererClass</a> <a href="Graphics-UI-Gtk-ModelView-CellRendererSpinner.html#t:CellRendererSpinner">CellRendererSpinner</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-ModelView-CellRendererSpinner.html#t:CellRendererSpinner">CellRendererSpinner</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-ModelView-CellRenderer.html#t:CellRendererClass">CellRendererClass</a> o => <a name="t:CellRendererSpinnerClass" class="def">CellRendererSpinnerClass</a> o <a href="src/Graphics-UI-Gtk-Types.html#CellRendererSpinnerClass" class="link">Source</a></p><div class="subs instances"><p id="control.i:CellRendererSpinnerClass" class="caption collapser" onclick="toggleSection('i:CellRendererSpinnerClass')">Instances</p><div id="section.i:CellRendererSpinnerClass" class="show"><table><tr><td class="src"><a href="Graphics-UI-Gtk-ModelView-CellRendererSpinner.html#t:CellRendererSpinnerClass">CellRendererSpinnerClass</a> <a href="Graphics-UI-Gtk-ModelView-CellRendererSpinner.html#t:CellRendererSpinner">CellRendererSpinner</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:castToCellRendererSpinner" class="def">castToCellRendererSpinner</a> :: <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> obj => obj -> <a href="Graphics-UI-Gtk-ModelView-CellRendererSpinner.html#t:CellRendererSpinner">CellRendererSpinner</a><a href="src/Graphics-UI-Gtk-Types.html#castToCellRendererSpinner" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:toCellRendererSpinner" class="def">toCellRendererSpinner</a> :: <a href="Graphics-UI-Gtk-ModelView-CellRendererSpinner.html#t:CellRendererSpinnerClass">CellRendererSpinnerClass</a> o => o -> <a href="Graphics-UI-Gtk-ModelView-CellRendererSpinner.html#t:CellRendererSpinner">CellRendererSpinner</a><a href="src/Graphics-UI-Gtk-Types.html#toCellRendererSpinner" class="link">Source</a></p></div><h1 id="g:4">Constructors
</h1><div class="top"><p class="src"><a name="v:cellRendererSpinnerNew" class="def">cellRendererSpinnerNew</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-ModelView-CellRendererSpinner.html#t:CellRendererSpinner">CellRendererSpinner</a><a href="src/Graphics-UI-Gtk-ModelView-CellRendererSpinner.html#cellRendererSpinnerNew" class="link">Source</a></p><div class="doc"><p>Returns a new cell renderer which will show a spinner to indicate activity.
</p><ul><li> Available since Gtk+ version 2.20
</li></ul></div></div><h1 id="g:5">Attributes
</h1><div class="top"><p class="src"><a name="v:cellRendererSpinnerActive" class="def">cellRendererSpinnerActive</a> :: <a href="Graphics-UI-Gtk-ModelView-CellRendererSpinner.html#t:CellRendererSpinnerClass">CellRendererSpinnerClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <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-ModelView-CellRendererSpinner.html#cellRendererSpinnerActive" class="link">Source</a></p><div class="doc"><p>Whether the spinner is active (ie. shown) in the cell.
</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><ul><li> Available since Gtk+ version 2.20
</li></ul></div></div><div class="top"><p class="src"><a name="v:cellRendererSpinnerPulse" class="def">cellRendererSpinnerPulse</a> :: <a href="Graphics-UI-Gtk-ModelView-CellRendererSpinner.html#t:CellRendererSpinnerClass">CellRendererSpinnerClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</a><a href="src/Graphics-UI-Gtk-ModelView-CellRendererSpinner.html#cellRendererSpinnerPulse" class="link">Source</a></p><div class="doc"><p>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.
</p><p>The <code><a href="Graphics-UI-Gtk-Display-Spinner.html#t:Spinner">Spinner</a></code> widget draws one full cycle of the animation per second by default. You can learn
about the number of frames used by the theme by looking at the <code>numSteps</code> style property and the
duration of the cycle by looking at <code>cycleDuration</code>.
</p><p>Default value: 0
</p><ul><li> Available since Gtk+ version 2.20
</li></ul></div></div><div class="top"><p class="src"><a name="v:cellRendererSpinnerSize" class="def">cellRendererSpinnerSize</a> :: <a href="Graphics-UI-Gtk-ModelView-CellRendererSpinner.html#t:CellRendererSpinnerClass">CellRendererSpinnerClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:Attr">Attr</a> self <a href="Graphics-UI-Gtk-MenuComboToolbar-ToolItem.html#t:IconSize">IconSize</a><a href="src/Graphics-UI-Gtk-ModelView-CellRendererSpinner.html#cellRendererSpinnerSize" class="link">Source</a></p><div class="doc"><p>The <code><a href="Graphics-UI-Gtk-MenuComboToolbar-ToolItem.html#t:IconSize">IconSize</a></code> value that specifies the size of the rendered spinner.
</p><p>Default value: <code><a href="Graphics-UI-Gtk-Display-Image.html#v:IconSizeMenu">IconSizeMenu</a></code>
</p><ul><li> Available since Gtk+ version 2.20
</li></ul></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>
