<?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/Misc/Tooltip.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/Misc/Tooltip.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 Tooltip</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: 24 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'>-- Add tips to your widgets</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.12</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'>Misc</span><span class='hs-varop'>.</span><span class='hs-conid'>Tooltip</span> <span class='hs-layout'>(</span>
<a name="line-32"></a>
<a name="line-33"></a><span class='hs-comment'>-- * Detail</span>
<a name="line-34"></a><span class='hs-comment'>--</span>
<a name="line-35"></a><span class='hs-comment'>-- | 'Tooltip' belongs to the new tooltips API that was introduced in Gtk+</span>
<a name="line-36"></a><span class='hs-comment'>-- 2.12 and which deprecates the old 'Tooltips' API.</span>
<a name="line-37"></a><span class='hs-comment'>--</span>
<a name="line-38"></a><span class='hs-comment'>-- Basic tooltips can be realized simply by using 'widgetSetTooltipText' or</span>
<a name="line-39"></a><span class='hs-comment'>-- 'widgetSetTooltipMarkup' without any explicit tooltip object.</span>
<a name="line-40"></a><span class='hs-comment'>--</span>
<a name="line-41"></a><span class='hs-comment'>-- When you need a tooltip with a little more fancy contents, like adding an</span>
<a name="line-42"></a><span class='hs-comment'>-- image, or you want the tooltip to have different contents per 'TreeView' row</span>
<a name="line-43"></a><span class='hs-comment'>-- or cell, you will have to do a little more work:</span>
<a name="line-44"></a><span class='hs-comment'>--</span>
<a name="line-45"></a><span class='hs-comment'>-- * Set the 'hasTooltip' property to 'True', this will make GTK+ monitor the widget for motion and</span>
<a name="line-46"></a><span class='hs-comment'>-- related events which are needed to determine when and where to show a tooltip.</span>
<a name="line-47"></a><span class='hs-comment'>--</span>
<a name="line-48"></a><span class='hs-comment'>-- * Connect to the 'queryTooltip' signal. This signal will be emitted when a tooltip is supposed to</span>
<a name="line-49"></a><span class='hs-comment'>-- be shown. One of the arguments passed to the signal handler is a 'Tooltip' object. This is the</span>
<a name="line-50"></a><span class='hs-comment'>-- object that we are about to display as a tooltip, and can be manipulated in your callback using</span>
<a name="line-51"></a><span class='hs-comment'>-- functions like 'tooltipSetIcon'. There are functions for setting the tooltip's markup,</span>
<a name="line-52"></a><span class='hs-comment'>-- setting an image from a stock icon, or even putting in a custom widget.</span>
<a name="line-53"></a><span class='hs-comment'>--</span>
<a name="line-54"></a><span class='hs-comment'>-- * Return 'True' from your query-tooltip handler. This causes the tooltip to be show. If you return</span>
<a name="line-55"></a><span class='hs-comment'>-- 'False', it will not be shown.</span>
<a name="line-56"></a><span class='hs-comment'>--</span>
<a name="line-57"></a><span class='hs-comment'>-- In the probably rare case where you want to have even more control over the tooltip that is about to</span>
<a name="line-58"></a><span class='hs-comment'>-- be shown, you can set your own 'Window' which will be used as tooltip window. This works as</span>
<a name="line-59"></a><span class='hs-comment'>-- follows:</span>
<a name="line-60"></a><span class='hs-comment'>--</span>
<a name="line-61"></a><span class='hs-comment'>-- * Set 'hasTooltip' and connect to 'queryTooltip' as before.</span>
<a name="line-62"></a><span class='hs-comment'>--</span>
<a name="line-63"></a><span class='hs-comment'>-- * Use 'widgetSetTooltipWindow' to set a 'Window' created by you as tooltip window.</span>
<a name="line-64"></a><span class='hs-comment'>--</span>
<a name="line-65"></a><span class='hs-comment'>-- * In the 'queryTooltip' callback you can access your window using 'widgetGetTooltipWindow'</span>
<a name="line-66"></a><span class='hs-comment'>-- and manipulate as you wish. The semantics of the return value are exactly as before, return 'True'</span>
<a name="line-67"></a><span class='hs-comment'>-- to show the window, 'False' to not show it.</span>
<a name="line-68"></a>
<a name="line-69"></a><span class='hs-comment'>-- * Class Hierarchy</span>
<a name="line-70"></a><span class='hs-comment'>--</span>
<a name="line-71"></a><span class='hs-comment'>-- |</span>
<a name="line-72"></a><span class='hs-comment'>-- @</span>
<a name="line-73"></a><span class='hs-comment'>-- | 'GObject'</span>
<a name="line-74"></a><span class='hs-comment'>-- | +----Tooltip</span>
<a name="line-75"></a><span class='hs-comment'>-- @</span>
<a name="line-76"></a>
<a name="line-77"></a>
<a name="line-78"></a><span class='hs-comment'>-- * Types</span>
<a name="line-79"></a> <span class='hs-conid'>Tooltip</span><span class='hs-layout'>,</span>
<a name="line-80"></a> <span class='hs-conid'>TooltipClass</span><span class='hs-layout'>,</span>
<a name="line-81"></a> <span class='hs-varid'>castToTooltip</span><span class='hs-layout'>,</span>
<a name="line-82"></a> <span class='hs-varid'>toTooltip</span><span class='hs-layout'>,</span>
<a name="line-83"></a>
<a name="line-84"></a><span class='hs-comment'>-- * Methods</span>
<a name="line-85"></a> <span class='hs-varid'>tooltipSetMarkup</span><span class='hs-layout'>,</span>
<a name="line-86"></a> <span class='hs-varid'>tooltipSetText</span><span class='hs-layout'>,</span>
<a name="line-87"></a> <span class='hs-varid'>tooltipSetIcon</span><span class='hs-layout'>,</span>
<a name="line-88"></a> <span class='hs-varid'>tooltipSetIconFromStock</span><span class='hs-layout'>,</span>
<a name="line-89"></a>
<a name="line-90"></a> <span class='hs-varid'>tooltipSetIconFromIconName</span><span class='hs-layout'>,</span>
<a name="line-91"></a>
<a name="line-92"></a> <span class='hs-varid'>tooltipSetCustom</span><span class='hs-layout'>,</span>
<a name="line-93"></a> <span class='hs-varid'>tooltipTriggerTooltipQuery</span><span class='hs-layout'>,</span>
<a name="line-94"></a> <span class='hs-varid'>tooltipSetTipArea</span><span class='hs-layout'>,</span>
<a name="line-95"></a>
<a name="line-96"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-97"></a>
<a name="line-98"></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-99"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Maybe</span> <span class='hs-layout'>(</span><span class='hs-varid'>fromMaybe</span><span class='hs-layout'>)</span>
<a name="line-100"></a>
<a name="line-101"></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-102"></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'>UTFString</span>
<a name="line-103"></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'>GObject</span> <span class='hs-layout'>(</span><span class='hs-varid'>constructNewGObject</span><span class='hs-layout'>,</span><span class='hs-varid'>makeNewGObject</span><span class='hs-layout'>)</span>
<a name="line-104"></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> <span class='hs-conid'>Rectangle</span><span class='hs-layout'>)</span>
<a name="line-105"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>Rendering</span><span class='hs-varop'>.</span><span class='hs-conid'>Pango</span><span class='hs-varop'>.</span><span class='hs-conid'>Markup</span>
<a name="line-106"></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-107"></a><span class='hs-comment'>{-# LINE 106 "./Graphics/UI/Gtk/Misc/Tooltip.chs" #-}</span>
<a name="line-108"></a>
<a name="line-109"></a>
<a name="line-110"></a><span class='hs-comment'>{-# LINE 108 "./Graphics/UI/Gtk/Misc/Tooltip.chs" #-}</span>
<a name="line-111"></a>
<a name="line-112"></a>
<a name="line-113"></a><span class='hs-comment'>--------------------</span>
<a name="line-114"></a><span class='hs-comment'>-- Methods</span>
<a name="line-115"></a>
<a name="line-116"></a><a name="tooltipSetMarkup"></a><span class='hs-comment'>-- | Sets the text of the tooltip to be @markup@, which is marked up with the</span>
<a name="line-117"></a><span class='hs-comment'>-- Pango text markup language. If @markup@ is 'Nothing', the label will be hidden.</span>
<a name="line-118"></a><span class='hs-comment'>--</span>
<a name="line-119"></a><span class='hs-definition'>tooltipSetMarkup</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TooltipClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span>
<a name="line-120"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>Markup</span> <span class='hs-comment'>-- ^ @markup@ - a markup string (see Pango markup format) or 'Nothing'</span>
<a name="line-121"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-122"></a><span class='hs-definition'>tooltipSetMarkup</span> <span class='hs-varid'>self</span> <span class='hs-varid'>markup</span> <span class='hs-keyglyph'>=</span>
<a name="line-123"></a> <span class='hs-varid'>maybeWith</span> <span class='hs-varid'>withUTFString</span> <span class='hs-varid'>markup</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>markupPtr</span> <span class='hs-keyglyph'>-></span>
<a name="line-124"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>Tooltip</span> <span class='hs-varid'>arg1</span><span class='hs-layout'>)</span> <span class='hs-varid'>arg2</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>arg1</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>argPtr1</span> <span class='hs-keyglyph'>-></span><span class='hs-varid'>gtk_tooltip_set_markup</span> <span class='hs-varid'>argPtr1</span> <span class='hs-varid'>arg2</span><span class='hs-layout'>)</span>
<a name="line-125"></a><span class='hs-comment'>{-# LINE 122 "./Graphics/UI/Gtk/Misc/Tooltip.chs" #-}</span>
<a name="line-126"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toTooltip</span> <span class='hs-varid'>self</span><span class='hs-layout'>)</span>
<a name="line-127"></a> <span class='hs-varid'>markupPtr</span>
<a name="line-128"></a>
<a name="line-129"></a><a name="tooltipSetText"></a><span class='hs-comment'>-- | Sets the text of the tooltip to be @text@. If @text@ is 'Nothing'</span>
<a name="line-130"></a><span class='hs-comment'>-- the label will be hidden. See also 'tooltipSetMarkup'.</span>
<a name="line-131"></a><span class='hs-comment'>--</span>
<a name="line-132"></a><span class='hs-definition'>tooltipSetText</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TooltipClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span>
<a name="line-133"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ @text@ - a text string or 'Nothing'</span>
<a name="line-134"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-135"></a><span class='hs-definition'>tooltipSetText</span> <span class='hs-varid'>self</span> <span class='hs-varid'>text</span> <span class='hs-keyglyph'>=</span>
<a name="line-136"></a> <span class='hs-varid'>maybeWith</span> <span class='hs-varid'>withUTFString</span> <span class='hs-varid'>text</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>textPtr</span> <span class='hs-keyglyph'>-></span>
<a name="line-137"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>Tooltip</span> <span class='hs-varid'>arg1</span><span class='hs-layout'>)</span> <span class='hs-varid'>arg2</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>arg1</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>argPtr1</span> <span class='hs-keyglyph'>-></span><span class='hs-varid'>gtk_tooltip_set_text</span> <span class='hs-varid'>argPtr1</span> <span class='hs-varid'>arg2</span><span class='hs-layout'>)</span>
<a name="line-138"></a><span class='hs-comment'>{-# LINE 134 "./Graphics/UI/Gtk/Misc/Tooltip.chs" #-}</span>
<a name="line-139"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toTooltip</span> <span class='hs-varid'>self</span><span class='hs-layout'>)</span>
<a name="line-140"></a> <span class='hs-varid'>textPtr</span>
<a name="line-141"></a>
<a name="line-142"></a><a name="tooltipSetIcon"></a><span class='hs-comment'>-- | Sets the icon of the tooltip (which is in front of the text) to be</span>
<a name="line-143"></a><span class='hs-comment'>-- @pixbuf@. If @pixbuf@ is 'Nothing' the image will be hidden.</span>
<a name="line-144"></a><span class='hs-comment'>--</span>
<a name="line-145"></a><span class='hs-definition'>tooltipSetIcon</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TooltipClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span>
<a name="line-146"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>Pixbuf</span> <span class='hs-comment'>-- ^ @pixbuf@ - a 'Pixbuf' or 'Nothing'</span>
<a name="line-147"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-148"></a><span class='hs-definition'>tooltipSetIcon</span> <span class='hs-varid'>self</span> <span class='hs-varid'>pixbuf</span> <span class='hs-keyglyph'>=</span>
<a name="line-149"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>Tooltip</span> <span class='hs-varid'>arg1</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>Pixbuf</span> <span class='hs-varid'>arg2</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>arg1</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>argPtr1</span> <span class='hs-keyglyph'>-></span><span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>arg2</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>argPtr2</span> <span class='hs-keyglyph'>-></span><span class='hs-varid'>gtk_tooltip_set_icon</span> <span class='hs-varid'>argPtr1</span> <span class='hs-varid'>argPtr2</span><span class='hs-layout'>)</span>
<a name="line-150"></a><span class='hs-comment'>{-# LINE 145 "./Graphics/UI/Gtk/Misc/Tooltip.chs" #-}</span>
<a name="line-151"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toTooltip</span> <span class='hs-varid'>self</span><span class='hs-layout'>)</span>
<a name="line-152"></a> <span class='hs-layout'>(</span><span class='hs-varid'>fromMaybe</span> <span class='hs-layout'>(</span><span class='hs-conid'>Pixbuf</span> <span class='hs-varid'>nullForeignPtr</span><span class='hs-layout'>)</span> <span class='hs-varid'>pixbuf</span><span class='hs-layout'>)</span>
<a name="line-153"></a>
<a name="line-154"></a><a name="tooltipSetIconFromStock"></a><span class='hs-comment'>-- | Sets the icon of the tooltip (which is in front of the text) to be the</span>
<a name="line-155"></a><span class='hs-comment'>-- stock item indicated by @stockId@ with the size indicated by @size@. If</span>
<a name="line-156"></a><span class='hs-comment'>-- @stockId@ is 'Nothing' the image will be hidden.</span>
<a name="line-157"></a><span class='hs-comment'>--</span>
<a name="line-158"></a><span class='hs-definition'>tooltipSetIconFromStock</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TooltipClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span>
<a name="line-159"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ @id@ a stock id, or 'Nothing'</span>
<a name="line-160"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IconSize</span> <span class='hs-comment'>-- ^ @size@ a stock icon size</span>
<a name="line-161"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-162"></a><span class='hs-definition'>tooltipSetIconFromStock</span> <span class='hs-varid'>self</span> <span class='hs-varid'>id</span> <span class='hs-varid'>size</span> <span class='hs-keyglyph'>=</span>
<a name="line-163"></a> <span class='hs-varid'>maybeWith</span> <span class='hs-varid'>withUTFString</span> <span class='hs-varid'>id</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span> <span class='hs-varid'>idPtr</span> <span class='hs-keyglyph'>-></span>
<a name="line-164"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>Tooltip</span> <span class='hs-varid'>arg1</span><span class='hs-layout'>)</span> <span class='hs-varid'>arg2</span> <span class='hs-varid'>arg3</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>arg1</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>argPtr1</span> <span class='hs-keyglyph'>-></span><span class='hs-varid'>gtk_tooltip_set_icon_from_stock</span> <span class='hs-varid'>argPtr1</span> <span class='hs-varid'>arg2</span> <span class='hs-varid'>arg3</span><span class='hs-layout'>)</span>
<a name="line-165"></a><span class='hs-comment'>{-# LINE 159 "./Graphics/UI/Gtk/Misc/Tooltip.chs" #-}</span>
<a name="line-166"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toTooltip</span> <span class='hs-varid'>self</span><span class='hs-layout'>)</span>
<a name="line-167"></a> <span class='hs-varid'>idPtr</span>
<a name="line-168"></a> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varid'>fromIntegral</span> <span class='hs-varop'>.</span> <span class='hs-varid'>fromEnum</span><span class='hs-layout'>)</span> <span class='hs-varid'>size</span><span class='hs-layout'>)</span>
<a name="line-169"></a>
<a name="line-170"></a>
<a name="line-171"></a><a name="tooltipSetIconFromIconName"></a><span class='hs-comment'>-- | Sets the icon of the tooltip (which is in front of the text) to be the</span>
<a name="line-172"></a><span class='hs-comment'>-- icon indicated by @iconName@ with the size indicated by @size@. If</span>
<a name="line-173"></a><span class='hs-comment'>-- @iconName@ is 'Nothing' the image will be hidden.</span>
<a name="line-174"></a><span class='hs-comment'>--</span>
<a name="line-175"></a><span class='hs-comment'>-- * Available since Gtk+ version 2.14</span>
<a name="line-176"></a><span class='hs-comment'>--</span>
<a name="line-177"></a><span class='hs-definition'>tooltipSetIconFromIconName</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TooltipClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span>
<a name="line-178"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ @iconName@ an icon name, or 'Nothing'</span>
<a name="line-179"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IconSize</span> <span class='hs-comment'>-- ^ @size@ a stock icon size</span>
<a name="line-180"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-181"></a><span class='hs-definition'>tooltipSetIconFromIconName</span> <span class='hs-varid'>self</span> <span class='hs-varid'>iconName</span> <span class='hs-varid'>size</span> <span class='hs-keyglyph'>=</span>
<a name="line-182"></a> <span class='hs-varid'>maybeWith</span> <span class='hs-varid'>withUTFString</span> <span class='hs-varid'>iconName</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span> <span class='hs-varid'>iconPtr</span> <span class='hs-keyglyph'>-></span>
<a name="line-183"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>Tooltip</span> <span class='hs-varid'>arg1</span><span class='hs-layout'>)</span> <span class='hs-varid'>arg2</span> <span class='hs-varid'>arg3</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>arg1</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>argPtr1</span> <span class='hs-keyglyph'>-></span><span class='hs-varid'>gtk_tooltip_set_icon_from_icon_name</span> <span class='hs-varid'>argPtr1</span> <span class='hs-varid'>arg2</span> <span class='hs-varid'>arg3</span><span class='hs-layout'>)</span>
<a name="line-184"></a><span class='hs-comment'>{-# LINE 177 "./Graphics/UI/Gtk/Misc/Tooltip.chs" #-}</span>
<a name="line-185"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toTooltip</span> <span class='hs-varid'>self</span><span class='hs-layout'>)</span>
<a name="line-186"></a> <span class='hs-varid'>iconPtr</span>
<a name="line-187"></a> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varid'>fromIntegral</span> <span class='hs-varop'>.</span> <span class='hs-varid'>fromEnum</span><span class='hs-layout'>)</span> <span class='hs-varid'>size</span><span class='hs-layout'>)</span>
<a name="line-188"></a>
<a name="line-189"></a>
<a name="line-190"></a><a name="tooltipSetCustom"></a><span class='hs-comment'>-- | Replaces the widget packed into the tooltip with @customWidget@.</span>
<a name="line-191"></a><span class='hs-comment'>-- @customWidget@ does not get destroyed when the tooltip goes away. By default</span>
<a name="line-192"></a><span class='hs-comment'>-- a box with a 'Image' and 'Label' is embedded in the tooltip, which can be</span>
<a name="line-193"></a><span class='hs-comment'>-- configured using 'tooltipSetMarkup' and 'tooltipSetIcon'.</span>
<a name="line-194"></a><span class='hs-comment'>--</span>
<a name="line-195"></a><span class='hs-definition'>tooltipSetCustom</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>TooltipClass</span> <span class='hs-varid'>self</span><span class='hs-layout'>,</span> <span class='hs-conid'>WidgetClass</span> <span class='hs-varid'>widget</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span>
<a name="line-196"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-varid'>widget</span> <span class='hs-comment'>-- ^ @customWidget@ a 'Widget', or 'Nothing' to unset the old custom widget.</span>
<a name="line-197"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-198"></a><span class='hs-definition'>tooltipSetCustom</span> <span class='hs-varid'>self</span> <span class='hs-varid'>customWidget</span> <span class='hs-keyglyph'>=</span>
<a name="line-199"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>Tooltip</span> <span class='hs-varid'>arg1</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>Widget</span> <span class='hs-varid'>arg2</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>arg1</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>argPtr1</span> <span class='hs-keyglyph'>-></span><span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>arg2</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>argPtr2</span> <span class='hs-keyglyph'>-></span><span class='hs-varid'>gtk_tooltip_set_custom</span> <span class='hs-varid'>argPtr1</span> <span class='hs-varid'>argPtr2</span><span class='hs-layout'>)</span>
<a name="line-200"></a><span class='hs-comment'>{-# LINE 192 "./Graphics/UI/Gtk/Misc/Tooltip.chs" #-}</span>
<a name="line-201"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toTooltip</span> <span class='hs-varid'>self</span><span class='hs-layout'>)</span>
<a name="line-202"></a> <span class='hs-layout'>(</span><span class='hs-varid'>maybe</span> <span class='hs-layout'>(</span><span class='hs-conid'>Widget</span> <span class='hs-varid'>nullForeignPtr</span><span class='hs-layout'>)</span> <span class='hs-varid'>toWidget</span> <span class='hs-varid'>customWidget</span><span class='hs-layout'>)</span>
<a name="line-203"></a>
<a name="line-204"></a><a name="tooltipTriggerTooltipQuery"></a><span class='hs-comment'>-- | Triggers a new tooltip query on @display@, in order to update the current</span>
<a name="line-205"></a><span class='hs-comment'>-- visible tooltip, or to show\/hide the current tooltip. This function is</span>
<a name="line-206"></a><span class='hs-comment'>-- useful to call when, for example, the state of the widget changed by a key</span>
<a name="line-207"></a><span class='hs-comment'>-- press.</span>
<a name="line-208"></a><span class='hs-comment'>--</span>
<a name="line-209"></a><span class='hs-definition'>tooltipTriggerTooltipQuery</span> <span class='hs-keyglyph'>::</span>
<a name="line-210"></a> <span class='hs-conid'>Display</span> <span class='hs-comment'>-- ^ @display@ - a 'Display'</span>
<a name="line-211"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-212"></a><span class='hs-definition'>tooltipTriggerTooltipQuery</span> <span class='hs-varid'>display</span> <span class='hs-keyglyph'>=</span>
<a name="line-213"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>Display</span> <span class='hs-varid'>arg1</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>arg1</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>argPtr1</span> <span class='hs-keyglyph'>-></span><span class='hs-varid'>gtk_tooltip_trigger_tooltip_query</span> <span class='hs-varid'>argPtr1</span><span class='hs-layout'>)</span>
<a name="line-214"></a><span class='hs-comment'>{-# LINE 205 "./Graphics/UI/Gtk/Misc/Tooltip.chs" #-}</span>
<a name="line-215"></a> <span class='hs-varid'>display</span>
<a name="line-216"></a>
<a name="line-217"></a><a name="tooltipSetTipArea"></a><span class='hs-comment'>-- | Sets the area of the widget, where the contents of this tooltip apply, to</span>
<a name="line-218"></a><span class='hs-comment'>-- be @rect@ (in widget coordinates). This is especially useful for properly</span>
<a name="line-219"></a><span class='hs-comment'>-- setting tooltips on 'TreeView' rows and cells, 'IconView'</span>
<a name="line-220"></a><span class='hs-comment'>--</span>
<a name="line-221"></a><span class='hs-comment'>-- For setting tooltips on 'TreeView', please refer to the convenience</span>
<a name="line-222"></a><span class='hs-comment'>-- functions for this: 'treeViewSetTooltipRow' and 'treeViewSetTooltipCell'.</span>
<a name="line-223"></a><span class='hs-comment'>--</span>
<a name="line-224"></a><span class='hs-definition'>tooltipSetTipArea</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TooltipClass</span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>self</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Rectangle</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-225"></a><span class='hs-definition'>tooltipSetTipArea</span> <span class='hs-varid'>self</span> <span class='hs-varid'>rect</span> <span class='hs-keyglyph'>=</span>
<a name="line-226"></a> <span class='hs-varid'>with</span> <span class='hs-varid'>rect</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span> <span class='hs-varid'>rectPtr</span> <span class='hs-keyglyph'>-></span>
<a name="line-227"></a> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-conid'>Tooltip</span> <span class='hs-varid'>arg1</span><span class='hs-layout'>)</span> <span class='hs-varid'>arg2</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>withForeignPtr</span> <span class='hs-varid'>arg1</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>argPtr1</span> <span class='hs-keyglyph'>-></span><span class='hs-varid'>gtk_tooltip_set_tip_area</span> <span class='hs-varid'>argPtr1</span> <span class='hs-varid'>arg2</span><span class='hs-layout'>)</span>
<a name="line-228"></a><span class='hs-comment'>{-# LINE 218 "./Graphics/UI/Gtk/Misc/Tooltip.chs" #-}</span>
<a name="line-229"></a> <span class='hs-layout'>(</span><span class='hs-varid'>toTooltip</span> <span class='hs-varid'>self</span><span class='hs-layout'>)</span>
<a name="line-230"></a> <span class='hs-layout'>(</span><span class='hs-varid'>castPtr</span> <span class='hs-varid'>rectPtr</span><span class='hs-layout'>)</span>
<a name="line-231"></a>
<a name="line-232"></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_tooltip_set_markup"</span>
<a name="line-233"></a> <span class='hs-varid'>gtk_tooltip_set_markup</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>Tooltip</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>CChar</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-234"></a>
<a name="line-235"></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_tooltip_set_text"</span>
<a name="line-236"></a> <span class='hs-varid'>gtk_tooltip_set_text</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>Tooltip</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>CChar</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-237"></a>
<a name="line-238"></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_tooltip_set_icon"</span>
<a name="line-239"></a> <span class='hs-varid'>gtk_tooltip_set_icon</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>Tooltip</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>Pixbuf</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-240"></a>
<a name="line-241"></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_tooltip_set_icon_from_stock"</span>
<a name="line-242"></a> <span class='hs-varid'>gtk_tooltip_set_icon_from_stock</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>Tooltip</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>CChar</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>CInt</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-243"></a>
<a name="line-244"></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_tooltip_set_icon_from_icon_name"</span>
<a name="line-245"></a> <span class='hs-varid'>gtk_tooltip_set_icon_from_icon_name</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>Tooltip</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>CChar</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>CInt</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-246"></a>
<a name="line-247"></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_tooltip_set_custom"</span>
<a name="line-248"></a> <span class='hs-varid'>gtk_tooltip_set_custom</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>Tooltip</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>Widget</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-249"></a>
<a name="line-250"></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_tooltip_trigger_tooltip_query"</span>
<a name="line-251"></a> <span class='hs-varid'>gtk_tooltip_trigger_tooltip_query</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>Display</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-252"></a>
<a name="line-253"></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_tooltip_set_tip_area"</span>
<a name="line-254"></a> <span class='hs-varid'>gtk_tooltip_set_tip_area</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>Tooltip</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>Ptr</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
</pre></body>
</html>
