~ubuntu-branches/ubuntu/precise/gtkmm3.0/precise

« back to all changes in this revision

Viewing changes to docs/reference/html/classGtk_1_1Tooltip.html

  • Committer: Bazaar Package Importer
  • Author(s): Michael Biebl
  • Date: 2011-06-17 00:12:44 UTC
  • Revision ID: james.westby@ubuntu.com-20110617001244-9hl5an15hiaaahi6
Tags: upstream-3.0.1
ImportĀ upstreamĀ versionĀ 3.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml">
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 
5
<title>gtkmm: Gtk::Tooltip Class Reference</title>
 
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
 
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
 
8
</head>
 
9
<body>
 
10
<!-- Generated by Doxygen 1.7.3 -->
 
11
<div id="top">
 
12
<div id="titlearea">
 
13
<table cellspacing="0" cellpadding="0">
 
14
 <tbody>
 
15
 <tr style="height: 56px;">
 
16
  <td style="padding-left: 0.5em;">
 
17
   <div id="projectname">gtkmm&#160;<span id="projectnumber">3.0.1</span></div>
 
18
  </td>
 
19
 </tr>
 
20
 </tbody>
 
21
</table>
 
22
</div>
 
23
  <div id="navrow1" class="tabs">
 
24
    <ul class="tablist">
 
25
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
 
26
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
 
27
      <li><a href="modules.html"><span>Modules</span></a></li>
 
28
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
 
29
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
 
30
    </ul>
 
31
  </div>
 
32
  <div id="navrow2" class="tabs2">
 
33
    <ul class="tablist">
 
34
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
 
35
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
 
36
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
 
37
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
 
38
    </ul>
 
39
  </div>
 
40
  <div id="nav-path" class="navpath">
 
41
    <ul>
 
42
      <li class="navelem"><a class="el" href="namespaceGtk.html">Gtk</a> </li>
 
43
      <li class="navelem"><a class="el" href="classGtk_1_1Tooltip.html">Tooltip</a> </li>
 
44
    </ul>
 
45
  </div>
 
46
</div>
 
47
<div class="header">
 
48
  <div class="summary">
 
49
<a href="#pub-methods">Public Member Functions</a> &#124;
 
50
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
 
51
<a href="#related">Related Functions</a> </div>
 
52
  <div class="headertitle">
 
53
<h1>Gtk::Tooltip Class Reference</h1> </div>
 
54
</div>
 
55
<div class="contents">
 
56
<!-- doxytag: class="Gtk::Tooltip" --><!-- doxytag: inherits="Glib::Object" -->
 
57
<p>Add tips to your widgets. <a href="#_details">More...</a></p>
 
58
<div class="dynheader">
 
59
Inheritance diagram for Gtk::Tooltip:</div>
 
60
<div class="dyncontent">
 
61
<div class="center"><img src="classGtk_1_1Tooltip__inherit__graph.png" border="0" usemap="#Gtk_1_1Tooltip_inherit__map" alt="Inheritance graph"/></div>
 
62
<map name="Gtk_1_1Tooltip_inherit__map" id="Gtk_1_1Tooltip_inherit__map">
 
63
<area shape="rect" id="node2" 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,166,111,197"/><area shape="rect" id="node4" 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,86,125,117"/><area shape="rect" id="node6" 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,6,119,37"/></map>
 
64
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
 
65
<div class="dynheader">
 
66
Collaboration diagram for Gtk::Tooltip:</div>
 
67
<div class="dyncontent">
 
68
<div class="center"><img src="classGtk_1_1Tooltip__coll__graph.png" border="0" usemap="#Gtk_1_1Tooltip_coll__map" alt="Collaboration graph"/></div>
 
69
<map name="Gtk_1_1Tooltip_coll__map" id="Gtk_1_1Tooltip_coll__map">
 
70
<area shape="rect" id="node2" 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,166,111,197"/><area shape="rect" id="node4" 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,86,125,117"/><area shape="rect" id="node6" 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,6,119,37"/></map>
 
71
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
 
