<!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"/>
<title>gtkmm: Gtk::Tooltips Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<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">2.24.4</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<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_1Tooltips.html">Tooltips</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-static-methods">Static Protected Member Functions</a> |
<a href="#related">Related Functions</a> </div>
<div class="headertitle">
<h1>Gtk::Tooltips Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Gtk::Tooltips" --><!-- doxytag: inherits="Gtk::Object" -->
<p><a class="el" href="classGtk_1_1Tooltips.html" title="Tooltips are the messages that appear next to a widget when the mouse pointer is held over it for a s...">Tooltips</a> are the messages that appear next to a widget when the mouse pointer is held over it for a short amount of time. <a href="#_details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Gtk::Tooltips:</div>
<div class="dyncontent">
<div class="center"><img src="classGtk_1_1Tooltips__inherit__graph.png" border="0" usemap="#Gtk_1_1Tooltips_inherit__map" alt="Inheritance graph"/></div>
<map name="Gtk_1_1Tooltips_inherit__map" id="Gtk_1_1Tooltips_inherit__map">
<area shape="rect" id="node2" href="classGtk_1_1Object.html" title="Gtk::Object is the base class for all widgets, and for a few non-widget objects such as Gtk::Adjustme..." alt="" coords="21,237,115,267"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="21,160,115,189"/><area shape="rect" id="node6" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,83,131,112"/><area shape="rect" id="node8" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="11,5,125,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for Gtk::Tooltips:</div>
<div class="dyncontent">
<div class="center"><img src="classGtk_1_1Tooltips__coll__graph.png" border="0" usemap="#Gtk_1_1Tooltips_coll__map" alt="Collaboration graph"/></div>
<map name="Gtk_1_1Tooltips_coll__map" id="Gtk_1_1Tooltips_coll__map">
<area shape="rect" id="node2" href="classGtk_1_1Object.html" title="Gtk::Object is the base class for all widgets, and for a few non-widget objects such as Gtk::Adjustme..." alt="" coords="21,237,115,267"/><area shape="rect" id="node4" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="21,160,115,189"/><area shape="rect" id="node6" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,83,131,112"/><area shape="rect" id="node8" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="11,5,125,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classGtk_1_1Tooltips-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltips.html#ae8dbe8e752834a2f75387b076398e4c1">~Tooltips</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GtkTooltips* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltips.html#a38774289e172671cbaf16fc1a7848adc">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#a38774289e172671cbaf16fc1a7848adc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const GtkTooltips* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltips.html#a9d0fcb336e7fa229be55d9d6ccbc3568">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GtkObject. <a href="#a9d0fcb336e7fa229be55d9d6ccbc3568"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltips.html#acaaf52ad0d4a7ca769ba37a8971be306">Tooltips</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltips.html#a6aa7bcec2047b25bb41de2a70be88851">enable</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltips.html#adb09eeb205e9ffbf582a0050a4f50af5">disable</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltips.html#a0ec8bdbd8e3f0a6b22a12d3c8b74424c">set_tip</a> (<a class="el" href="classGtk_1_1Widget.html">Widget</a>& widget, const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& tip_text, const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& tip_private)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a tooltip containing the message <em>tip_text</em> to the specified <a class="el" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)">Gtk::Widget</a>. <a href="#a0ec8bdbd8e3f0a6b22a12d3c8b74424c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltips.html#a5ab56f85fbb62f1a7a04c0d973c03060">set_tip</a> (<a class="el" href="classGtk_1_1Widget.html">Widget</a>& widget, const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& tip_text)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltips.html#ac703bd5d18292338e0e5940a2ce0e726">unset_tip</a> (<a class="el" href="classGtk_1_1Widget.html">Widget</a>& widget)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltips.html#ae6570150b7243b38e54fcb7ce71ba530">force_window</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pro-static-methods"></a>
Static Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static GtkTooltipsData* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltips.html#ae7f5febaf0a78f2be400b2081b8441c7">data_get</a> (<a class="el" href="classGtk_1_1Widget.html">Widget</a>& widget)</td></tr>
<tr><td colspan="2"><h2><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classGtk_1_1Tooltips.html">Gtk::Tooltips</a>* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltips.html#a1a0aee27d7c8cbb8116b088062d24cc0">wrap</a> (GtkTooltips* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a1a0aee27d7c8cbb8116b088062d24cc0"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classGtk_1_1Tooltips.html" title="Tooltips are the messages that appear next to a widget when the mouse pointer is held over it for a s...">Tooltips</a> are the messages that appear next to a widget when the mouse pointer is held over it for a short amount of time. </p>
<p>They are especially helpful for adding more verbose descriptions of things such as buttons in a toolbar.</p>
<p>This widget holds tooltips for other widgets. You should only need one <a class="el" href="classGtk_1_1Tooltip.html" title="Add tips to your widgets.">Tooltip</a> widget for all widgets you wish to add tips to.</p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000115">Deprecated:</a></b></dt><dd>Use the <a class="el" href="classGtk_1_1Tooltip.html" title="Add tips to your widgets.">Gtk::Tooltip</a> API instead. </dd></dl>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="ae8dbe8e752834a2f75387b076398e4c1"></a><!-- doxytag: member="Gtk::Tooltips::~Tooltips" ref="ae8dbe8e752834a2f75387b076398e4c1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Gtk::Tooltips::~Tooltips </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="acaaf52ad0d4a7ca769ba37a8971be306"></a><!-- doxytag: member="Gtk::Tooltips::Tooltips" ref="acaaf52ad0d4a7ca769ba37a8971be306" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gtk::Tooltips::Tooltips </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae7f5febaf0a78f2be400b2081b8441c7"></a><!-- doxytag: member="Gtk::Tooltips::data_get" ref="ae7f5febaf0a78f2be400b2081b8441c7" args="(Widget &widget)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static GtkTooltipsData* Gtk::Tooltips::data_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGtk_1_1Widget.html">Widget</a>& </td>
<td class="paramname"><em>widget</em></td><td>)</td>
<td><code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="adb09eeb205e9ffbf582a0050a4f50af5"></a><!-- doxytag: member="Gtk::Tooltips::disable" ref="adb09eeb205e9ffbf582a0050a4f50af5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Tooltips::disable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a6aa7bcec2047b25bb41de2a70be88851"></a><!-- doxytag: member="Gtk::Tooltips::enable" ref="a6aa7bcec2047b25bb41de2a70be88851" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Tooltips::enable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ae6570150b7243b38e54fcb7ce71ba530"></a><!-- doxytag: member="Gtk::Tooltips::force_window" ref="ae6570150b7243b38e54fcb7ce71ba530" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Tooltips::force_window </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a9d0fcb336e7fa229be55d9d6ccbc3568"></a><!-- doxytag: member="Gtk::Tooltips::gobj" ref="a9d0fcb336e7fa229be55d9d6ccbc3568" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GtkTooltips* Gtk::Tooltips::gobj </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GtkObject. </p>
<p>Reimplemented from <a class="el" href="classGtk_1_1Object.html#a5a0e5941619df9ec0cc52feccad99005">Gtk::Object</a>.</p>
</div>
</div>
<a class="anchor" id="a38774289e172671cbaf16fc1a7848adc"></a><!-- doxytag: member="Gtk::Tooltips::gobj" ref="a38774289e172671cbaf16fc1a7848adc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GtkTooltips* Gtk::Tooltips::gobj </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GtkObject. </p>
<p>Reimplemented from <a class="el" href="classGtk_1_1Object.html#ae3541ec02d1b7cd56cfabe7295f8948f">Gtk::Object</a>.</p>
</div>
</div>
<a class="anchor" id="a5ab56f85fbb62f1a7a04c0d973c03060"></a><!-- doxytag: member="Gtk::Tooltips::set_tip" ref="a5ab56f85fbb62f1a7a04c0d973c03060" args="(Widget &widget, const Glib::ustring &tip_text)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Tooltips::set_tip </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGtk_1_1Widget.html">Widget</a>& </td>
<td class="paramname"><em>widget</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"><em>tip_text</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a0ec8bdbd8e3f0a6b22a12d3c8b74424c"></a><!-- doxytag: member="Gtk::Tooltips::set_tip" ref="a0ec8bdbd8e3f0a6b22a12d3c8b74424c" args="(Widget &widget, const Glib::ustring &tip_text, const Glib::ustring &tip_private)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Tooltips::set_tip </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGtk_1_1Widget.html">Widget</a>& </td>
<td class="paramname"><em>widget</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"><em>tip_text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"><em>tip_private</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds a tooltip containing the message <em>tip_text</em> to the specified <a class="el" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)">Gtk::Widget</a>. </p>
<p>Deprecated: 2.12: </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">widget</td><td>The <a class="el" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)">Gtk::Widget</a> you wish to associate the tip with. </td></tr>
<tr><td class="paramname">tip_text</td><td>A string containing the tip itself. </td></tr>
<tr><td class="paramname">tip_private</td><td>A string of any further information that may be useful if the user gets stuck. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac703bd5d18292338e0e5940a2ce0e726"></a><!-- doxytag: member="Gtk::Tooltips::unset_tip" ref="ac703bd5d18292338e0e5940a2ce0e726" args="(Widget &widget)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gtk::Tooltips::unset_tip </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGtk_1_1Widget.html">Widget</a>& </td>
<td class="paramname"><em>widget</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a1a0aee27d7c8cbb8116b088062d24cc0"></a><!-- doxytag: member="Gtk::Tooltips::wrap" ref="a1a0aee27d7c8cbb8116b088062d24cc0" args="(GtkTooltips *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGtk_1_1Tooltips.html">Gtk::Tooltips</a>* wrap </td>
<td>(</td>
<td class="paramtype">GtkTooltips * </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><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></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="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>gtkmm/tooltips.h</li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue Jun 25 2013 for gtkmm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
