<!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.Misc.Tooltips</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-Misc-Tooltips.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Graphics-UI-Gtk-Misc-Tooltips.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.Misc.Tooltips</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></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Add tips to your widgets
</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:Tooltips">Tooltips</a> </li><li class="src short"><span class="keyword">class</span> <a href="Graphics-UI-Gtk-Abstract-Object.html#t:ObjectClass">ObjectClass</a> o => <a href="#t:TooltipsClass">TooltipsClass</a> o </li><li class="src short"><a href="#v:castToTooltips">castToTooltips</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-Misc-Tooltips.html#t:Tooltips">Tooltips</a></li><li class="src short"><a href="#v:gTypeTooltips">gTypeTooltips</a> :: <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:GType">GType</a></li><li class="src short"><a href="#v:toTooltips">toTooltips</a> :: <a href="Graphics-UI-Gtk-Misc-Tooltips.html#t:TooltipsClass">TooltipsClass</a> o => o -> <a href="Graphics-UI-Gtk-Misc-Tooltips.html#t:Tooltips">Tooltips</a></li><li class="src short"><a href="#v:tooltipsNew">tooltipsNew</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-Misc-Tooltips.html#t:Tooltips">Tooltips</a></li><li class="src short"><a href="#v:tooltipsEnable">tooltipsEnable</a> :: <a href="Graphics-UI-Gtk-Misc-Tooltips.html#t:TooltipsClass">TooltipsClass</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:tooltipsDisable">tooltipsDisable</a> :: <a href="Graphics-UI-Gtk-Misc-Tooltips.html#t:TooltipsClass">TooltipsClass</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:tooltipsSetDelay">tooltipsSetDelay</a> :: <a href="Graphics-UI-Gtk-Misc-Tooltips.html#t:TooltipsClass">TooltipsClass</a> self => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Int.html#t:Int">Int</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:tooltipsSetTip">tooltipsSetTip</a> :: (<a href="Graphics-UI-Gtk-Misc-Tooltips.html#t:TooltipsClass">TooltipsClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> widget) => self -> widget -> <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="/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:tooltipsDataGet">tooltipsDataGet</a> :: <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> w => w -> <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="Graphics-UI-Gtk-Misc-Tooltips.html#t:Tooltips">Tooltips</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></ul></div><div id="interface"><h1 id="g:1">Detail
</h1><div class="doc"><p>Tooltips are the messages that appear next to a widget when the mouse
pointer is held over it for a short amount of time. They are especially
helpful for adding more verbose descriptions of things such as buttons in a
toolbar.
</p><p>An individual tooltip belongs to a group of tooltips. A group is created
with a call to <code><a href="Graphics-UI-Gtk-Misc-Tooltips.html#v:tooltipsNew">tooltipsNew</a></code>. Every tooltip in the group can then be turned
off with a call to <code><a href="Graphics-UI-Gtk-Misc-Tooltips.html#v:tooltipsDisable">tooltipsDisable</a></code> and enabled with <code><a href="Graphics-UI-Gtk-Misc-Tooltips.html#v:tooltipsEnable">tooltipsEnable</a></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>
| +----Tooltips
</pre></div><h1 id="g:3">Types
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Tooltips" class="def">Tooltips</a> <a href="src/Graphics-UI-Gtk-Types.html#Tooltips" class="link">Source</a></p><div class="subs instances"><p id="control.i:Tooltips" class="caption collapser" onclick="toggleSection('i:Tooltips')">Instances</p><div id="section.i:Tooltips" 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-Misc-Tooltips.html#t:Tooltips">Tooltips</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-Misc-Tooltips.html#t:Tooltips">Tooltips</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-Misc-Tooltips.html#t:Tooltips">Tooltips</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Misc-Tooltips.html#t:TooltipsClass">TooltipsClass</a> <a href="Graphics-UI-Gtk-Misc-Tooltips.html#t:Tooltips">Tooltips</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-Misc-Tooltips.html#t:Tooltips">Tooltips</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-Object.html#t:ObjectClass">ObjectClass</a> o => <a name="t:TooltipsClass" class="def">TooltipsClass</a> o <a href="src/Graphics-UI-Gtk-Types.html#TooltipsClass" class="link">Source</a></p><div class="subs instances"><p id="control.i:TooltipsClass" class="caption collapser" onclick="toggleSection('i:TooltipsClass')">Instances</p><div id="section.i:TooltipsClass" class="show"><table><tr><td class="src"><a href="Graphics-UI-Gtk-Misc-Tooltips.html#t:TooltipsClass">TooltipsClass</a> <a href="Graphics-UI-Gtk-Misc-Tooltips.html#t:Tooltips">Tooltips</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:castToTooltips" class="def">castToTooltips</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-Misc-Tooltips.html#t:Tooltips">Tooltips</a><a href="src/Graphics-UI-Gtk-Types.html#castToTooltips" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:gTypeTooltips" class="def">gTypeTooltips</a> :: <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:GType">GType</a><a href="src/Graphics-UI-Gtk-Types.html#gTypeTooltips" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:toTooltips" class="def">toTooltips</a> :: <a href="Graphics-UI-Gtk-Misc-Tooltips.html#t:TooltipsClass">TooltipsClass</a> o => o -> <a href="Graphics-UI-Gtk-Misc-Tooltips.html#t:Tooltips">Tooltips</a><a href="src/Graphics-UI-Gtk-Types.html#toTooltips" class="link">Source</a></p></div><h1 id="g:4">Constructors
</h1><div class="top"><p class="src"><a name="v:tooltipsNew" class="def">tooltipsNew</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-Misc-Tooltips.html#t:Tooltips">Tooltips</a><a href="src/Graphics-UI-Gtk-Misc-Tooltips.html#tooltipsNew" class="link">Source</a></p><div class="doc"><p>Create a new goup of <code><a href="Graphics-UI-Gtk-Misc-Tooltips.html#t:Tooltips">Tooltips</a></code>.
</p></div></div><h1 id="g:5">Methods
</h1><div class="top"><p class="src"><a name="v:tooltipsEnable" class="def">tooltipsEnable</a> :: <a href="Graphics-UI-Gtk-Misc-Tooltips.html#t:TooltipsClass">TooltipsClass</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-Misc-Tooltips.html#tooltipsEnable" class="link">Source</a></p><div class="doc"><p>Allows the user to see your tooltips as they navigate your application.
</p></div></div><div class="top"><p class="src"><a name="v:tooltipsDisable" class="def">tooltipsDisable</a> :: <a href="Graphics-UI-Gtk-Misc-Tooltips.html#t:TooltipsClass">TooltipsClass</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-Misc-Tooltips.html#tooltipsDisable" class="link">Source</a></p><div class="doc"><p>Causes all tooltips in <code>tooltips</code> to become inactive. Any widgets that
have tips associated with that group will no longer display their tips until
they are enabled again with <code><a href="Graphics-UI-Gtk-Misc-Tooltips.html#v:tooltipsEnable">tooltipsEnable</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:tooltipsSetDelay" class="def">tooltipsSetDelay</a><a href="src/Graphics-UI-Gtk-Misc-Tooltips.html#tooltipsSetDelay" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Misc-Tooltips.html#t:TooltipsClass">TooltipsClass</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/Data-Int.html#t:Int">Int</a></td><td class="doc"><p><code>delay</code> - the delay in milliseconds
</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 time between the user moving the mouse over a widget and the
widget's tooltip appearing.
</p><ul><li> Warning: this function is deprecated and should not be used in
newly-written code.
</li></ul></div></div><div class="top"><p class="src"><a name="v:tooltipsSetTip" class="def">tooltipsSetTip</a><a href="src/Graphics-UI-Gtk-Misc-Tooltips.html#tooltipsSetTip" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: (<a href="Graphics-UI-Gtk-Misc-Tooltips.html#t:TooltipsClass">TooltipsClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> widget)</td><td class="doc empty"> </td></tr><tr><td class="src">=> self</td><td class="doc empty"> </td></tr><tr><td class="src">-> widget</td><td class="doc"><p><code>widget</code> - the <code><a href="Graphics-UI-Gtk-Abstract-Widget.html#t:Widget">Widget</a></code> you wish to associate the tip with.
</p></td></tr><tr><td class="src">-> <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><code>tipText</code> - a string containing the tip itself.
</p></td></tr><tr><td class="src">-> <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><code>tipPrivate</code> - a string of any further information that may be
useful if the user gets stuck.
</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>Adds a tooltip containing the message <code>tipText</code> to the specified
<code><a href="Graphics-UI-Gtk-Abstract-Widget.html#t:Widget">Widget</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:tooltipsDataGet" class="def">tooltipsDataGet</a> :: <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> w => w -> <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="Graphics-UI-Gtk-Misc-Tooltips.html#t:Tooltips">Tooltips</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-Misc-Tooltips.html#tooltipsDataGet" class="link">Source</a></p><div class="doc"><p>Retrieves any <code><a href="Graphics-UI-Gtk-Misc-Tooltips.html#t:Tooltips">Tooltips</a></code> previously associated with the given widget.
</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>