72
 
 
73
<p><a href="classGtk_1_1Tooltip-members.html">List of all members.</a></p>
 
74
<table class="memberdecls">
 
75
<tr><td colspan="2"><h2><a name="pub-methods"></a>
 
76
Public Member Functions</h2></td></tr>
 
77
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltip.html#a2b55375bacbc3dbb4e37cc4931b330f2">~Tooltip</a> ()</td></tr>
 
78
<tr><td class="memItemLeft" align="right" valign="top">GtkTooltip*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltip.html#a6fd1e9cfe3aefe37b56217036eb7a9b9">gobj</a> ()</td></tr>
 
79
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a6fd1e9cfe3aefe37b56217036eb7a9b9"></a><br/></td></tr>
 
80
<tr><td class="memItemLeft" align="right" valign="top">const GtkTooltip*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltip.html#a19c11e2c7fcdd35c7a06adea5655a9c5">gobj</a> () const </td></tr>
 
81
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a19c11e2c7fcdd35c7a06adea5655a9c5"></a><br/></td></tr>
 
82
<tr><td class="memItemLeft" align="right" valign="top">GtkTooltip*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classGtk_1_1Tooltip.html#a83a2d5479fc5dbd10b73fe2dc4c0cecd">gobj_copy</a> ()</td></tr>
 
83
<tr><td class="mdescLeft">&#160;</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>
 
84
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</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>&amp; markup)</td></tr>
 
85
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the text of the tooltip to be <em>markup</em>, which is marked up with the . <a href="#a49e0b6727492955b588399809eba8943"></a><br/></td></tr>
 
86
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</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>&amp; markup)</td></tr>
 
87
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the text of the tooltip to be <em>text</em>. <a href="#ab634d7fb4b55207e11ba0897e74121b8"></a><br/></td></tr>
 
88
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</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>&lt; <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> &gt;&amp; pixbuf)</td></tr>
 
89
<tr><td class="mdescLeft">&#160;</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>
 
90
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</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>&lt; <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> &gt;&amp; 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/a01176.html#ga445a43f417432dd1b9aed90ef239c700">size</a>)</td></tr>
 
91
<tr><td class="mdescLeft">&#160;</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>
 
92
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</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>&amp; 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/a01176.html#ga445a43f417432dd1b9aed90ef239c700">size</a>)</td></tr>
 
93
<tr><td class="mdescLeft">&#160;</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>
 
94
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</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>&amp; 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/a01176.html#ga445a43f417432dd1b9aed90ef239c700">size</a>)</td></tr>
 
95
<tr><td class="mdescLeft">&#160;</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>
 
96
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</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>&amp; custom_widget)</td></tr>
 
97
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Replaces the widget packed into the tooltip with <em>custom_widget</em>. <a href="#a46d40fa085a79d98c8220cb5690528e3"></a><br/></td></tr>
 
98
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</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>&amp; rect)</td></tr>
 
99
<tr><td class="mdescLeft">&#160;</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>
 
100
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
 
101
Static Public Member Functions</h2></td></tr>
 
102
<tr><td class="memItemLeft" align="right" valign="top">static void&#160;</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>&lt; <a class="el" href="classGdk_1_1Display.html">Gdk::Display</a> &gt;&amp; display)</td></tr>
 
103
<tr><td colspan="2"><h2><a name="related"></a>
 
104
Related Functions</h2></td></tr>
 
105
<tr><td colspan="2">(Note that these are not member functions.) <br/></td></tr>
 
106
<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>&lt; <a class="el" href="classGtk_1_1Tooltip.html">Gtk::Tooltip</a> &gt;&#160;</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>
 
107
<tr><td class="mdescLeft">&#160;</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>
 
108
</table>
 
109
<hr/><a name="_details"></a><h2>Detailed Description</h2>
 
110
<div class="textblock"><p>Add tips to your widgets. </p>
 
111
<p>Basic tooltips can be realized simply by using set_tooltip_text() or set_tooltip_markup() without any explicit tooltip object.</p>
 
112
<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>
 
113
<ul>
 
