<?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/ModelView/CellRendererSpinner.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/ModelView/CellRendererSpinner.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 CellRendererSpinner</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: 25 Mar 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'>-- Renders a spinning animation in a cell</span>
<a name="line-28"></a><span class='hs-comment'>--</span>
<a name="line-29"></a><span class='hs-comment'>-- * Module available since Gtk+ version 2.20</span>
<a name="line-30"></a><span class='hs-comment'>--</span>
<a name="line-31"></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'>ModelView</span><span class='hs-varop'>.</span><span class='hs-conid'>CellRendererSpinner</span> <span class='hs-layout'>(</span>
<a name="line-32"></a><span class='hs-comment'>-- * Detail</span>
<a name="line-33"></a><span class='hs-comment'>-- | 'CellRendererSpinner' renders a spinning animation in a cell, very similar to 'Spinner'. It can</span>
<a name="line-34"></a><span class='hs-comment'>-- often be used as an alternative to a 'CellRendererProgress' for displaying indefinite activity,</span>
<a name="line-35"></a><span class='hs-comment'>-- instead of actual progress.</span>
<a name="line-36"></a><span class='hs-comment'>--</span>
<a name="line-37"></a><span class='hs-comment'>-- To start the animation in a cell, set the "active" property to 'True' and increment the "pulse"</span>
<a name="line-38"></a><span class='hs-comment'>-- property at regular intervals. The usual way to set the cell renderer properties for each cell is</span>
<a name="line-39"></a><span class='hs-comment'>-- to bind them to columns in your tree model using e.g. 'treeViewColumnAddAttribute'.</span>
<a name="line-40"></a>
<a name="line-41"></a><span class='hs-comment'>-- * Class Hierarchy</span>
<a name="line-42"></a><span class='hs-comment'>--</span>
<a name="line-43"></a><span class='hs-comment'>-- |</span>
<a name="line-44"></a><span class='hs-comment'>-- @</span>
<a name="line-45"></a><span class='hs-comment'>-- | 'GObject'</span>
<a name="line-46"></a><span class='hs-comment'>-- | +----'Object'</span>
<a name="line-47"></a><span class='hs-comment'>-- | +----'CellRenderer'</span>
<a name="line-48"></a><span class='hs-comment'>-- | +----'CellRendererSpinner'</span>
<a name="line-49"></a><span class='hs-comment'>-- @</span>
<a name="line-50"></a>
<a name="line-51"></a>
<a name="line-52"></a><span class='hs-comment'>-- * Types</span>
<a name="line-53"></a> <span class='hs-conid'>CellRendererSpinner</span><span class='hs-layout'>,</span>
<a name="line-54"></a> <span class='hs-conid'>CellRendererSpinnerClass</span><span class='hs-layout'>,</span>
<a name="line-55"></a> <span class='hs-varid'>castToCellRendererSpinner</span><span class='hs-layout'>,</span>
<a name="line-56"></a> <span class='hs-varid'>toCellRendererSpinner</span><span class='hs-layout'>,</span>
<a name="line-57"></a>
<a name="line-58"></a><span class='hs-comment'>-- * Constructors</span>
<a name="line-59"></a> <span class='hs-varid'>cellRendererSpinnerNew</span><span class='hs-layout'>,</span>
<a name="line-60"></a>
<a name="line-61"></a><span class='hs-comment'>-- * Attributes</span>
<a name="line-62"></a> <span class='hs-varid'>cellRendererSpinnerActive</span><span class='hs-layout'>,</span>
<a name="line-63"></a> <span class='hs-varid'>cellRendererSpinnerPulse</span><span class='hs-layout'>,</span>
<a name="line-64"></a> <span class='hs-varid'>cellRendererSpinnerSize</span><span class='hs-layout'>,</span>
<a name="line-65"></a>
<a name="line-66"></a><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-67"></a>
<a name="line-68"></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-69"></a>
<a name="line-70"></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-71"></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-72"></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-73"></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-74"></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'>General</span><span class='hs-varop'>.</span><span class='hs-conid'>Structs</span> <span class='hs-layout'>(</span><span class='hs-conid'>IconSize</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-75"></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-76"></a><span class='hs-comment'>{-# LINE 75 "./Graphics/UI/Gtk/ModelView/CellRendererSpinner.chs" #-}</span>
<a name="line-77"></a>
<a name="line-78"></a>
<a name="line-79"></a><span class='hs-comment'>{-# LINE 77 "./Graphics/UI/Gtk/ModelView/CellRendererSpinner.chs" #-}</span>
<a name="line-80"></a>
<a name="line-81"></a>
<a name="line-82"></a><a name="cellRendererSpinnerNew"></a><span class='hs-comment'>-- | Returns a new cell renderer which will show a spinner to indicate activity.</span>
<a name="line-83"></a><span class='hs-comment'>--</span>
<a name="line-84"></a><span class='hs-comment'>-- * Available since Gtk+ version 2.20</span>
<a name="line-85"></a><span class='hs-comment'>--</span>
<a name="line-86"></a><span class='hs-definition'>cellRendererSpinnerNew</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>CellRendererSpinner</span>
<a name="line-87"></a><span class='hs-definition'>cellRendererSpinnerNew</span> <span class='hs-keyglyph'>=</span>
<a name="line-88"></a> <span class='hs-varid'>makeNewObject</span> <span class='hs-varid'>mkCellRendererSpinner</span> <span class='hs-varop'>$</span> <span class='hs-varid'>liftM</span> <span class='hs-varid'>castPtr</span> <span class='hs-varop'>$</span>
<a name="line-89"></a> <span class='hs-varid'>gtk_cell_renderer_spinner_new</span>
<a name="line-90"></a><span class='hs-comment'>{-# LINE 87 "./Graphics/UI/Gtk/ModelView/CellRendererSpinner.chs" #-}</span>
<a name="line-91"></a>
<a name="line-92"></a><a name="cellRendererSpinnerActive"></a><span class='hs-comment'>-- | Whether the spinner is active (ie. shown) in the cell.</span>
<a name="line-93"></a><span class='hs-comment'>--</span>
<a name="line-94"></a><span class='hs-comment'>-- Default value: 'False'</span>
<a name="line-95"></a><span class='hs-comment'>--</span>
<a name="line-96"></a><span class='hs-comment'>-- * Available since Gtk+ version 2.20</span>
<a name="line-97"></a><span class='hs-comment'>--</span>
<a name="line-98"></a><span class='hs-definition'>cellRendererSpinnerActive</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>CellRendererSpinnerClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Attr</span> <span class='hs-varid'>self</span> <span class='hs-conid'>Bool</span>
<a name="line-99"></a><span class='hs-definition'>cellRendererSpinnerActive</span> <span class='hs-keyglyph'>=</span>
<a name="line-100"></a> <span class='hs-varid'>newAttrFromBoolProperty</span> <span class='hs-str'>"active"</span>
<a name="line-101"></a>
<a name="line-102"></a><a name="cellRendererSpinnerPulse"></a><span class='hs-comment'>-- | Pulse of the spinner. Increment this value to draw the next frame of the spinner animation. Usually,</span>
<a name="line-103"></a><span class='hs-comment'>-- you would update this value in a timeout.</span>
<a name="line-104"></a><span class='hs-comment'>--</span>
<a name="line-105"></a><span class='hs-comment'>-- The 'Spinner' widget draws one full cycle of the animation per second by default. You can learn</span>
<a name="line-106"></a><span class='hs-comment'>-- about the number of frames used by the theme by looking at the 'numSteps' style property and the</span>
<a name="line-107"></a><span class='hs-comment'>-- duration of the cycle by looking at 'cycleDuration'.</span>
<a name="line-108"></a><span class='hs-comment'>--</span>
<a name="line-109"></a><span class='hs-comment'>-- Default value: 0</span>
<a name="line-110"></a><span class='hs-comment'>--</span>
<a name="line-111"></a><span class='hs-comment'>-- * Available since Gtk+ version 2.20</span>
<a name="line-112"></a><span class='hs-comment'>--</span>
<a name="line-113"></a><span class='hs-definition'>cellRendererSpinnerPulse</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>CellRendererSpinnerClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Attr</span> <span class='hs-varid'>self</span> <span class='hs-conid'>Int</span>
<a name="line-114"></a><span class='hs-definition'>cellRendererSpinnerPulse</span> <span class='hs-keyglyph'>=</span>
<a name="line-115"></a> <span class='hs-varid'>newAttrFromIntProperty</span> <span class='hs-str'>"pulse"</span>
<a name="line-116"></a>
<a name="line-117"></a><a name="cellRendererSpinnerSize"></a><span class='hs-comment'>-- | The 'IconSize' value that specifies the size of the rendered spinner.</span>
<a name="line-118"></a><span class='hs-comment'>--</span>
<a name="line-119"></a><span class='hs-comment'>-- Default value: 'IconSizeMenu'</span>
<a name="line-120"></a><span class='hs-comment'>--</span>
<a name="line-121"></a><span class='hs-comment'>-- * Available since Gtk+ version 2.20</span>
<a name="line-122"></a><span class='hs-comment'>--</span>
<a name="line-123"></a><span class='hs-definition'>cellRendererSpinnerSize</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>CellRendererSpinnerClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Attr</span> <span class='hs-varid'>self</span> <span class='hs-conid'>IconSize</span>
<a name="line-124"></a><span class='hs-definition'>cellRendererSpinnerSize</span> <span class='hs-keyglyph'>=</span>
<a name="line-125"></a> <span class='hs-varid'>newAttrFromEnumProperty</span> <span class='hs-str'>"size"</span>
<a name="line-126"></a> <span class='hs-varid'>gtk_icon_size_get_type</span>
<a name="line-127"></a><span class='hs-comment'>{-# LINE 123 "./Graphics/UI/Gtk/ModelView/CellRendererSpinner.chs" #-}</span>
<a name="line-128"></a>
<a name="line-129"></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_cell_renderer_spinner_new"</span>
<a name="line-130"></a> <span class='hs-varid'>gtk_cell_renderer_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'>CellRenderer</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-131"></a>
<a name="line-132"></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_icon_size_get_type"</span>
<a name="line-133"></a> <span class='hs-varid'>gtk_icon_size_get_type</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>CUInt</span>
</pre></body>
</html>
