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 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503
|
<!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::Tooltip 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_1Tooltip.html">Tooltip</a>
</div>
</div>
<div class="contents">
<h1>Gtk::Tooltip Class Reference</h1><!-- doxytag: class="Gtk::Tooltip" --><!-- doxytag: inherits="Glib::Object" -->
<p>Add tips to your widgets. <a href="#_details">More...</a></p>
<p>Inherits <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_1Object.html">Glib::Object</a>.</p>
<div class="dynheader">
Collaboration diagram for Gtk::Tooltip:</div>
<div class="dynsection">
<div class="center"><img src="classGtk_1_1Tooltip__coll__graph.png" border="0" usemap="#Gtk_1_1Tooltip_coll__map" alt="Collaboration graph"/></div>
<map name="Gtk_1_1Tooltip_coll__map" id="Gtk_1_1Tooltip_coll__map">
<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_1Tooltip-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_1Tooltip.html#a2b55375bacbc3dbb4e37cc4931b330f2">~Tooltip</a> ()</td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a6fd1e9cfe3aefe37b56217036eb7a9b9"></a><br/></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a19c11e2c7fcdd35c7a06adea5655a9c5"></a><br/></td></tr>
<tr><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><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"></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_1Tooltip.html#a49e0b6727492955b588399809eba8943">set_markup</a> (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>& markup)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the text of the tooltip to be <em>markup</em>, which is marked up with the <link linkend="PangoMarkupFormat"><a class="elRef" doxygen="pangomm-1.4.tag:http://library.gnome.org/devel/pangomm/unstable/" href="http://library.gnome.org/devel/pangomm/unstable/namespacePango.html">Pango</a> text markup language</link>. <a href="#a49e0b6727492955b588399809eba8943"></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_1Tooltip.html#ab634d7fb4b55207e11ba0897e74121b8">set_text</a> (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>& markup)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the text of the tooltip to be <em>text</em>. <a href="#ab634d7fb4b55207e11ba0897e74121b8"></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_1Tooltip.html#a6d6492b6438f3f49887bed5548c7daae">set_icon</a> (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_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> >& pixbuf)</td></tr>
<tr><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"></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_1Tooltip.html#a7a21f95b91973c59cb748ca53089bd96">set_icon</a> (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_1RefPtr.html">Glib::RefPtr</a>< <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGio_1_1Icon.html">Gio::Icon</a> >& icon, <a class="el" href="classGtk_1_1IconSize.html">IconSize</a> <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01154.html#ga445a43f417432dd1b9aed90ef239c700">size</a>)</td></tr>
<tr><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="#a7a21f95b91973c59cb748ca53089bd96"></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_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" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01154.html#ga445a43f417432dd1b9aed90ef239c700">size</a>)</td></tr>
<tr><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"></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_1Tooltip.html#aba2d21de6600dd047836143aaf09b67b">set_icon_from_icon_name</a> (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>& icon_name, <a class="el" href="classGtk_1_1IconSize.html">IconSize</a> <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01154.html#ga445a43f417432dd1b9aed90ef239c700">size</a>)</td></tr>
<tr><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"></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_1Tooltip.html#a46d40fa085a79d98c8220cb5690528e3">set_custom</a> (<a class="el" href="classGtk_1_1Widget.html">Widget</a>& custom_widget)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Replaces the widget packed into the tooltip with <em>custom_widget</em>. <a href="#a46d40fa085a79d98c8220cb5690528e3"></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_1Tooltip.html#a197701484426a19f1dee98411e3d3878">set_tip_area</a> (const <a class="el" href="classGdk_1_1Rectangle.html">Gdk::Rectangle</a>& rect)</td></tr>
<tr><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"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><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" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" 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><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="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" 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><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="#a7bf26ebe7007a80738146ccee0f3a0c6"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Add tips to your widgets. </p>
<p><a class="el" href="classGtk_1_1Tooltip.html" title="Add tips to your widgets.">Gtk::Tooltip</a> belongs to the new tooltips API that was introduced in GTK+ 2.12 and which deprecates the old <a class="el" href="classGtk_1_1Tooltips.html" title="Tooltips are the messages that appear next to a widget when the mouse pointer is...">Gtk::Tooltips</a> API.</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...">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>
</ul>
<ul>
<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>
</ul>
<ul>
<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...">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>
</ul>
<ul>
<li>Use <a class="el" href="classGtk_1_1Widget.html#ac7758d297f1dd68f1d488489bc972df4" 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...">Gtk::Window</a> created by you as tooltip window.</li>
</ul>
<ul>
<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_12000096">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a2b55375bacbc3dbb4e37cc4931b330f2"></a><!-- doxytag: member="Gtk::Tooltip::~Tooltip" ref="a2b55375bacbc3dbb4e37cc4931b330f2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Gtk::Tooltip::~Tooltip </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a19c11e2c7fcdd35c7a06adea5655a9c5"></a><!-- doxytag: member="Gtk::Tooltip::gobj" ref="a19c11e2c7fcdd35c7a06adea5655a9c5" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GtkTooltip* Gtk::Tooltip::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 GObject. </p>
<p>Reimplemented from <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_1ObjectBase.html#a778a94181132976bbfb0519793f3b32e">Glib::ObjectBase</a>.</p>
</div>
</div>
<a class="anchor" id="a6fd1e9cfe3aefe37b56217036eb7a9b9"></a><!-- doxytag: member="Gtk::Tooltip::gobj" ref="a6fd1e9cfe3aefe37b56217036eb7a9b9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GtkTooltip* Gtk::Tooltip::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 GObject. </p>
<p>Reimplemented from <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_1ObjectBase.html#a4c6efc18be8cb9c56e58fc0bd20fafbe">Glib::ObjectBase</a>.</p>
</div>
</div>
<a class="anchor" id="a83a2d5479fc5dbd10b73fe2dc4c0cecd"></a><!-- doxytag: member="Gtk::Tooltip::gobj_copy" ref="a83a2d5479fc5dbd10b73fe2dc4c0cecd" args="()" -->
<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><!-- doxytag: member="Gtk::Tooltip::set_custom" ref="a46d40fa085a79d98c8220cb5690528e3" args="(Widget &custom_widget)" -->
<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 <link linkend="PangoM...">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_12000101">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>custom_widget</em> </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="a7a21f95b91973c59cb748ca53089bd96"></a><!-- doxytag: member="Gtk::Tooltip::set_icon" ref="a7a21f95b91973c59cb748ca53089bd96" args="(const Glib::RefPtr< Gio::Icon > &icon, IconSize size)" -->
<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" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGio_1_1Icon.html">Gio::Icon</a> > & </td>
<td class="paramname"> <em>icon</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><td> </td>
</tr>
<tr>
<td></td>
<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_20000083">Since gtkmm 2.20:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>gicon</em> </td><td>A Icon representing the icon, or <code>0</code>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>A stock icon size. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a6d6492b6438f3f49887bed5548c7daae"></a><!-- doxytag: member="Gtk::Tooltip::set_icon" ref="a6d6492b6438f3f49887bed5548c7daae" args="(const Glib::RefPtr< Gdk::Pixbuf > &pixbuf)" -->
<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" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" 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_12000099">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pixbuf</em> </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="aba2d21de6600dd047836143aaf09b67b"></a><!-- doxytag: member="Gtk::Tooltip::set_icon_from_icon_name" ref="aba2d21de6600dd047836143aaf09b67b" args="(const Glib::ustring &icon_name, IconSize size)" -->
<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" 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>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><td> </td>
</tr>
<tr>
<td></td>
<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_14000152">Since gtkmm 2.14:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>icon_name</em> </td><td>An icon name, or <code>0</code>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>A stock icon size. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a15c00ef935818dbd5b4dc3beffaba03e"></a><!-- doxytag: member="Gtk::Tooltip::set_icon_from_stock" ref="a15c00ef935818dbd5b4dc3beffaba03e" args="(const StockID &stock_id, IconSize size)" -->
<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><td> </td>
</tr>
<tr>
<td></td>
<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_12000100">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>stock_id</em> </td><td>A stock id, or <code>0</code>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>A stock icon size. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a49e0b6727492955b588399809eba8943"></a><!-- doxytag: member="Gtk::Tooltip::set_markup" ref="a49e0b6727492955b588399809eba8943" args="(const Glib::ustring &markup)" -->
<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" 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>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 <link linkend="PangoMarkupFormat"><a class="elRef" doxygen="pangomm-1.4.tag:http://library.gnome.org/devel/pangomm/unstable/" href="http://library.gnome.org/devel/pangomm/unstable/namespacePango.html">Pango</a> text markup language</link>. </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_12000097">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>markup</em> </td><td>A markup string (see <link linkend="PangoMarkupFormat"><a class="elRef" doxygen="pangomm-1.4.tag:http://library.gnome.org/devel/pangomm/unstable/" href="http://library.gnome.org/devel/pangomm/unstable/namespacePango.html">Pango</a> markup format</link>) or <code>0</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab634d7fb4b55207e11ba0897e74121b8"></a><!-- doxytag: member="Gtk::Tooltip::set_text" ref="ab634d7fb4b55207e11ba0897e74121b8" args="(const Glib::ustring &markup)" -->
<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" 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>markup</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 <link linkend="PangoM...">set_markup()</a>.</p>
<dl class="since_2_12"><dt><b><a class="el" href="since_2_12.html#_since_2_12000098">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>A text string or <code>0</code>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a197701484426a19f1dee98411e3d3878"></a><!-- doxytag: member="Gtk::Tooltip::set_tip_area" ref="a197701484426a19f1dee98411e3d3878" args="(const Gdk::Rectangle &rect)" -->
<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...">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...">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_12000102">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>rect</em> </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><!-- doxytag: member="Gtk::Tooltip::trigger_tooltip_query" ref="a9e1aac92a4ecf20d602941be5f4c4ac8" args="(const Glib::RefPtr< Gdk::Display > &display)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void Gtk::Tooltip::trigger_tooltip_query </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_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><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a7bf26ebe7007a80738146ccee0f3a0c6"></a><!-- doxytag: member="Gtk::Tooltip::wrap" ref="a7bf26ebe7007a80738146ccee0f3a0c6" args="(GtkTooltip *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><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_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><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/tooltip.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>
|