114
<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>
 
115
</ul>
 
116
<ul>
 
117
<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>
 
118
</ul>
 
119
<ul>
 
120
<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>
 
121
</ul>
 
122
<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>
 
123
<ul>
 
124
<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>
 
125
</ul>
 
126
<ul>
 
127
<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 by the window manag...">Gtk::Window</a> created by you as tooltip window.</li>
 
128
</ul>
 
129
<ul>
 
130
<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>
 
131
</ul>
 
132
<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>
 
133
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
 
134
<a class="anchor" id="a2b55375bacbc3dbb4e37cc4931b330f2"></a><!-- doxytag: member="Gtk::Tooltip::~Tooltip" ref="a2b55375bacbc3dbb4e37cc4931b330f2" args="()" -->
 
135
<div class="memitem">
 
136
<div class="memproto">
 
137
      <table class="memname">
 
138
        <tr>
 
139
          <td class="memname">virtual Gtk::Tooltip::~Tooltip </td>
 
140
          <td>(</td>
 
141
          <td class="paramname"></td><td>)</td>
 
142
          <td><code> [virtual]</code></td>
 
143
        </tr>
 
144
      </table>
 
145
</div>
 
146
<div class="memdoc">
 
147
 
 
148
</div>
 
149
</div>
 
150
<hr/><h2>Member Function Documentation</h2>
 
151
<a class="anchor" id="a6fd1e9cfe3aefe37b56217036eb7a9b9"></a><!-- doxytag: member="Gtk::Tooltip::gobj" ref="a6fd1e9cfe3aefe37b56217036eb7a9b9" args="()" -->
 
152
<div class="memitem">
 
153
<div class="memproto">
 
154
      <table class="memname">
 
155
        <tr>
 
156
          <td class="memname">GtkTooltip* Gtk::Tooltip::gobj </td>
 
157
          <td>(</td>
 
158
          <td class="paramname"></td><td>)</td>
 
159
          <td><code> [inline]</code></td>
 
160
        </tr>
 
161
      </table>
 
162
</div>
 
163
<div class="memdoc">
 
164
 
 
165
<p>Provides access to the underlying C GObject. </p>
 
166
 
 
167
<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>
 
168
 
 
169
</div>
 
170
</div>
 
171
<a class="anchor" id="a19c11e2c7fcdd35c7a06adea5655a9c5"></a><!-- doxytag: member="Gtk::Tooltip::gobj" ref="a19c11e2c7fcdd35c7a06adea5655a9c5" args="() const " -->
 
172
<div class="memitem">
 
173
<div class="memproto">
 
174
      <table class="memname">
 
175
        <tr>
 
176
          <td class="memname">const GtkTooltip* Gtk::Tooltip::gobj </td>
 
177
          <td>(</td>
 
178
          <td class="paramname"></td><td>)</td>
 
179
          <td> const<code> [inline]</code></td>
 
180
        </tr>
 
181
      </table>
 
182
</div>
 
183
<div class="memdoc">
 
184
 
 
185
<p>Provides access to the underlying C GObject. </p>
 
186
 
 
187
<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>
 
188
 
 
189
</div>
 
190
</div>
 
191
<a class="anchor" id="a83a2d5479fc5dbd10b73fe2dc4c0cecd"></a><!-- doxytag: member="Gtk::Tooltip::gobj_copy" ref="a83a2d5479fc5dbd10b73fe2dc4c0cecd" args="()" -->
 
192
<div class="memitem">
 
193
<div class="memproto">
 
194
      <table class="memname">
 
195
        <tr>
 
196
          <td class="memname">GtkTooltip* Gtk::Tooltip::gobj_copy </td>
 
197
          <td>(</td>
 
198
          <td class="paramname"></td><td>)</td>
 
199
          <td></td>
 
200
        </tr>
 
201
      </table>
 
202
</div>
 
203
<div class="memdoc">
 
204
 
 
205
<p>Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. </p>
 
206
 
 
207
</div>
 
208
</div>
 
