<!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.Tooltip</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-Tooltip.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Graphics-UI-Gtk-Misc-Tooltip.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.Tooltip</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">Methods
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Add tips to your widgets
</p><ul><li> Module available since Gtk+ version 2.12
</li></ul></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:Tooltip">Tooltip</a> </li><li class="src short"><span class="keyword">class</span> <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> o => <a href="#t:TooltipClass">TooltipClass</a> o </li><li class="src short"><a href="#v:castToTooltip">castToTooltip</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-Tooltip.html#t:Tooltip">Tooltip</a></li><li class="src short"><a href="#v:toTooltip">toTooltip</a> :: <a href="Graphics-UI-Gtk-Misc-Tooltip.html#t:TooltipClass">TooltipClass</a> o => o -> <a href="Graphics-UI-Gtk-Misc-Tooltip.html#t:Tooltip">Tooltip</a></li><li class="src short"><a href="#v:tooltipSetMarkup">tooltipSetMarkup</a> :: <a href="Graphics-UI-Gtk-Misc-Tooltip.html#t:TooltipClass">TooltipClass</a> self => 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/pango-0.12.0/Graphics-Rendering-Pango-Enums.html#t:Markup">Markup</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:tooltipSetText">tooltipSetText</a> :: <a href="Graphics-UI-Gtk-Misc-Tooltip.html#t:TooltipClass">TooltipClass</a> self => 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/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:tooltipSetIcon">tooltipSetIcon</a> :: <a href="Graphics-UI-Gtk-Misc-Tooltip.html#t:TooltipClass">TooltipClass</a> self => self -> <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-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</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:tooltipSetIconFromStock">tooltipSetIconFromStock</a> :: <a href="Graphics-UI-Gtk-Misc-Tooltip.html#t:TooltipClass">TooltipClass</a> self => 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="Graphics-UI-Gtk-MenuComboToolbar-ToolItem.html#t:IconSize">IconSize</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:tooltipSetIconFromIconName">tooltipSetIconFromIconName</a> :: <a href="Graphics-UI-Gtk-Misc-Tooltip.html#t:TooltipClass">TooltipClass</a> self => 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="Graphics-UI-Gtk-MenuComboToolbar-ToolItem.html#t:IconSize">IconSize</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:tooltipSetCustom">tooltipSetCustom</a> :: (<a href="Graphics-UI-Gtk-Misc-Tooltip.html#t:TooltipClass">TooltipClass</a> self, <a href="Graphics-UI-Gtk-Abstract-Widget.html#t:WidgetClass">WidgetClass</a> widget) => self -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> widget -> <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:tooltipTriggerTooltipQuery">tooltipTriggerTooltipQuery</a> :: <a href="Graphics-UI-Gtk-Gdk-Display.html#t:Display">Display</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:tooltipSetTipArea">tooltipSetTipArea</a> :: <a href="Graphics-UI-Gtk-Misc-Tooltip.html#t:TooltipClass">TooltipClass</a> self => self -> <a href="Graphics-UI-Gtk-Gdk-Events.html#t:Rectangle">Rectangle</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:tooltipSetIconFromGIcon">tooltipSetIconFromGIcon</a> :: <a href="Graphics-UI-Gtk-Misc-Tooltip.html#t:TooltipClass">TooltipClass</a> self => 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/gio-0.12.0/System-GIO-Icons-Icon.html#t:Icon">Icon</a> -> <a href="Graphics-UI-Gtk-MenuComboToolbar-ToolItem.html#t:IconSize">IconSize</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></ul></div><div id="interface"><h1 id="g:1">Detail
</h1><div class="doc"><p><code><a href="Graphics-UI-Gtk-Misc-Tooltip.html#t:Tooltip">Tooltip</a></code> belongs to the new tooltips API that was introduced in Gtk+
2.12 and which deprecates the old <code><a href="Graphics-UI-Gtk-Misc-Tooltips.html#t:Tooltips">Tooltips</a></code> API.
</p><p>Basic tooltips can be realized simply by using <code>widgetSetTooltipText</code> or
<code>widgetSetTooltipMarkup</code> without any explicit tooltip object.
</p><p>When you need a tooltip with a little more fancy contents, like adding an
image, or you want the tooltip to have different contents per <code><a href="Graphics-UI-Gtk-ModelView-TreeView.html#t:TreeView">TreeView</a></code> row
or cell, you will have to do a little more work:
</p><ul><li> Set the <code>hasTooltip</code> property to <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#v:True">True</a></code>, this will make GTK+ monitor the widget for motion and
related events which are needed to determine when and where to show a tooltip.
</li><li> Connect to the <code>queryTooltip</code> signal. This signal will be emitted when a tooltip is supposed to
be shown. One of the arguments passed to the signal handler is a <code><a href="Graphics-UI-Gtk-Misc-Tooltip.html#t:Tooltip">Tooltip</a></code> object. This is the
object that we are about to display as a tooltip, and can be manipulated in your callback using
functions like <code><a href="Graphics-UI-Gtk-Misc-Tooltip.html#v:tooltipSetIcon">tooltipSetIcon</a></code>. There are functions for setting the tooltip's markup,
setting an image from a stock icon, or even putting in a custom widget.
</li><li> Return <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#v:True">True</a></code> from your query-tooltip handler. This causes the tooltip to be show. If you return
<code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#v:False">False</a></code>, it will not be shown.
</li></ul><p>In the probably rare case where you want to have even more control over the tooltip that is about to
be shown, you can set your own <code><a href="Graphics-UI-Gtk-Windows-Window.html#t:Window">Window</a></code> which will be used as tooltip window. This works as
follows:
</p><ul><li> Set <code>hasTooltip</code> and connect to <code>queryTooltip</code> as before.
</li><li> Use <code>widgetSetTooltipWindow</code> to set a <code><a href="Graphics-UI-Gtk-Windows-Window.html#t:Window">Window</a></code> created by you as tooltip window.
</li><li> In the <code>queryTooltip</code> callback you can access your window using <code>widgetGetTooltipWindow</code>
and manipulate as you wish. The semantics of the return value are exactly as before, return <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#v:True">True</a></code>
to show the window, <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Bool.html#v:False">False</a></code> to not show it.
</li></ul></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>
| +----Tooltip
</pre></div><h1 id="g:3">Types
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Tooltip" class="def">Tooltip</a> <a href="src/Graphics-UI-Gtk-Types.html#Tooltip" class="link">Source</a></p><div class="subs instances"><p id="control.i:Tooltip" class="caption collapser" onclick="toggleSection('i:Tooltip')">Instances</p><div id="section.i:Tooltip" 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-Tooltip.html#t:Tooltip">Tooltip</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-Tooltip.html#t:Tooltip">Tooltip</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-Tooltip.html#t:Tooltip">Tooltip</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Misc-Tooltip.html#t:TooltipClass">TooltipClass</a> <a href="Graphics-UI-Gtk-Misc-Tooltip.html#t:Tooltip">Tooltip</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="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> o => <a name="t:TooltipClass" class="def">TooltipClass</a> o <a href="src/Graphics-UI-Gtk-Types.html#TooltipClass" class="link">Source</a></p><div class="subs instances"><p id="control.i:TooltipClass" class="caption collapser" onclick="toggleSection('i:TooltipClass')">Instances</p><div id="section.i:TooltipClass" class="show"><table><tr><td class="src"><a href="Graphics-UI-Gtk-Misc-Tooltip.html#t:TooltipClass">TooltipClass</a> <a href="Graphics-UI-Gtk-Display-StatusIcon.html#t:StatusIcon">StatusIcon</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-Misc-Tooltip.html#t:TooltipClass">TooltipClass</a> <a href="Graphics-UI-Gtk-Misc-Tooltip.html#t:Tooltip">Tooltip</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:castToTooltip" class="def">castToTooltip</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-Tooltip.html#t:Tooltip">Tooltip</a><a href="src/Graphics-UI-Gtk-Types.html#castToTooltip" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:toTooltip" class="def">toTooltip</a> :: <a href="Graphics-UI-Gtk-Misc-Tooltip.html#t:TooltipClass">TooltipClass</a> o => o -> <a href="Graphics-UI-Gtk-Misc-Tooltip.html#t:Tooltip">Tooltip</a><a href="src/Graphics-UI-Gtk-Types.html#toTooltip" class="link">Source</a></p></div><h1 id="g:4">Methods
</h1><div class="top"><p class="src"><a name="v:tooltipSetMarkup" class="def">tooltipSetMarkup</a><a href="src/Graphics-UI-Gtk-Misc-Tooltip.html#tooltipSetMarkup" 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-Tooltip.html#t:TooltipClass">TooltipClass</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-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/pango-0.12.0/Graphics-Rendering-Pango-Enums.html#t:Markup">Markup</a></td><td class="doc"><p><code>markup</code> - a markup string (see Pango markup format) or <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code>
</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 text of the tooltip to be <code>markup</code>, which is marked up with the
Pango text markup language. If <code>markup</code> is <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code>, the label will be hidden.
</p></div></div><div class="top"><p class="src"><a name="v:tooltipSetText" class="def">tooltipSetText</a><a href="src/Graphics-UI-Gtk-Misc-Tooltip.html#tooltipSetText" 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-Tooltip.html#t:TooltipClass">TooltipClass</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-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><code>text</code> - a text string or <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code>
</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 text of the tooltip to be <code>text</code>. If <code>text</code> is <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code>
the label will be hidden. See also <code><a href="Graphics-UI-Gtk-Misc-Tooltip.html#v:tooltipSetMarkup">tooltipSetMarkup</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:tooltipSetIcon" class="def">tooltipSetIcon</a><a href="src/Graphics-UI-Gtk-Misc-Tooltip.html#tooltipSetIcon" 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-Tooltip.html#t:TooltipClass">TooltipClass</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-Maybe.html#t:Maybe">Maybe</a> <a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a></td><td class="doc"><p><code>pixbuf</code> - a <code><a href="Graphics-UI-Gtk-Gdk-Pixbuf.html#t:Pixbuf">Pixbuf</a></code> or <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code>
</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 icon of the tooltip (which is in front of the text) to be
<code>pixbuf</code>. If <code>pixbuf</code> is <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code> the image will be hidden.
</p></div></div><div class="top"><p class="src"><a name="v:tooltipSetIconFromStock" class="def">tooltipSetIconFromStock</a><a href="src/Graphics-UI-Gtk-Misc-Tooltip.html#tooltipSetIconFromStock" 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-Tooltip.html#t:TooltipClass">TooltipClass</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-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><code>id</code> a stock id, or <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code>
</p></td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-MenuComboToolbar-ToolItem.html#t:IconSize">IconSize</a></td><td class="doc"><p><code>size</code> a stock icon size
</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 icon of the tooltip (which is in front of the text) to be the
stock item indicated by <code>stockId</code> with the size indicated by <code>size</code>. If
<code>stockId</code> is <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code> the image will be hidden.
</p></div></div><div class="top"><p class="src"><a name="v:tooltipSetIconFromIconName" class="def">tooltipSetIconFromIconName</a><a href="src/Graphics-UI-Gtk-Misc-Tooltip.html#tooltipSetIconFromIconName" 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-Tooltip.html#t:TooltipClass">TooltipClass</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-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><code>iconName</code> an icon name, or <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code>
</p></td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-MenuComboToolbar-ToolItem.html#t:IconSize">IconSize</a></td><td class="doc"><p><code>size</code> a stock icon size
</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 icon of the tooltip (which is in front of the text) to be the
icon indicated by <code>iconName</code> with the size indicated by <code>size</code>. If
<code>iconName</code> is <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code> the image will be hidden.
</p><ul><li> Available since Gtk+ version 2.14
</li></ul></div></div><div class="top"><p class="src"><a name="v:tooltipSetCustom" class="def">tooltipSetCustom</a><a href="src/Graphics-UI-Gtk-Misc-Tooltip.html#tooltipSetCustom" 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-Tooltip.html#t:TooltipClass">TooltipClass</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">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#t:Maybe">Maybe</a> widget</td><td class="doc"><p><code>customWidget</code> a <code><a href="Graphics-UI-Gtk-Abstract-Widget.html#t:Widget">Widget</a></code>, or <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code> to unset the old custom widget.
</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>Replaces the widget packed into the tooltip with <code>customWidget</code>.
<code>customWidget</code> does not get destroyed when the tooltip goes away. By default
a box with a <code><a href="Graphics-UI-Gtk-Display-Image.html#t:Image">Image</a></code> and <code><a href="Graphics-UI-Gtk-Display-Label.html#t:Label">Label</a></code> is embedded in the tooltip, which can be
configured using <code><a href="Graphics-UI-Gtk-Misc-Tooltip.html#v:tooltipSetMarkup">tooltipSetMarkup</a></code> and <code><a href="Graphics-UI-Gtk-Misc-Tooltip.html#v:tooltipSetIcon">tooltipSetIcon</a></code>.
</p></div></div><div class="top"><p class="src"><a name="v:tooltipTriggerTooltipQuery" class="def">tooltipTriggerTooltipQuery</a><a href="src/Graphics-UI-Gtk-Misc-Tooltip.html#tooltipTriggerTooltipQuery" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-Gdk-Display.html#t:Display">Display</a></td><td class="doc"><p><code>display</code> - a <code><a href="Graphics-UI-Gtk-Gdk-Display.html#t:Display">Display</a></code>
</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>Triggers a new tooltip query on <code>display</code>, in order to update the current
visible tooltip, or to show/hide the current tooltip. This function is
useful to call when, for example, the state of the widget changed by a key
press.
</p></div></div><div class="top"><p class="src"><a name="v:tooltipSetTipArea" class="def">tooltipSetTipArea</a> :: <a href="Graphics-UI-Gtk-Misc-Tooltip.html#t:TooltipClass">TooltipClass</a> self => self -> <a href="Graphics-UI-Gtk-Gdk-Events.html#t:Rectangle">Rectangle</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-Misc-Tooltip.html#tooltipSetTipArea" class="link">Source</a></p><div class="doc"><p>Sets the area of the widget, where the contents of this tooltip apply, to
be <code>rect</code> (in widget coordinates). This is especially useful for properly
setting tooltips on <code><a href="Graphics-UI-Gtk-ModelView-TreeView.html#t:TreeView">TreeView</a></code> rows and cells, <code><a href="Graphics-UI-Gtk-ModelView-IconView.html#t:IconView">IconView</a></code>
</p><p>For setting tooltips on <code><a href="Graphics-UI-Gtk-ModelView-TreeView.html#t:TreeView">TreeView</a></code>, please refer to the convenience
functions for this: <code>treeViewSetTooltipRow</code> and <code>treeViewSetTooltipCell</code>.
</p></div></div><div class="top"><p class="src"><a name="v:tooltipSetIconFromGIcon" class="def">tooltipSetIconFromGIcon</a><a href="src/Graphics-UI-Gtk-Misc-Tooltip.html#tooltipSetIconFromGIcon" 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-Tooltip.html#t:TooltipClass">TooltipClass</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-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc/html/libraries/gio-0.12.0/System-GIO-Icons-Icon.html#t:Icon">Icon</a></td><td class="doc"><p><code>gicon</code> a GIcon representing the icon, or <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code>. allow-none.
</p></td></tr><tr><td class="src">-> <a href="Graphics-UI-Gtk-MenuComboToolbar-ToolItem.html#t:IconSize">IconSize</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/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 icon of the tooltip (which is in front of the text) to be the icon indicated by gicon with
the size indicated by size. If gicon is <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code>, the image will be hidden.
</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>
