1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
|
<!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.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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 class="tabs">
<ul>
<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="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceGtk.html">Gtk</a>::<a class="el" href="classGtk_1_1Tooltips.html">Tooltips</a>
</div>
</div>
<div class="contents">
<h1>Gtk::Tooltips Class Reference</h1><!-- 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...">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>
<p>Inherits <a class="el" href="classGtk_1_1Object.html">Gtk::Object</a>.</p>
<div class="dynheader">
Collaboration diagram for Gtk::Tooltips:</div>
<div class="dynsection">
<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" href="classGtk_1_1Object.html" title="Gtk::Object is the base class for all widgets, and for a few non-widget objects such..." alt="" coords="21,237,109,267"/><area shape="rect" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="20,160,111,189"/><area shape="rect" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,83,125,112"/><area shape="rect" doxygen="libsigc++-2.0.tag:http://library.gnome.org/devel/libsigc++/unstable/" href="http://library.gnome.org/devel/libsigc++/unstable/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="12,5,119,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 border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>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" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a>& tip_text, const <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/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" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/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>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>Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/><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" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/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>
<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...">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#_deprecated000069">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>
<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" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>tip_text</em></td><td> </td>
</tr>
<tr>
<td></td>
<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" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/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" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>tip_private</em></td><td> </td>
</tr>
<tr>
<td></td>
<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 border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>widget</em> </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 valign="top"></td><td valign="top"><em>tip_text</em> </td><td>A string containing the tip itself. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tip_private</em> </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><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>The C instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>take_copy</em> </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 size="1"/><address style="text-align: right;"><small>Generated on Tue May 4 13:22:05 2010 for gtkmm by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
|