209
<a class="anchor" id="a46d40fa085a79d98c8220cb5690528e3"></a><!-- doxytag: member="Gtk::Tooltip::set_custom" ref="a46d40fa085a79d98c8220cb5690528e3" args="(Widget &amp;custom_widget)" -->
 
210
<div class="memitem">
 
211
<div class="memproto">
 
212
      <table class="memname">
 
213
        <tr>
 
214
          <td class="memname">void Gtk::Tooltip::set_custom </td>
 
215
          <td>(</td>
 
216
          <td class="paramtype"><a class="el" href="classGtk_1_1Widget.html">Widget</a>&amp;&#160;</td>
 
217
          <td class="paramname"><em>custom_widget</em></td><td>)</td>
 
218
          <td></td>
 
219
        </tr>
 
220
      </table>
 
221
</div>
 
222
<div class="memdoc">
 
223
 
 
224
<p>Replaces the widget packed into the tooltip with <em>custom_widget</em>. </p>
 
225
<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 .">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>
 
226
<dl class="since_2_12"><dt><b><a class="el" href="since_2_12.html#_since_2_12000087">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
 
227
<dl><dt><b>Parameters:</b></dt><dd>
 
228
  <table class="params">
 
229
    <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>
 
230
  </table>
 
231
  </dd>
 
232
</dl>
 
233
 
 
234
</div>
 
235
</div>
 
236
<a class="anchor" id="a6d6492b6438f3f49887bed5548c7daae"></a><!-- doxytag: member="Gtk::Tooltip::set_icon" ref="a6d6492b6438f3f49887bed5548c7daae" args="(const Glib::RefPtr&lt; Gdk::Pixbuf &gt; &amp;pixbuf)" -->
 
237
<div class="memitem">
 
238
<div class="memproto">
 
239
      <table class="memname">
 
240
        <tr>
 
241
          <td class="memname">void Gtk::Tooltip::set_icon </td>
 
242
          <td>(</td>
 
243
          <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>&lt; <a class="el" href="classGdk_1_1Pixbuf.html">Gdk::Pixbuf</a> &gt;&amp;&#160;</td>
 
244
          <td class="paramname"><em>pixbuf</em></td><td>)</td>
 
245
          <td></td>
 
246
        </tr>
 
247
      </table>
 
248
</div>
 
249
<div class="memdoc">
 
250
 
 
251
<p>Sets the icon of the tooltip (which is in front of the text) to be <em>pixbuf</em>. </p>
 
252
<p>If <em>pixbuf</em> is <code>0</code>, the image will be hidden.</p>
 
253
<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>
 
254
<dl><dt><b>Parameters:</b></dt><dd>
 
255
  <table class="params">
 
256
    <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>
 
257
  </table>
 
258
  </dd>
 
259
</dl>
 
260
 
 
261
</div>
 
262
</div>
 
263
<a class="anchor" id="a7a21f95b91973c59cb748ca53089bd96"></a><!-- doxytag: member="Gtk::Tooltip::set_icon" ref="a7a21f95b91973c59cb748ca53089bd96" args="(const Glib::RefPtr&lt; Gio::Icon &gt; &amp;icon, IconSize size)" -->
 
264
<div class="memitem">
 
265
<div class="memproto">
 
266
      <table class="memname">
 
267
        <tr>
 
268
          <td class="memname">void Gtk::Tooltip::set_icon </td>
 
269
          <td>(</td>
 
270
          <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>&lt; <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> &gt; &amp;&#160;</td>
 
271
          <td class="paramname"><em>icon</em>, </td>
 
272
        </tr>
 
273
        <tr>
 
274
          <td class="paramkey"></td>
 
275
          <td></td>
 
276
          <td class="paramtype"><a class="el" href="classGtk_1_1IconSize.html">IconSize</a>&#160;</td>
 
277
          <td class="paramname"><em>size</em>&#160;</td>
 
278
        </tr>
 
279
        <tr>
 
280
          <td></td>
 
281
          <td>)</td>
 
282
          <td></td><td></td>
 
283
        </tr>
 
284
      </table>
 
285
</div>
 
