<!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.ProgressBar</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-ProgressBar.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Graphics-UI-Gtk-Display-ProgressBar.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.ProgressBar</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">Methods
</a></li><li><a href="#g:6">Attributes
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>A widget which indicates progress visually
</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:ProgressBar">ProgressBar</a> </li><li class="src short"><span class="keyword">class</span> <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> o => <a href="#t:ProgressBarClass">ProgressBarClass</a> o </li><li class="src short"><a href="#v:castToProgressBar">castToProgressBar</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-Display-ProgressBar.html#t:ProgressBar">ProgressBar</a></li><li class="src short"><a href="#v:gTypeProgressBar">gTypeProgressBar</a> :: <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:GType">GType</a></li><li class="src short"><a href="#v:toProgressBar">toProgressBar</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> o => o -> <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBar">ProgressBar</a></li><li class="src short"><a href="#v:progressBarNew">progressBarNew</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-ProgressBar.html#t:ProgressBar">ProgressBar</a></li><li class="src short"><a href="#v:progressBarPulse">progressBarPulse</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> self => self -> <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:progressBarSetText">progressBarSetText</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <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:progressBarSetFraction">progressBarSetFraction</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Double">Double</a> -> <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:progressBarSetPulseStep">progressBarSetPulseStep</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Double">Double</a> -> <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:progressBarGetFraction">progressBarGetFraction</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> self => self -> <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/base-4.3.1.0/Prelude.html#t:Double">Double</a></li><li class="src short"><a href="#v:progressBarGetPulseStep">progressBarGetPulseStep</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> self => self -> <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/base-4.3.1.0/Prelude.html#t:Double">Double</a></li><li class="src short"><a href="#v:progressBarGetText">progressBarGetText</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> self => self -> <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/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>)</li><li class="src short"><span class="keyword">data</span> <a href="#t:ProgressBarOrientation">ProgressBarOrientation</a> <ul class="subs"><li>= <a href="#v:ProgressLeftToRight">ProgressLeftToRight</a> </li><li>| <a href="#v:ProgressRightToLeft">ProgressRightToLeft</a> </li><li>| <a href="#v:ProgressBottomToTop">ProgressBottomToTop</a> </li><li>| <a href="#v:ProgressTopToBottom">ProgressTopToBottom</a> </li></ul></li><li class="src short"><a href="#v:progressBarSetOrientation">progressBarSetOrientation</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> self => self -> <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarOrientation">ProgressBarOrientation</a> -> <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:progressBarGetOrientation">progressBarGetOrientation</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> self => self -> <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-ProgressBar.html#t:ProgressBarOrientation">ProgressBarOrientation</a></li><li class="src short"><a href="#v:progressBarSetEllipsize">progressBarSetEllipsize</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/pango-0.12.0/Graphics-Rendering-Pango-Enums.html#t:EllipsizeMode">EllipsizeMode</a> -> <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:progressBarGetEllipsize">progressBarGetEllipsize</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> self => self -> <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/pango-0.12.0/Graphics-Rendering-Pango-Enums.html#t:EllipsizeMode">EllipsizeMode</a></li><li class="src short"><a href="#v:progressBarOrientation">progressBarOrientation</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</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-Display-ProgressBar.html#t:ProgressBarOrientation">ProgressBarOrientation</a></li><li class="src short"><a href="#v:progressBarDiscreteBlocks">progressBarDiscreteBlocks</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</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:progressBarFraction">progressBarFraction</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</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/Prelude.html#t:Double">Double</a></li><li class="src short"><a href="#v:progressBarPulseStep">progressBarPulseStep</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</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/Prelude.html#t:Double">Double</a></li><li class="src short"><a href="#v:progressBarText">progressBarText</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:ReadWriteAttr">ReadWriteAttr</a> self (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>) <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li class="src short"><a href="#v:progressBarEllipsize">progressBarEllipsize</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</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/pango-0.12.0/Graphics-Rendering-Pango-Enums.html#t:EllipsizeMode">EllipsizeMode</a></li></ul></div><div id="interface"><h1 id="g:1">Detail
</h1><div class="doc"><p>The <code><a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBar">ProgressBar</a></code> is typically used to display the progress of a long
running operation. It provides a visual clue that processing is underway.
The <code><a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBar">ProgressBar</a></code> can be used in two different modes: percentage mode and
activity mode.
</p><p>When an application can determine how much work needs to take place (e.g.
read a fixed number of bytes from a file) and can monitor its progress, it
can use the <code><a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBar">ProgressBar</a></code> in percentage mode and the user sees a growing bar
indicating the percentage of the work that has been completed. In this mode,
the application is required to call <code><a href="Graphics-UI-Gtk-Display-ProgressBar.html#v:progressBarSetFraction">progressBarSetFraction</a></code> periodically to
update the progress bar.
</p><p>When an application has no accurate way of knowing the amount of work to
do, it can use the <code><a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBar">ProgressBar</a></code> in activity mode, which shows activity by a
block moving back and forth within the progress area. In this mode, the
application is required to call <code><a href="Graphics-UI-Gtk-Display-ProgressBar.html#v:progressBarPulse">progressBarPulse</a></code> perodically to update the
progress bar.
</p><p>There is quite a bit of flexibility provided to control the appearance of
the <code><a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBar">ProgressBar</a></code>. Functions are provided to control the orientation of the
bar, optional text can be displayed along with the bar, and the step size
used in activity mode can be set.
</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-Abstract-Widget.html#t:Widget">Widget</a></code>
| +----ProgressBar
</pre></div><h1 id="g:3">Types
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ProgressBar" class="def">ProgressBar</a> <a href="src/Graphics-UI-Gtk-Types.html#ProgressBar" class="link">Source</a></p><div class="subs instances"><p id="control.i:ProgressBar" class="caption collapser" onclick="toggleSection('i:ProgressBar')">Instances</p><div id="section.i:ProgressBar" 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-ProgressBar.html#t:ProgressBar">ProgressBar</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-ProgressBar.html#t:ProgressBar">ProgressBar</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-ProgressBar.html#t:ProgressBar">ProgressBar</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBar">ProgressBar</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-ProgressBar.html#t:ProgressBar">ProgressBar</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-ProgressBar.html#t:ProgressBar">ProgressBar</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-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> o => <a name="t:ProgressBarClass" class="def">ProgressBarClass</a> o <a href="src/Graphics-UI-Gtk-Types.html#ProgressBarClass" class="link">Source</a></p><div class="subs instances"><p id="control.i:ProgressBarClass" class="caption collapser" onclick="toggleSection('i:ProgressBarClass')">Instances</p><div id="section.i:ProgressBarClass" class="show"><table><tr><td class="src"><a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBar">ProgressBar</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:castToProgressBar" class="def">castToProgressBar</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-Display-ProgressBar.html#t:ProgressBar">ProgressBar</a><a href="src/Graphics-UI-Gtk-Types.html#castToProgressBar" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:gTypeProgressBar" class="def">gTypeProgressBar</a> :: <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:GType">GType</a><a href="src/Graphics-UI-Gtk-Types.html#gTypeProgressBar" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:toProgressBar" class="def">toProgressBar</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> o => o -> <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBar">ProgressBar</a><a href="src/Graphics-UI-Gtk-Types.html#toProgressBar" class="link">Source</a></p></div><h1 id="g:4">Constructors
</h1><div class="top"><p class="src"><a name="v:progressBarNew" class="def">progressBarNew</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-ProgressBar.html#t:ProgressBar">ProgressBar</a><a href="src/Graphics-UI-Gtk-Display-ProgressBar.html#progressBarNew" class="link">Source</a></p><div class="doc"><p>Creates a new <code><a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBar">ProgressBar</a></code>.
</p></div></div><h1 id="g:5">Methods
</h1><div class="top"><p class="src"><a name="v:progressBarPulse" class="def">progressBarPulse</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> self => self -> <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-ProgressBar.html#progressBarPulse" class="link">Source</a></p><div class="doc"><p>Indicates that some progress is made, but you don't know how much. Causes
the progress bar to enter "activity mode", where a block bounces back and
forth. Each call to <code><a href="Graphics-UI-Gtk-Display-ProgressBar.html#v:progressBarPulse">progressBarPulse</a></code> causes the block to move by a little
bit (the amount of movement per pulse is determined by
<code><a href="Graphics-UI-Gtk-Display-ProgressBar.html#v:progressBarSetPulseStep">progressBarSetPulseStep</a></code>).
</p></div></div><div class="top"><p class="src"><a name="v:progressBarSetText" class="def">progressBarSetText</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <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-ProgressBar.html#progressBarSetText" class="link">Source</a></p><div class="doc"><p>Causes the given <code>text</code> to appear superimposed on the progress bar.
</p></div></div><div class="top"><p class="src"><a name="v:progressBarSetFraction" class="def">progressBarSetFraction</a><a href="src/Graphics-UI-Gtk-Display-ProgressBar.html#progressBarSetFraction" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Double">Double</a></td><td class="doc"><p><code>fraction</code> - fraction of the task that's been completed
</p></td></tr><tr><td class="src">-> <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></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Causes the progress bar to "fill in" the given fraction of the bar. The
fraction should be between 0.0 and 1.0, inclusive.
</p></div></div><div class="top"><p class="src"><a name="v:progressBarSetPulseStep" class="def">progressBarSetPulseStep</a><a href="src/Graphics-UI-Gtk-Display-ProgressBar.html#progressBarSetPulseStep" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Double">Double</a></td><td class="doc"><p><code>fraction</code> - fraction between 0.0 and 1.0
</p></td></tr><tr><td class="src">-> <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></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Sets the fraction of total progress bar length to move the bouncing block
for each call to <code><a href="Graphics-UI-Gtk-Display-ProgressBar.html#v:progressBarPulse">progressBarPulse</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:progressBarGetFraction" class="def">progressBarGetFraction</a><a href="src/Graphics-UI-Gtk-Display-ProgressBar.html#progressBarGetFraction" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <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/base-4.3.1.0/Prelude.html#t:Double">Double</a></td><td class="doc"><p>returns a fraction from 0.0 to 1.0
</p></td></tr></table></div><div class="doc"><p>Returns the current fraction of the task that's been completed.
</p></div></div><div class="top"><p class="src"><a name="v:progressBarGetPulseStep" class="def">progressBarGetPulseStep</a><a href="src/Graphics-UI-Gtk-Display-ProgressBar.html#progressBarGetPulseStep" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <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/base-4.3.1.0/Prelude.html#t:Double">Double</a></td><td class="doc"><p>returns a fraction from 0.0 to 1.0
</p></td></tr></table></div><div class="doc"><p>Retrieves the pulse step set with <code><a href="Graphics-UI-Gtk-Display-ProgressBar.html#v:progressBarSetPulseStep">progressBarSetPulseStep</a></code>
</p></div></div><div class="top"><p class="src"><a name="v:progressBarGetText" class="def">progressBarGetText</a><a href="src/Graphics-UI-Gtk-Display-ProgressBar.html#progressBarGetText" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> self</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> <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/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>)</td><td class="doc"><p>returns text, or <code>Nothing</code>
</p></td></tr></table></div><div class="doc"><p>Retrieves the text displayed superimposed on the progress bar, if any,
otherwise <code>Nothing</code>.
</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:ProgressBarOrientation" class="def">ProgressBarOrientation</a> <a href="src/Graphics-UI-Gtk-General-Enums.html#ProgressBarOrientation" class="link">Source</a></p><div class="doc"><p>Is the ProgressBar horizontally or vertically
directed?
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:ProgressLeftToRight" class="def">ProgressLeftToRight</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ProgressRightToLeft" class="def">ProgressRightToLeft</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ProgressBottomToTop" class="def">ProgressBottomToTop</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:ProgressTopToBottom" class="def">ProgressTopToBottom</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:ProgressBarOrientation" class="caption collapser" onclick="toggleSection('i:ProgressBarOrientation')">Instances</p><div id="section.i:ProgressBarOrientation" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Prelude.html#t:Enum">Enum</a> <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarOrientation">ProgressBarOrientation</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-Eq.html#t:Eq">Eq</a> <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarOrientation">ProgressBarOrientation</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/Text-Show.html#t:Show">Show</a> <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarOrientation">ProgressBarOrientation</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:progressBarSetOrientation" class="def">progressBarSetOrientation</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> self => self -> <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarOrientation">ProgressBarOrientation</a> -> <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-ProgressBar.html#progressBarSetOrientation" class="link">Source</a></p><div class="doc"><p>Causes the progress bar to switch to a different orientation
(left-to-right, right-to-left, top-to-bottom, or bottom-to-top).
</p></div></div><div class="top"><p class="src"><a name="v:progressBarGetOrientation" class="def">progressBarGetOrientation</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> self => self -> <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-ProgressBar.html#t:ProgressBarOrientation">ProgressBarOrientation</a><a href="src/Graphics-UI-Gtk-Display-ProgressBar.html#progressBarGetOrientation" class="link">Source</a></p><div class="doc"><p>Retrieves the current progress bar orientation.
</p></div></div><div class="top"><p class="src"><a name="v:progressBarSetEllipsize" class="def">progressBarSetEllipsize</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/pango-0.12.0/Graphics-Rendering-Pango-Enums.html#t:EllipsizeMode">EllipsizeMode</a> -> <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-ProgressBar.html#progressBarSetEllipsize" class="link">Source</a></p><div class="doc"><p>Sets the mode used to ellipsize (add an ellipsis: "...") the text if
there is not enough space to render the entire string.
</p><ul><li> Available since Gtk+ version 2.6
</li></ul></div></div><div class="top"><p class="src"><a name="v:progressBarGetEllipsize" class="def">progressBarGetEllipsize</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> self => self -> <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/pango-0.12.0/Graphics-Rendering-Pango-Enums.html#t:EllipsizeMode">EllipsizeMode</a><a href="src/Graphics-UI-Gtk-Display-ProgressBar.html#progressBarGetEllipsize" class="link">Source</a></p><div class="doc"><p>Returns the ellipsizing position of the progressbar. See
<code><a href="Graphics-UI-Gtk-Display-ProgressBar.html#v:progressBarSetEllipsize">progressBarSetEllipsize</a></code>.
</p><ul><li> Available since Gtk+ version 2.6
</li></ul></div></div><h1 id="g:6">Attributes
</h1><div class="top"><p class="src"><a name="v:progressBarOrientation" class="def">progressBarOrientation</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</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-Display-ProgressBar.html#t:ProgressBarOrientation">ProgressBarOrientation</a><a href="src/Graphics-UI-Gtk-Display-ProgressBar.html#progressBarOrientation" class="link">Source</a></p><div class="doc"><p>Orientation and growth direction of the progress bar.
</p><p>Default value: <code><a href="Graphics-UI-Gtk-Display-ProgressBar.html#v:ProgressLeftToRight">ProgressLeftToRight</a></code>
</p></div></div><div class="top"><p class="src"><a name="v:progressBarDiscreteBlocks" class="def">progressBarDiscreteBlocks</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</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-Display-ProgressBar.html#progressBarDiscreteBlocks" class="link">Source</a></p><div class="doc"><p>The number of discrete blocks in a progress bar (when shown in the
discrete style).
</p><p>Allowed values: >= 2
</p><p>Default value: 10
</p></div></div><div class="top"><p class="src"><a name="v:progressBarFraction" class="def">progressBarFraction</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</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/Prelude.html#t:Double">Double</a><a href="src/Graphics-UI-Gtk-Display-ProgressBar.html#progressBarFraction" class="link">Source</a></p><div class="doc"><p>The fraction of total work that has been completed.
</p><p>Allowed values: [0,1]
</p><p>Default value: 0
</p></div></div><div class="top"><p class="src"><a name="v:progressBarPulseStep" class="def">progressBarPulseStep</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</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/Prelude.html#t:Double">Double</a><a href="src/Graphics-UI-Gtk-Display-ProgressBar.html#progressBarPulseStep" class="link">Source</a></p><div class="doc"><p>The fraction of total progress to move the bouncing block when pulsed.
</p><p>Allowed values: [0,1]
</p><p>Default value: 0.1
</p></div></div><div class="top"><p class="src"><a name="v:progressBarText" class="def">progressBarText</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</a> self => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:ReadWriteAttr">ReadWriteAttr</a> self (<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>) <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a><a href="src/Graphics-UI-Gtk-Display-ProgressBar.html#progressBarText" class="link">Source</a></p><div class="doc"><p>Text to be displayed in the progress bar.
</p><p>Default value: "%P %%"
</p></div></div><div class="top"><p class="src"><a name="v:progressBarEllipsize" class="def">progressBarEllipsize</a> :: <a href="Graphics-UI-Gtk-Display-ProgressBar.html#t:ProgressBarClass">ProgressBarClass</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/pango-0.12.0/Graphics-Rendering-Pango-Enums.html#t:EllipsizeMode">EllipsizeMode</a><a href="src/Graphics-UI-Gtk-Display-ProgressBar.html#progressBarEllipsize" class="link">Source</a></p><div class="doc"><p>The preferred place to ellipsize the string, if the progressbar does not
have enough room to display the entire string, specified as a
<code><a href="/usr/share/doc/ghc/html/libraries/pango-0.12.0/Graphics-Rendering-Pango-Enums.html#t:EllipsizeMode">EllipsizeMode</a></code>.
</p><p>Note that setting this property to a value other than <code><a href="/usr/share/doc/ghc/html/libraries/pango-0.12.0/Graphics-Rendering-Pango-Enums.html#v:EllipsizeNone">EllipsizeNone</a></code> has
the side-effect that the progressbar requests only enough space to display
the ellipsis "...". Another means to set a progressbar's width is
<code>Graphics.UI.Gtk.Abstract.Widget.widgetSetSizeRequest</code>.
</p><p>Default value: <code><a href="/usr/share/doc/ghc/html/libraries/pango-0.12.0/Graphics-Rendering-Pango-Enums.html#v:EllipsizeNone">EllipsizeNone</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>
