<!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.Special.Ruler</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-Special-Ruler.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Graphics-UI-Gtk-Special-Ruler.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.Special.Ruler</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">Enums
</a></li><li><a href="#g:5">Attributes
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Base class for horizontal or vertical rulers
</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:Ruler">Ruler</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:RulerClass">RulerClass</a> o </li><li class="src short"><a href="#v:castToRuler">castToRuler</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-Special-Ruler.html#t:Ruler">Ruler</a></li><li class="src short"><a href="#v:toRuler">toRuler</a> :: <a href="Graphics-UI-Gtk-Special-Ruler.html#t:RulerClass">RulerClass</a> o => o -> <a href="Graphics-UI-Gtk-Special-Ruler.html#t:Ruler">Ruler</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:MetricType">MetricType</a> <ul class="subs"><li>= <a href="#v:Pixels">Pixels</a> </li><li>| <a href="#v:Inches">Inches</a> </li><li>| <a href="#v:Centimeters">Centimeters</a> </li></ul></li><li class="src short"><a href="#v:rulerRange">rulerRange</a> :: <a href="Graphics-UI-Gtk-Special-Ruler.html#t:RulerClass">RulerClass</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="/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/Prelude.html#t:Double">Double</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:rulerLower">rulerLower</a> :: <a href="Graphics-UI-Gtk-Special-Ruler.html#t:RulerClass">RulerClass</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:rulerUpper">rulerUpper</a> :: <a href="Graphics-UI-Gtk-Special-Ruler.html#t:RulerClass">RulerClass</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:rulerPosition">rulerPosition</a> :: <a href="Graphics-UI-Gtk-Special-Ruler.html#t:RulerClass">RulerClass</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:rulerMaxSize">rulerMaxSize</a> :: <a href="Graphics-UI-Gtk-Special-Ruler.html#t:RulerClass">RulerClass</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:rulerMetric">rulerMetric</a> :: <a href="Graphics-UI-Gtk-Special-Ruler.html#t:RulerClass">RulerClass</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-Special-Ruler.html#t:MetricType">MetricType</a></li></ul></div><div id="interface"><h1 id="g:1">Detail
</h1><div class="doc"><p>The <code><a href="Graphics-UI-Gtk-Special-Ruler.html#t:Ruler">Ruler</a></code> widget is a base class for horizontal and vertical rulers.
Rulers are used to show the mouse pointer's location in a window. The ruler
can either be horizontal or vertical on the window. Within the ruler a small
triangle indicates the location of the mouse relative to the horizontal or
vertical ruler. See <code><a href="Graphics-UI-Gtk-Special-HRuler.html#t:HRuler">HRuler</a></code> to learn how to create a new horizontal ruler.
See <code><a href="Graphics-UI-Gtk-Special-VRuler.html#t:VRuler">VRuler</a></code> to learn how to create a new vertical ruler.
</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>
| +----Ruler
| +----<code><a href="Graphics-UI-Gtk-Special-HRuler.html#t:HRuler">HRuler</a></code>
| +----<code><a href="Graphics-UI-Gtk-Special-VRuler.html#t:VRuler">VRuler</a></code>
</pre></div><h1 id="g:3">Types
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Ruler" class="def">Ruler</a> <a href="src/Graphics-UI-Gtk-Types.html#Ruler" class="link">Source</a></p><div class="subs instances"><p id="control.i:Ruler" class="caption collapser" onclick="toggleSection('i:Ruler')">Instances</p><div id="section.i:Ruler" 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-Special-Ruler.html#t:Ruler">Ruler</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-Special-Ruler.html#t:Ruler">Ruler</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-Special-Ruler.html#t:Ruler">Ruler</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Special-Ruler.html#t:RulerClass">RulerClass</a> <a href="Graphics-UI-Gtk-Special-Ruler.html#t:Ruler">Ruler</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-Special-Ruler.html#t:Ruler">Ruler</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-Special-Ruler.html#t:Ruler">Ruler</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:RulerClass" class="def">RulerClass</a> o <a href="src/Graphics-UI-Gtk-Types.html#RulerClass" class="link">Source</a></p><div class="subs instances"><p id="control.i:RulerClass" class="caption collapser" onclick="toggleSection('i:RulerClass')">Instances</p><div id="section.i:RulerClass" class="show"><table><tr><td class="src"><a href="Graphics-UI-Gtk-Special-Ruler.html#t:RulerClass">RulerClass</a> <a href="Graphics-UI-Gtk-Special-VRuler.html#t:VRuler">VRuler</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Special-Ruler.html#t:RulerClass">RulerClass</a> <a href="Graphics-UI-Gtk-Special-HRuler.html#t:HRuler">HRuler</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Special-Ruler.html#t:RulerClass">RulerClass</a> <a href="Graphics-UI-Gtk-Special-Ruler.html#t:Ruler">Ruler</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:castToRuler" class="def">castToRuler</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-Special-Ruler.html#t:Ruler">Ruler</a><a href="src/Graphics-UI-Gtk-Types.html#castToRuler" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:toRuler" class="def">toRuler</a> :: <a href="Graphics-UI-Gtk-Special-Ruler.html#t:RulerClass">RulerClass</a> o => o -> <a href="Graphics-UI-Gtk-Special-Ruler.html#t:Ruler">Ruler</a><a href="src/Graphics-UI-Gtk-Types.html#toRuler" class="link">Source</a></p></div><h1 id="g:4">Enums
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:MetricType" class="def">MetricType</a> <a href="src/Graphics-UI-Gtk-General-Enums.html#MetricType" class="link">Source</a></p><div class="doc"><p>Units of measure
</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a name="v:Pixels" class="def">Pixels</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Inches" class="def">Inches</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a name="v:Centimeters" class="def">Centimeters</a></td><td class="doc empty"> </td></tr></table></div><div class="subs instances"><p id="control.i:MetricType" class="caption collapser" onclick="toggleSection('i:MetricType')">Instances</p><div id="section.i:MetricType" 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-Special-Ruler.html#t:MetricType">MetricType</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-Special-Ruler.html#t:MetricType">MetricType</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-Special-Ruler.html#t:MetricType">MetricType</a></td><td class="doc empty"> </td></tr></table></div></div></div><h1 id="g:5">Attributes
</h1><div class="top"><p class="src"><a name="v:rulerRange" class="def">rulerRange</a> :: <a href="Graphics-UI-Gtk-Special-Ruler.html#t:RulerClass">RulerClass</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="/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/Prelude.html#t:Double">Double</a>, <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-Special-Ruler.html#rulerRange" class="link">Source</a></p><div class="doc"><p>Range of ruler
</p></div></div><div class="top"><p class="src"><a name="v:rulerLower" class="def">rulerLower</a> :: <a href="Graphics-UI-Gtk-Special-Ruler.html#t:RulerClass">RulerClass</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-Special-Ruler.html#rulerLower" class="link">Source</a></p><div class="doc"><p>Lower limit of ruler.
</p><p>Default value: 0
</p></div></div><div class="top"><p class="src"><a name="v:rulerUpper" class="def">rulerUpper</a> :: <a href="Graphics-UI-Gtk-Special-Ruler.html#t:RulerClass">RulerClass</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-Special-Ruler.html#rulerUpper" class="link">Source</a></p><div class="doc"><p>Upper limit of ruler.
</p><p>Default value: 0
</p></div></div><div class="top"><p class="src"><a name="v:rulerPosition" class="def">rulerPosition</a> :: <a href="Graphics-UI-Gtk-Special-Ruler.html#t:RulerClass">RulerClass</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-Special-Ruler.html#rulerPosition" class="link">Source</a></p><div class="doc"><p>Position of mark on the ruler.
</p><p>Default value: 0
</p></div></div><div class="top"><p class="src"><a name="v:rulerMaxSize" class="def">rulerMaxSize</a> :: <a href="Graphics-UI-Gtk-Special-Ruler.html#t:RulerClass">RulerClass</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-Special-Ruler.html#rulerMaxSize" class="link">Source</a></p><div class="doc"><p>Maximum size of the ruler.
</p><p>Default value: 0
</p></div></div><div class="top"><p class="src"><a name="v:rulerMetric" class="def">rulerMetric</a> :: <a href="Graphics-UI-Gtk-Special-Ruler.html#t:RulerClass">RulerClass</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-Special-Ruler.html#t:MetricType">MetricType</a><a href="src/Graphics-UI-Gtk-Special-Ruler.html#rulerMetric" class="link">Source</a></p><div class="doc"><p>The metric used for the ruler.
</p><p>Default value: ''Pixels''
</p><p>Since 2.8
</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>