286
<div class="memdoc">
 
287
 
 
288
<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>
 
289
<p>If <em>gicon</em> is <code>0</code>, the image will be hidden.</p>
 
290
<dl class="since_2_20"><dt><b><a class="el" href="since_2_20.html#_since_2_20000078">Since gtkmm 2.20:</a></b></dt><dd></dd></dl>
 
291
<dl><dt><b>Parameters:</b></dt><dd>
 
292
  <table class="params">
 
293
    <tr><td class="paramname">gicon</td><td>A Icon representing the icon, or <code>0</code>. </td></tr>
 
294
    <tr><td class="paramname">size</td><td>A stock icon size. </td></tr>
 
295
  </table>
 
296
  </dd>
 
297
</dl>
 
298
 
 
299
</div>
 
300
</div>
 
301
<a class="anchor" id="aba2d21de6600dd047836143aaf09b67b"></a><!-- doxytag: member="Gtk::Tooltip::set_icon_from_icon_name" ref="aba2d21de6600dd047836143aaf09b67b" args="(const Glib::ustring &amp;icon_name, IconSize size)" -->
 
302
<div class="memitem">
 
303
<div class="memproto">
 
304
      <table class="memname">
 
305
        <tr>
 
306
          <td class="memname">void Gtk::Tooltip::set_icon_from_icon_name </td>
 
307
          <td>(</td>
 
308
          <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> &amp;&#160;</td>
 
309
          <td class="paramname"><em>icon_name</em>, </td>
 
310
        </tr>
 
311
        <tr>
 
312
          <td class="paramkey"></td>
 
313
          <td></td>
 
314
          <td class="paramtype"><a class="el" href="classGtk_1_1IconSize.html">IconSize</a>&#160;</td>
 
315
          <td class="paramname"><em>size</em>&#160;</td>
 
316
        </tr>
 
317
        <tr>
 
318
          <td></td>
 
319
          <td>)</td>
 
320
          <td></td><td></td>
 
321
        </tr>
 
322
      </table>
 
323
</div>
 
324
<div class="memdoc">
 
325
 
 
326
<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>
 
327
<p>If <em>icon_name</em> is <code>0</code>, the image will be hidden.</p>
 
328
<dl class="since_2_14"><dt><b><a class="el" href="since_2_14.html#_since_2_14000139">Since gtkmm 2.14:</a></b></dt><dd></dd></dl>
 
329
<dl><dt><b>Parameters:</b></dt><dd>
 
330
  <table class="params">
 
331
    <tr><td class="paramname">icon_name</td><td>An icon name, or <code>0</code>. </td></tr>
 
332
    <tr><td class="paramname">size</td><td>A stock icon size. </td></tr>
 
333
  </table>
 
334
  </dd>
 
335
</dl>
 
336
 
 
337
</div>
 
338
</div>
 
339
<a class="anchor" id="a15c00ef935818dbd5b4dc3beffaba03e"></a><!-- doxytag: member="Gtk::Tooltip::set_icon_from_stock" ref="a15c00ef935818dbd5b4dc3beffaba03e" args="(const StockID &amp;stock_id, IconSize size)" -->
 
340
<div class="memitem">
 
341
<div class="memproto">
 
342
      <table class="memname">
 
343
        <tr>
 
344
          <td class="memname">void Gtk::Tooltip::set_icon_from_stock </td>
 
345
          <td>(</td>
 
346
          <td class="paramtype">const <a class="el" href="classGtk_1_1StockID.html">StockID</a>&amp;&#160;</td>
 
347
          <td class="paramname"><em>stock_id</em>, </td>
 
348
        </tr>
 
349
        <tr>
 
350
          <td class="paramkey"></td>
 
351
          <td></td>
 
352
          <td class="paramtype"><a class="el" href="classGtk_1_1IconSize.html">IconSize</a>&#160;</td>
 
353
          <td class="paramname"><em>size</em>&#160;</td>
 
354
        </tr>
 
355
        <tr>
 
356
          <td></td>
 
357
          <td>)</td>
 
