<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ -->
<title>dist/build/Graphics/UI/Gtk/Display/Spinner.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a>
<a name="line-2"></a><span class='hs-comment'>{-# LINE 2 "./Graphics/UI/Gtk/Display/Spinner.chs" #-}</span>
<a name="line-3"></a><span class='hs-comment'>-- -*-haskell-*-</span>
<a name="line-4"></a><span class='hs-comment'>-- GIMP Toolkit (GTK) Widget Spinner</span>
<a name="line-5"></a><span class='hs-comment'>--</span>
<a name="line-6"></a><span class='hs-comment'>-- Author : Andy Stewart</span>
<a name="line-7"></a><span class='hs-comment'>--</span>
<a name="line-8"></a><span class='hs-comment'>-- Created: 17 Aug 2010</span>
<a name="line-9"></a><span class='hs-comment'>--</span>
<a name="line-10"></a><span class='hs-comment'>-- Copyright (C) 2010 Andy Stewart</span>
<a name="line-11"></a><span class='hs-comment'>--</span>
<a name="line-12"></a><span class='hs-comment'>-- This library is free software; you can redistribute it and/or</span>
<a name="line-13"></a><span class='hs-comment'>-- modify it under the terms of the GNU Lesser General Public</span>
<a name="line-14"></a><span class='hs-comment'>-- License as published by the Free Software Foundation; either</span>
<a name="line-15"></a><span class='hs-comment'>-- version 2.1 of the License, or (at your option) any later version.</span>
<a name="line-16"></a><span class='hs-comment'>--</span>
<a name="line-17"></a><span class='hs-comment'>-- This library is distributed in the hope that it will be useful,</span>
<a name="line-18"></a><span class='hs-comment'>-- but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="line-19"></a><span class='hs-comment'>-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="line-20"></a><span class='hs-comment'>-- Lesser General Public License for more details.</span>
<a name="line-21"></a><span class='hs-comment'>--</span>
<a name="line-22"></a><span class='hs-comment'>-- |</span>
<a name="line-23"></a><span class='hs-comment'>-- Maintainer : gtk2hs-users@lists.sourceforge.net</span>
<a name="line-24"></a><span class='hs-comment'>-- Stability : provisional</span>
<a name="line-25"></a><span class='hs-comment'>-- Portability : portable (depends on GHC)</span>
<a name="line-26"></a><span class='hs-comment'>--</span>
<a name="line-27"></a><span class='hs-comment'>-- Report messages of minor importance to the user</span>
<a name="line-28"></a><span class='hs-comment'>--</span>
<a name="line-29"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>UI</span><span class='hs-varop'>.</span><span class='hs-conid'>Gtk</span><span class='hs-varop'>.</span><span class='hs-conid'>Display</span><span class='hs-varop'>.</span><span class='hs-conid'>Spinner</span> <span class='hs-layout'>(</span>
<a name="line-30"></a>
<a name="line-31"></a><span class='hs-comment'>-- * Detail</span>
<a name="line-32"></a><span class='hs-comment'>--</span>
<a name="line-33"></a><span class='hs-comment'>-- | A 'Spinner' widget displays an icon-size spinning animation. It is often used as an alternative to</span>
<a name="line-34"></a><span class='hs-comment'>-- a 'ProgressBar' for displaying indefinite activity, instead of actual progress.</span>
<a name="line-35"></a><span class='hs-comment'>--</span>
<a name="line-36"></a><span class='hs-comment'>-- To start the animation, use 'spinnerStart'.</span>
<a name="line-37"></a>
<a name="line-38"></a><span class='hs-comment'>-- * Types</span>
<a name="line-39"></a> <span class='hs-conid'>Spinner</span><span class='hs-layout'>,</span>
<a name="line-40"></a> <span class='hs-conid'>SpinnerClass</span><span class='hs-layout'>,</span>
<a name="line-41"></a>
<a name="line-42"></a><span class='hs-comment'>-- * Constructors</span>
<a name="line-43"></a> <span class='hs-varid'>spinnerNew</span><span class='hs-layout'>,</span>
<a name="line-44"></a>
<a name="line-45"></a><span class='hs-comment'>-- * Methods</span>
<a name="line-46"></a> <span class='hs-varid'>spinnerStart</span><span class='hs-layout'>,</span>
<a name="line-47"></a> <span class='hs-varid'>spinnerStop</span><span class='hs-layout'>,</span>
<a name="line-48"></a>
<a name="line-49"></a><span class='hs-comment'>-- * Attributes</span>
<a name="line-50"></a> <span class='hs-varid'>spinnerActive</span><span class='hs-layout'>,</span>
<a name="line-51"></a>
<a name="line-52"></a><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-53"></a>
<a name="line-54"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span> <span class='hs-layout'>(</span><span class='hs-varid'>liftM</span><span class='hs-layout'>)</span>
<a name="line-55"></a>
<a name="line-56"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Glib</span><span class='hs-varop'>.</span><span class='hs-conid'>FFI</span>
<a name="line-57"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Glib</span><span class='hs-varop'>.</span><span class='hs-conid'>UTFString</span>
<a name="line-58"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Glib</span><span class='hs-varop'>.</span><span class='hs-conid'>Attributes</span>
<a name="line-59"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Glib</span><span class='hs-varop'>.</span><span class='hs-conid'>Properties</span>
<a name="line-60"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>UI</span><span class='hs-varop'>.</span><span class='hs-conid'>Gtk</span><span class='hs-varop'>.</span><span class='hs-conid'>Abstract</span><span class='hs-varop'>.</span><span class='hs-conid'>Object</span> <span class='hs-layout'>(</span><span class='hs-varid'>makeNewObject</span><span class='hs-layout'>)</span>
<a name="line-61"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>UI</span><span class='hs-varop'>.</span><span class='hs-conid'>Gtk</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span>
<a name="line-62"></a><span class='hs-comment'>{-# LINE 61 "./Graphics/UI/Gtk/Display/Spinner.chs" #-}</span>
<a name="line-63"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>UI</span><span class='hs-varop'>.</span><span class='hs-conid'>Gtk</span><span class='hs-varop'>.</span><span class='hs-conid'>Signals</span>
<a name="line-64"></a><span class='hs-comment'>{-# LINE 62 "./Graphics/UI/Gtk/Display/Spinner.chs" #-}</span>
<a name="line-65"></a>
<a name="line-66"></a>
<a name="line-67"></a><span class='hs-comment'>{-# LINE 64 "./Graphics/UI/Gtk/Display/Spinner.chs" #-}</span>
<a name="line-68"></a>
<a name="line-69"></a>
<a name="line-70"></a><span class='hs-comment'>--------------------</span>
<a name="line-71"></a><span class='hs-comment'>-- Constructors</span>
<a name="line-72"></a>
<a name="line-73"></a><a name="spinnerNew"></a><span class='hs-comment'>-- | Returns a new spinner widget. Not yet started.</span>
<a name="line-74"></a><span class='hs-definition'>spinnerNew</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Spinner</span>
<a name="line-75"></a><span class='hs-definition'>spinnerNew</span> <span class='hs-keyglyph'>=</span>
<a name="line-76"></a> <span class='hs-varid'>makeNewObject</span> <span class='hs-varid'>mkSpinner</span> <span class='hs-varop'>$</span>
<a name="line-77"></a> <span class='hs-varid'>liftM</span> <span class='hs-layout'>(</span><span class='hs-varid'>castPtr</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Ptr</span> <span class='hs-conid'>Widget</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Ptr</span> <span class='hs-conid'>Spinner</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span>
<a name="line-78"></a> <span class='hs-varid'>gtk_spinner_new</span>
<a name="line-79"></a><span class='hs-comment'>{-# LINE 75 "./Graphics/UI/Gtk/Display/Spinner.chs" #-}</span>
<a name="line-80"></a>
<a name="line-81"></a><span class='hs-comment'>--------------------</span>
<a name="line-82"></a><span class='hs-comment'>-- Methods</span>
<a name="line-83"></a>
<a name="line-84"></a><a name="spinnerStart"></a><span class='hs-comment'>-- | Starts the animation of the spinner.</span>
<a name="line-85"></a><span class='hs-definition'>spinnerStart</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>SpinnerClass</span> <span class='hs-varid'>spinner</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>spinner</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-86"></a><span class='hs-definition'>spinnerStart</span> <span class='hs-varid'>spinner</span> <span class='hs-keyglyph'>=</span>
<a name="line-87"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>Spinner</span> <span class='hs-varid'>arg1</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>arg1</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>argPtr1</span> <span class='hs-keyglyph'>-></span><span class='hs-varid'>gtk_spinner_start</span> <span class='hs-varid'>argPtr1</span><span class='hs-layout'>)</span>
<a name="line-88"></a><span class='hs-comment'>{-# LINE 83 "./Graphics/UI/Gtk/Display/Spinner.chs" #-}</span>
<a name="line-89"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toSpinner</span> <span class='hs-varid'>spinner</span><span class='hs-layout'>)</span>
<a name="line-90"></a>
<a name="line-91"></a><a name="spinnerStop"></a><span class='hs-comment'>-- | Stops the animation of the spinner.</span>
<a name="line-92"></a><span class='hs-definition'>spinnerStop</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>SpinnerClass</span> <span class='hs-varid'>spinner</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>spinner</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-93"></a><span class='hs-definition'>spinnerStop</span> <span class='hs-varid'>spinner</span> <span class='hs-keyglyph'>=</span>
<a name="line-94"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>Spinner</span> <span class='hs-varid'>arg1</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>arg1</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>argPtr1</span> <span class='hs-keyglyph'>-></span><span class='hs-varid'>gtk_spinner_stop</span> <span class='hs-varid'>argPtr1</span><span class='hs-layout'>)</span>
<a name="line-95"></a><span class='hs-comment'>{-# LINE 89 "./Graphics/UI/Gtk/Display/Spinner.chs" #-}</span>
<a name="line-96"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toSpinner</span> <span class='hs-varid'>spinner</span><span class='hs-layout'>)</span>
<a name="line-97"></a>
<a name="line-98"></a><span class='hs-comment'>--------------------</span>
<a name="line-99"></a><span class='hs-comment'>-- Attributes</span>
<a name="line-100"></a>
<a name="line-101"></a><a name="spinnerActive"></a><span class='hs-comment'>-- | Whether the spinner is active.</span>
<a name="line-102"></a><span class='hs-comment'>--</span>
<a name="line-103"></a><span class='hs-comment'>-- Default value: 'False'</span>
<a name="line-104"></a><span class='hs-definition'>spinnerActive</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>SpinnerClass</span> <span class='hs-varid'>spinner</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Attr</span> <span class='hs-varid'>spinner</span> <span class='hs-conid'>Bool</span>
<a name="line-105"></a><span class='hs-definition'>spinnerActive</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>newAttrFromBoolProperty</span> <span class='hs-str'>"active"</span>
<a name="line-106"></a>
<a name="line-107"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>unsafe</span> <span class='hs-str'>"gtk_spinner_new"</span>
<a name="line-108"></a> <span class='hs-varid'>gtk_spinner_new</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>Widget</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-109"></a>
<a name="line-110"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>safe</span> <span class='hs-str'>"gtk_spinner_start"</span>
<a name="line-111"></a> <span class='hs-varid'>gtk_spinner_start</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>Spinner</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-112"></a>
<a name="line-113"></a><span class='hs-keyword'>foreign</span> <span class='hs-keyword'>import</span> <span class='hs-keyword'>ccall</span> <span class='hs-keyword'>safe</span> <span class='hs-str'>"gtk_spinner_stop"</span>
<a name="line-114"></a> <span class='hs-varid'>gtk_spinner_stop</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>Spinner</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
</pre></body>
</html>
