<!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/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.7"/>
<title>gtkmm: Gtk::Tooltip Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">gtkmm
 <span id="projectnumber">3.14.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.7 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceGtk.html">Gtk</a></li><li class="navelem"><a class="el" href="classGtk_1_1Tooltip.html">Tooltip</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#related">Related Functions</a> |
<a href="classGtk_1_1Tooltip-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Gtk::Tooltip Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Add tips to your widgets.
<a href="classGtk_1_1Tooltip.html#details">More...</a></p>
<p><code>#include <gtkmm/tooltip.h></code></p>
<div class="dynheader">
Inheritance diagram for Gtk::Tooltip:</div>
<div class="dyncontent">
<div class="center"><img src="classGtk_1_1Tooltip__inherit__graph.png" border="0" usemap="#Gtk_1_1Tooltip_inherit__map" alt="Inheritance graph"/></div>
<map name="Gtk_1_1Tooltip_inherit__map" id="Gtk_1_1Tooltip_inherit__map">
<area shape="rect" id="node2" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="21,155,115,181"/><area shape="rect" id="node3" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,80,131,107"/><area shape="rect" id="node4" href="http://library.gnome.org/devel/libsigc++/unstable/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="11,5,125,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a2b55375bacbc3dbb4e37cc4931b330f2"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltip.html#a2b55375bacbc3dbb4e37cc4931b330f2">~Tooltip</a> ()</td></tr>
<tr class="separator:a2b55375bacbc3dbb4e37cc4931b330f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6fd1e9cfe3aefe37b56217036eb7a9b9"><td class="memItemLeft" align="right" valign="top">GtkTooltip* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltip.html#a6fd1e9cfe3aefe37b56217036eb7a9b9">gobj</a> ()</td></tr>
<tr class="memdesc:a6fd1e9cfe3aefe37b56217036eb7a9b9"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a6fd1e9cfe3aefe37b56217036eb7a9b9">More...</a><br /></td></tr>
<tr class="separator:a6fd1e9cfe3aefe37b56217036eb7a9b9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a19c11e2c7fcdd35c7a06adea5655a9c5"><td class="memItemLeft" align="right" valign="top">const GtkTooltip* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltip.html#a19c11e2c7fcdd35c7a06adea5655a9c5">gobj</a> () const </td></tr>
<tr class="memdesc:a19c11e2c7fcdd35c7a06adea5655a9c5"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a19c11e2c7fcdd35c7a06adea5655a9c5">More...</a><br /></td></tr>
<tr class="separator:a19c11e2c7fcdd35c7a06adea5655a9c5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a83a2d5479fc5dbd10b73fe2dc4c0cecd"><td class="memItemLeft" align="right" valign="top">GtkTooltip* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltip.html#a83a2d5479fc5dbd10b73fe2dc4c0cecd">gobj_copy</a> ()</td></tr>
<tr class="memdesc:a83a2d5479fc5dbd10b73fe2dc4c0cecd"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <a href="#a83a2d5479fc5dbd10b73fe2dc4c0cecd">More...</a><br /></td></tr>
<tr class="separator:a83a2d5479fc5dbd10b73fe2dc4c0cecd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a49e0b6727492955b588399809eba8943"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltip.html#a49e0b6727492955b588399809eba8943">set_markup</a> (const <a class="elRef" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a>& markup)</td></tr>
<tr class="memdesc:a49e0b6727492955b588399809eba8943"><td class="mdescLeft"> </td><td class="mdescRight">Sets the text of the tooltip to be <em>markup</em>, which is marked up with the [<a class="elRef" href="http://library.gnome.org/devel/pangomm/unstable/namespacePango.html">Pango</a> text markup language][PangoMarkupFormat]. <a href="#a49e0b6727492955b588399809eba8943">More...</a><br /></td></tr>
<tr class="separator:a49e0b6727492955b588399809eba8943"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad86b297cbbb539a2c274c5a0af9ab73f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltip.html#ad86b297cbbb539a2c274c5a0af9ab73f">unset_markup</a> ()</td></tr>
<tr class="memdesc:ad86b297cbbb539a2c274c5a0af9ab73f"><td class="mdescLeft"> </td><td class="mdescRight">Hide the label. <a href="#ad86b297cbbb539a2c274c5a0af9ab73f">More...</a><br /></td></tr>
<tr class="separator:ad86b297cbbb539a2c274c5a0af9ab73f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a050b7ea7894290257eb0e8dd0ccddf95"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltip.html#a050b7ea7894290257eb0e8dd0ccddf95">set_text</a> (const <a class="elRef" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a>& text)</td></tr>
<tr class="memdesc:a050b7ea7894290257eb0e8dd0ccddf95"><td class="mdescLeft"> </td><td class="mdescRight">Sets the text of the tooltip to be <em>text</em>. <a href="#a050b7ea7894290257eb0e8dd0ccddf95">More...</a><br /></td></tr>
<tr class="separator:a050b7ea7894290257eb0e8dd0ccddf95"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b147eb8a23478ff52fbb41c97783e54"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltip.html#a7b147eb8a23478ff52fbb41c97783e54">unset_text</a> ()</td></tr>
<tr class="memdesc:a7b147eb8a23478ff52fbb41c97783e54"><td class="mdescLeft"> </td><td class="mdescRight">Hide the label. <a href="#a7b147eb8a23478ff52fbb41c97783e54">More...</a><br /></td></tr>
<tr class="separator:a7b147eb8a23478ff52fbb41c97783e54"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6d6492b6438f3f49887bed5548c7daae"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltip.html#a6d6492b6438f3f49887bed5548c7daae">set_icon</a> (const <a class="elRef" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> >& pixbuf)</td></tr>
<tr class="memdesc:a6d6492b6438f3f49887bed5548c7daae"><td class="mdescLeft"> </td><td class="mdescRight">Sets the icon of the tooltip (which is in front of the text) to be <em>pixbuf</em>. <a href="#a6d6492b6438f3f49887bed5548c7daae">More...</a><br /></td></tr>
<tr class="separator:a6d6492b6438f3f49887bed5548c7daae"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a349ed2bfb3bdabb4c53ad5e0bf1675b1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltip.html#a349ed2bfb3bdabb4c53ad5e0bf1675b1">set_icon</a> (const <a class="elRef" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="elRef" href="http://library.gnome.org/devel/glibmm/unstable/classGio_1_1Icon.html">Gio::Icon</a> >& gicon, <a class="el" href="classGtk_1_1IconSize.html">IconSize</a> <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01656.html#ga445a43f417432dd1b9aed90ef239c700">size</a>)</td></tr>
<tr class="memdesc:a349ed2bfb3bdabb4c53ad5e0bf1675b1"><td class="mdescLeft"> </td><td class="mdescRight">Sets the icon of the tooltip (which is in front of the text) to be the icon indicated by <em>gicon</em> with the size indicated by <em>size</em>. <a href="#a349ed2bfb3bdabb4c53ad5e0bf1675b1">More...</a><br /></td></tr>
<tr class="separator:a349ed2bfb3bdabb4c53ad5e0bf1675b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a15c00ef935818dbd5b4dc3beffaba03e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltip.html#a15c00ef935818dbd5b4dc3beffaba03e">set_icon_from_stock</a> (const <a class="el" href="classGtk_1_1StockID.html">StockID</a>& stock_id, <a class="el" href="classGtk_1_1IconSize.html">IconSize</a> <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01656.html#ga445a43f417432dd1b9aed90ef239c700">size</a>)</td></tr>
<tr class="memdesc:a15c00ef935818dbd5b4dc3beffaba03e"><td class="mdescLeft"> </td><td class="mdescRight">Sets the icon of the tooltip (which is in front of the text) to be the stock item indicated by <em>stock_id</em> with the size indicated by <em>size</em>. <a href="#a15c00ef935818dbd5b4dc3beffaba03e">More...</a><br /></td></tr>
<tr class="separator:a15c00ef935818dbd5b4dc3beffaba03e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba2d21de6600dd047836143aaf09b67b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltip.html#aba2d21de6600dd047836143aaf09b67b">set_icon_from_icon_name</a> (const <a class="elRef" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a>& icon_name, <a class="el" href="classGtk_1_1IconSize.html">IconSize</a> <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01656.html#ga445a43f417432dd1b9aed90ef239c700">size</a>)</td></tr>
<tr class="memdesc:aba2d21de6600dd047836143aaf09b67b"><td class="mdescLeft"> </td><td class="mdescRight">Sets the icon of the tooltip (which is in front of the text) to be the icon indicated by <em>icon_name</em> with the size indicated by <em>size</em>. <a href="#aba2d21de6600dd047836143aaf09b67b">More...</a><br /></td></tr>
<tr class="separator:aba2d21de6600dd047836143aaf09b67b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a155467ddaec3fbbebb8dcf95f72484e4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltip.html#a155467ddaec3fbbebb8dcf95f72484e4">unset_icon</a> ()</td></tr>
<tr class="memdesc:a155467ddaec3fbbebb8dcf95f72484e4"><td class="mdescLeft"> </td><td class="mdescRight">Hide the image. <a href="#a155467ddaec3fbbebb8dcf95f72484e4">More...</a><br /></td></tr>
<tr class="separator:a155467ddaec3fbbebb8dcf95f72484e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a46d40fa085a79d98c8220cb5690528e3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltip.html#a46d40fa085a79d98c8220cb5690528e3">set_custom</a> (<a class="el" href="classGtk_1_1Widget.html">Widget</a>& custom_widget)</td></tr>
<tr class="memdesc:a46d40fa085a79d98c8220cb5690528e3"><td class="mdescLeft"> </td><td class="mdescRight">Replaces the widget packed into the tooltip with <em>custom_widget</em>. <a href="#a46d40fa085a79d98c8220cb5690528e3">More...</a><br /></td></tr>
<tr class="separator:a46d40fa085a79d98c8220cb5690528e3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adb2713433a636b85604be415a803c674"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltip.html#adb2713433a636b85604be415a803c674">unset_custom</a> ()</td></tr>
<tr class="memdesc:adb2713433a636b85604be415a803c674"><td class="mdescLeft"> </td><td class="mdescRight">Remove the custom widget. <a href="#adb2713433a636b85604be415a803c674">More...</a><br /></td></tr>
<tr class="separator:adb2713433a636b85604be415a803c674"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a197701484426a19f1dee98411e3d3878"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltip.html#a197701484426a19f1dee98411e3d3878">set_tip_area</a> (const <a class="el" href="classGdk_1_1Rectangle.html">Gdk::Rectangle</a>& rect)</td></tr>
<tr class="memdesc:a197701484426a19f1dee98411e3d3878"><td class="mdescLeft"> </td><td class="mdescRight">Sets the area of the widget, where the contents of this tooltip apply, to be <em>rect</em> (in widget coordinates). <a href="#a197701484426a19f1dee98411e3d3878">More...</a><br /></td></tr>
<tr class="separator:a197701484426a19f1dee98411e3d3878"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a851cb28fda97592c333e17e07007bb26"><td class="memItemLeft" align="right" valign="top">static GType </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltip.html#a851cb28fda97592c333e17e07007bb26">get_type</a> ()</td></tr>
<tr class="memdesc:a851cb28fda97592c333e17e07007bb26"><td class="mdescLeft"> </td><td class="mdescRight">Get the GType for this class, for use with the underlying GObject type system. <a href="#a851cb28fda97592c333e17e07007bb26">More...</a><br /></td></tr>
<tr class="separator:a851cb28fda97592c333e17e07007bb26"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9e1aac92a4ecf20d602941be5f4c4ac8"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltip.html#a9e1aac92a4ecf20d602941be5f4c4ac8">trigger_tooltip_query</a> (const <a class="elRef" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Display.html">Gdk::Display</a> >& display)</td></tr>
<tr class="separator:a9e1aac92a4ecf20d602941be5f4c4ac8"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p>
</td></tr>
<tr class="memitem:a7bf26ebe7007a80738146ccee0f3a0c6"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1Tooltip.html">Gtk::Tooltip</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltip.html#a7bf26ebe7007a80738146ccee0f3a0c6">wrap</a> (GtkTooltip* object, bool take_copy=false)</td></tr>
<tr class="memdesc:a7bf26ebe7007a80738146ccee0f3a0c6"><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="http://library.gnome.org/devel/glibmm/unstable/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a7bf26ebe7007a80738146ccee0f3a0c6">More...</a><br /></td></tr>
<tr class="separator:a7bf26ebe7007a80738146ccee0f3a0c6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Add tips to your widgets. </p>
<p>Basic tooltips can be realized simply by using set_tooltip_text() or set_tooltip_markup() 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 <a class="el" href="classGtk_1_1TreeView.html" title="The TreeView widget displays the model (Gtk::TreeModel) data and allows the user to interact with it...">Gtk::TreeView</a> row or cell, you will have to do a little more work:</p>
<ul>
<li>Call <a class="el" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets) ">Gtk::Widget</a>:set_has_tooltip(); 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 <a class="el" href="classGtk_1_1Widget.html#a336ca29ff19abe96873634d9eed3e0ab">Gtk::Widget::signal_query_tooltip()</a>. This signal will be emitted when a tooltip is supposed to be shown. One of the arguments passed to the signal handler is a <a class="el" href="classGtk_1_1Tooltip.html" title="Add tips to your widgets. ">Gtk::Tooltip</a> object. This is the object that we are about to display as a tooltip, and can be manipulated in your callback using functions like <a class="el" href="classGtk_1_1Tooltip.html#a6d6492b6438f3f49887bed5548c7daae" title="Sets the icon of the tooltip (which is in front of the text) to be pixbuf. ">Gtk::Tooltip::set_icon()</a>. 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 true from your query-tooltip handler. This causes the tooltip to be show. If you return false, 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 <a class="el" href="classGtk_1_1Window.html" title="Toplevel Window This represents all widgets which are physical windows controlled by the window manag...">Window</a> which will be used as tooltip window. This works as follows:</p>
<ul>
<li>Do <a class="el" href="classGtk_1_1Widget.html#a9acdb4ae0461ce87cacd553a3de7608d" title="Sets the has-tooltip property on widget to has_tooltip. ">Gtk::Widget::set_has_tooltip()</a> and connect to <a class="el" href="classGtk_1_1Widget.html#a336ca29ff19abe96873634d9eed3e0ab">Gtk::Widget::signal_query_tooltip()</a> as before.</li>
<li>Use <a class="el" href="classGtk_1_1Widget.html#af4195154d63bd1551af0b66d47ba669e" title="Replaces the default, usually yellow, window used for displaying tooltips with custom_window. ">Gtk::Widget::set_tooltip_window()</a> to set a <a class="el" href="classGtk_1_1Window.html" title="Toplevel Window This represents all widgets which are physical windows controlled by the window manag...">Gtk::Window</a> created by you as tooltip window.</li>
<li>In the query-tooltip callback you can access your window using <a class="el" href="classGtk_1_1Widget.html#a9d52bbba472b9c74dfa22cb1f60981ca" title="Returns the Gtk::Window of the current tooltip. ">Gtk::Widget::get_tooltip_window()</a> and manipulate it as you wish. The semantics of the return value are exactly as before, return true to show the window, false to not show it.</li>
</ul>
<dl class="since_2_12"><dt><b><a class="el" href="since_2_12.html#_since_2_12000080">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a2b55375bacbc3dbb4e37cc4931b330f2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual Gtk::Tooltip::~Tooltip </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a851cb28fda97592c333e17e07007bb26"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static GType Gtk::Tooltip::get_type </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the GType for this class, for use with the underlying GObject type system. </p>
</div>
</div>
<a class="anchor" id="a6fd1e9cfe3aefe37b56217036eb7a9b9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">GtkTooltip* Gtk::Tooltip::gobj </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the underlying C GObject. </p>
</div>
</div>
<a class="anchor" id="a19c11e2c7fcdd35c7a06adea5655a9c5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const GtkTooltip* Gtk::Tooltip::gobj </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the underlying C GObject. </p>
</div>
</div>
<a class="anchor" id="a83a2d5479fc5dbd10b73fe2dc4c0cecd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GtkTooltip* Gtk::Tooltip::gobj_copy </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. </p>
</div>
</div>
<a class="anchor" id="a46d40fa085a79d98c8220cb5690528e3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Tooltip::set_custom </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGtk_1_1Widget.html">Widget</a>& </td>
<td class="paramname"><em>custom_widget</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Replaces the widget packed into the tooltip with <em>custom_widget</em>. </p>
<p><em>custom_widget</em> does not get destroyed when the tooltip goes away. By default a box with a <a class="el" href="classGtk_1_1Image.html" title="A widget displaying an image. ">Gtk::Image</a> and <a class="el" href="classGtk_1_1Label.html" title="A widget that displays a small to medium amount of text. ">Gtk::Label</a> is embedded in the tooltip, which can be configured using <a class="el" href="classGtk_1_1Tooltip.html#a49e0b6727492955b588399809eba8943" title="Sets the text of the tooltip to be markup, which is marked up with the [Pango text markup language][P...">set_markup()</a> and <a class="el" href="classGtk_1_1Tooltip.html#a6d6492b6438f3f49887bed5548c7daae" title="Sets the icon of the tooltip (which is in front of the text) to be pixbuf. ">set_icon()</a>.</p>
<dl class="since_2_12"><dt><b><a class="el" href="since_2_12.html#_since_2_12000085">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">custom_widget</td><td>A <a class="el" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets) ">Gtk::Widget</a>, or <code>0</code> to unset the old custom widget. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6d6492b6438f3f49887bed5548c7daae"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Tooltip::set_icon </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> >& </td>
<td class="paramname"><em>pixbuf</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the icon of the tooltip (which is in front of the text) to be <em>pixbuf</em>. </p>
<p>If <em>pixbuf</em> is <code>0</code>, the image will be hidden.</p>
<dl class="since_2_12"><dt><b><a class="el" href="since_2_12.html#_since_2_12000083">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pixbuf</td><td>A <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a>, or <code>0</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a349ed2bfb3bdabb4c53ad5e0bf1675b1"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Tooltip::set_icon </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="elRef" href="http://library.gnome.org/devel/glibmm/unstable/classGio_1_1Icon.html">Gio::Icon</a> > & </td>
<td class="paramname"><em>gicon</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classGtk_1_1IconSize.html">IconSize</a> </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the icon of the tooltip (which is in front of the text) to be the icon indicated by <em>gicon</em> with the size indicated by <em>size</em>. </p>
<p>If <em>gicon</em> is <code>0</code>, the image will be hidden.</p>
<dl class="since_2_20"><dt><b><a class="el" href="since_2_20.html#_since_2_20000085">Since gtkmm 2.20:</a></b></dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">gicon</td><td>A Icon representing the icon, or <code>0</code>. </td></tr>
<tr><td class="paramname">size</td><td>A stock icon size. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aba2d21de6600dd047836143aaf09b67b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Tooltip::set_icon_from_icon_name </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"><em>icon_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classGtk_1_1IconSize.html">IconSize</a> </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the icon of the tooltip (which is in front of the text) to be the icon indicated by <em>icon_name</em> with the size indicated by <em>size</em>. </p>
<p>If <em>icon_name</em> is <code>0</code>, the image will be hidden.</p>
<dl class="since_2_14"><dt><b><a class="el" href="since_2_14.html#_since_2_14000121">Since gtkmm 2.14:</a></b></dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">icon_name</td><td>An icon name, or <code>0</code>. </td></tr>
<tr><td class="paramname">size</td><td>A stock icon size. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a15c00ef935818dbd5b4dc3beffaba03e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Tooltip::set_icon_from_stock </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGtk_1_1StockID.html">StockID</a>& </td>
<td class="paramname"><em>stock_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classGtk_1_1IconSize.html">IconSize</a> </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the icon of the tooltip (which is in front of the text) to be the stock item indicated by <em>stock_id</em> with the size indicated by <em>size</em>. </p>
<p>If <em>stock_id</em> is <code>0</code>, the image will be hidden.</p>
<dl class="since_2_12"><dt><b><a class="el" href="since_2_12.html#_since_2_12000084">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
<p>Deprecated: 3.10: Use <a class="el" href="classGtk_1_1Tooltip.html#aba2d21de6600dd047836143aaf09b67b" title="Sets the icon of the tooltip (which is in front of the text) to be the icon indicated by icon_name wi...">set_icon_from_icon_name()</a> instead.</p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000285">Deprecated:</a></b></dt><dd>Use <a class="el" href="classGtk_1_1Tooltip.html#aba2d21de6600dd047836143aaf09b67b" title="Sets the icon of the tooltip (which is in front of the text) to be the icon indicated by icon_name wi...">set_icon_from_icon_name()</a> instead.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stock_id</td><td>A stock id, or <code>0</code>. </td></tr>
<tr><td class="paramname">size</td><td>A stock icon size. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a49e0b6727492955b588399809eba8943"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Tooltip::set_markup </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"><em>markup</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the text of the tooltip to be <em>markup</em>, which is marked up with the [<a class="elRef" href="http://library.gnome.org/devel/pangomm/unstable/namespacePango.html">Pango</a> text markup language][PangoMarkupFormat]. </p>
<p>If <em>markup</em> is <code>0</code>, the label will be hidden.</p>
<dl class="since_2_12"><dt><b><a class="el" href="since_2_12.html#_since_2_12000081">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">markup</td><td>A markup string (see [<a class="elRef" href="http://library.gnome.org/devel/pangomm/unstable/namespacePango.html">Pango</a> markup format][PangoMarkupFormat]) or <code>0</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a050b7ea7894290257eb0e8dd0ccddf95"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Tooltip::set_text </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"><em>text</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the text of the tooltip to be <em>text</em>. </p>
<p>If <em>text</em> is <code>0</code>, the label will be hidden. See also <a class="el" href="classGtk_1_1Tooltip.html#a49e0b6727492955b588399809eba8943" title="Sets the text of the tooltip to be markup, which is marked up with the [Pango text markup language][P...">set_markup()</a>.</p>
<dl class="since_2_12"><dt><b><a class="el" href="since_2_12.html#_since_2_12000082">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">text</td><td>A text string or <code>0</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a197701484426a19f1dee98411e3d3878"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Tooltip::set_tip_area </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classGdk_1_1Rectangle.html">Gdk::Rectangle</a>& </td>
<td class="paramname"><em>rect</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the area of the widget, where the contents of this tooltip apply, to be <em>rect</em> (in widget coordinates). </p>
<p>This is especially useful for properly setting tooltips on <a class="el" href="classGtk_1_1TreeView.html" title="The TreeView widget displays the model (Gtk::TreeModel) data and allows the user to interact with it...">Gtk::TreeView</a> rows and cells, Gtk::IconViews, etc.</p>
<p>For setting tooltips on <a class="el" href="classGtk_1_1TreeView.html" title="The TreeView widget displays the model (Gtk::TreeModel) data and allows the user to interact with it...">Gtk::TreeView</a>, please refer to the convenience functions for this: <a class="el" href="classGtk_1_1TreeView.html#ae3d42c3596c90dc9b51a0039788412c9" title="Sets the tip area of tooltip to be the area covered by the row at path. ">Gtk::TreeView::set_tooltip_row()</a> and <a class="el" href="classGtk_1_1TreeView.html#ae7cc8fde03c481de81fc9d13e34bff98" title="Sets the tip area of tooltip to the area path, column and cell have in common. ">Gtk::TreeView::set_tooltip_cell()</a>.</p>
<dl class="since_2_12"><dt><b><a class="el" href="since_2_12.html#_since_2_12000086">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rect</td><td>A <a class="el" href="classGdk_1_1Rectangle.html" title="Gdk::Rectangle is a structure holding the position and size of a rectangle. ">Gdk::Rectangle</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9e1aac92a4ecf20d602941be5f4c4ac8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void Gtk::Tooltip::trigger_tooltip_query </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Display.html">Gdk::Display</a> >& </td>
<td class="paramname"><em>display</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="adb2713433a636b85604be415a803c674"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Tooltip::unset_custom </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove the custom widget. </p>
<dl class="since_3_2"><dt><b><a class="el" href="since_3_2.html#_since_3_2000046">Since gtkmm 3.2:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a155467ddaec3fbbebb8dcf95f72484e4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Tooltip::unset_icon </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Hide the image. </p>
<dl class="since_3_2"><dt><b><a class="el" href="since_3_2.html#_since_3_2000045">Since gtkmm 3.2:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="ad86b297cbbb539a2c274c5a0af9ab73f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Tooltip::unset_markup </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Hide the label. </p>
<dl class="since_3_2"><dt><b><a class="el" href="since_3_2.html#_since_3_2000043">Since gtkmm 3.2:</a></b></dt><dd></dd></dl>
</div>
</div>
<a class="anchor" id="a7b147eb8a23478ff52fbb41c97783e54"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Tooltip::unset_text </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Hide the label. </p>
<dl class="since_3_2"><dt><b><a class="el" href="since_3_2.html#_since_3_2000044">Since gtkmm 3.2:</a></b></dt><dd></dd></dl>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="a7bf26ebe7007a80738146ccee0f3a0c6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGtk_1_1Tooltip.html">Gtk::Tooltip</a> > wrap </td>
<td>(</td>
<td class="paramtype">GtkTooltip * </td>
<td class="paramname"><em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>take_copy</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A <a class="elRef" href="http://library.gnome.org/devel/glibmm/unstable/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">object</td><td>The C instance. </td></tr>
<tr><td class="paramname">take_copy</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 23 2014 12:59:28 for gtkmm by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.7
</small></address>
</body>
</html>