358
          <td></td><td></td>
 
359
        </tr>
 
360
      </table>
 
361
</div>
 
362
<div class="memdoc">
 
363
 
 
364
<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>
 
365
<p>If <em>stock_id</em> is <code>0</code>, the image will be hidden.</p>
 
366
<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>
 
367
<dl><dt><b>Parameters:</b></dt><dd>
 
368
  <table class="params">
 
369
    <tr><td class="paramname">stock_id</td><td>A stock id, or <code>0</code>. </td></tr>
 
370
    <tr><td class="paramname">size</td><td>A stock icon size. </td></tr>
 
371
  </table>
 
372
  </dd>
 
373
</dl>
 
374
 
 
375
</div>
 
376
</div>
 
377
<a class="anchor" id="a49e0b6727492955b588399809eba8943"></a><!-- doxytag: member="Gtk::Tooltip::set_markup" ref="a49e0b6727492955b588399809eba8943" args="(const Glib::ustring &amp;markup)" -->
 
378
<div class="memitem">
 
379
<div class="memproto">
 
380
      <table class="memname">
 
381
        <tr>
 
382
          <td class="memname">void Gtk::Tooltip::set_markup </td>
 
383
          <td>(</td>
 
384
          <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> &amp;&#160;</td>
 
385
          <td class="paramname"><em>markup</em></td><td>)</td>
 
386
          <td></td>
 
387
        </tr>
 
388
      </table>
 
389
</div>
 
390
<div class="memdoc">
 
391
 
 
392
<p>Sets the text of the tooltip to be <em>markup</em>, which is marked up with the . </p>
 
393
<p>If <em>markup</em> is <code>0</code>, the label will be hidden.</p>
 
394
<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>
 
395
<dl><dt><b>Parameters:</b></dt><dd>
 
396
  <table class="params">
 
397
    <tr><td class="paramname">markup</td><td>A markup string (see ) or <code>0</code>. </td></tr>
 
398
  </table>
 
399
  </dd>
 
400
</dl>
 
401
 
 
402
</div>
 
403
</div>
 
404
<a class="anchor" id="ab634d7fb4b55207e11ba0897e74121b8"></a><!-- doxytag: member="Gtk::Tooltip::set_text" ref="ab634d7fb4b55207e11ba0897e74121b8" args="(const Glib::ustring &amp;markup)" -->
 
405
<div class="memitem">
 
406
<div class="memproto">
 
407
      <table class="memname">
 
408
        <tr>
 
409
          <td class="memname">void Gtk::Tooltip::set_text </td>
 
410
          <td>(</td>
 
411
          <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> &amp;&#160;</td>
 
412
          <td class="paramname"><em>markup</em></td><td>)</td>
 
413
          <td></td>
 
414
        </tr>
 
415
      </table>
 
416
</div>
 
417
<div class="memdoc">
 
418
 
 
419
<p>Sets the text of the tooltip to be <em>text</em>. </p>
 
420
<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 .">set_markup()</a>.</p>
 
421
<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>
 
422
<dl><dt><b>Parameters:</b></dt><dd>
 
423
  <table class="params">
 
424
    <tr><td class="paramname">text</td><td>A text string or <code>0</code>. </td></tr>
 
425
  </table>
 
426
  </dd>
 
427
</dl>
 
428
 
 
429
</div>
 
430
</div>
 
431
<a class="anchor" id="a197701484426a19f1dee98411e3d3878"></a><!-- doxytag: member="Gtk::Tooltip::set_tip_area" ref="a197701484426a19f1dee98411e3d3878" args="(const Gdk::Rectangle &amp;rect)" -->
 
432
<div class="memitem">
 
433
<div class="memproto">
 
434
      <table class="memname">
 
435
        <tr>
 
436
          <td class="memname">void Gtk::Tooltip::set_tip_area </td>
 
437
          <td>(</td>
 
438
          <td class="paramtype">const <a class="el" href="classGdk_1_1Rectangle.html">Gdk::Rectangle</a>&amp;&#160;</td>
 
439
          <td class="paramname"><em>rect</em></td><td>)</td>
 
440
          <td></td>
 
441
        </tr>
 
442
      </table>
 
443
</div>
 
444
<div class="memdoc">
 
445
 
 
446
<p>Sets the area of the widget, where the contents of this tooltip apply, to be <em>rect</em> (in widget coordinates). </p>
 
447
<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>
 
448
<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>
 
449
<dl class="since_2_12"><dt><b><a class="el" href="since_2_12.html#_since_2_12000088">Since gtkmm 2.12:</a></b></dt><dd></dd></dl>
 
450
<dl><dt><b>Parameters:</b></dt><dd>
 
451
  <table class="params">
 
452
    <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>
 
453
  </table>
 
454
  </dd>
 
455
</dl>
 
456
 
 
457
</div>
 
458
</div>
 
459
<a class="anchor" id="a9e1aac92a4ecf20d602941be5f4c4ac8"></a><!-- doxytag: member="Gtk::Tooltip::trigger_tooltip_query" ref="a9e1aac92a4ecf20d602941be5f4c4ac8" args="(const Glib::RefPtr&lt; Gdk::Display &gt; &amp;display)" -->
 
460
<div class="memitem">
 
461
<div class="memproto">
 
462
      <table class="memname">
 
463
        <tr>
 
464
          <td class="memname">static void Gtk::Tooltip::trigger_tooltip_query </td>
 
465
          <td>(</td>
 
466
          <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>&lt; <a class="el" href="classGdk_1_1Display.html">Gdk::Display</a> &gt;&amp;&#160;</td>
 
467
          <td class="paramname"><em>display</em></td><td>)</td>
 
468
          <td><code> [static]</code></td>
 
469
        </tr>
 
470
      </table>
 
471
</div>
 
472
<div class="memdoc">
 
473
 
 
474
</div>
 
475
</div>
 
476
<hr/><h2>Friends And Related Function Documentation</h2>
 
477
<a class="anchor" id="a7bf26ebe7007a80738146ccee0f3a0c6"></a><!-- doxytag: member="Gtk::Tooltip::wrap" ref="a7bf26ebe7007a80738146ccee0f3a0c6" args="(GtkTooltip *object, bool take_copy=false)" -->
 
478
<div class="memitem">
 
479
<div class="memproto">
 
480
      <table class="memname">
 
481
        <tr>
 
482
          <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>&lt; <a class="el" href="classGtk_1_1Tooltip.html">Gtk::Tooltip</a> &gt; wrap </td>
 
483
          <td>(</td>
 
484
          <td class="paramtype">GtkTooltip *&#160;</td>
 
485
          <td class="paramname"><em>object</em>, </td>
 
486
        </tr>
 
487
        <tr>
 
488
          <td class="paramkey"></td>
 
489
          <td></td>
 
490
          <td class="paramtype">bool&#160;</td>
 
491
          <td class="paramname"><em>take_copy</em> = <code>false</code>&#160;</td>
 
492
        </tr>
 
493
        <tr>
 
494
          <td></td>
 
495
          <td>)</td>
 
496
          <td></td><td><code> [related]</code></td>
 
497
        </tr>
 
498
      </table>
 
499
</div>
 
500
<div class="memdoc">
 
501
 
 
502
<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>
 
503
<dl><dt><b>Parameters:</b></dt><dd>
 
504
  <table class="params">
 
505
    <tr><td class="paramname">object</td><td>The C instance. </td></tr>
 
506
    <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>
 
507
  </table>
 
508
  </dd>
 
509
</dl>
 
510
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
 
511
 
 
512
</div>
 
513
</div>
 
514
<hr/>The documentation for this class was generated from the following file:<ul>
 
515
<li>gtkmm/tooltip.h</li>
 
516
</ul>
 
517
</div>
 
518
<hr class="footer"/><address class="footer"><small>Generated on Mon May 9 2011 10:20:11 for gtkmm by&#160;
 
519
<a href="http://www.doxygen.org/index.html">
 
520
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
 
521
</body>
 
522
</html>