~ubuntu-branches/debian/experimental/gtk+2.0/experimental

« back to all changes in this revision

Viewing changes to docs/reference/gtk/html/GtkTooltip.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2007-09-17 11:15:05 UTC
  • mto: (72.1.1 lenny) (1.4.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 55.
  • Revision ID: james.westby@ubuntu.com-20070917111505-giz9c5xltxkb5y54
Tags: upstream-2.12.0
ImportĀ upstreamĀ versionĀ 2.12.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>GtkTooltip</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
7
<link rel="start" href="index.html" title="GTK+ Reference Manual">
8
8
<link rel="up" href="MiscObjects.html" title="Miscellaneous">
9
9
<link rel="prev" href="GtkSizeGroup.html" title="GtkSizeGroup">
10
10
<link rel="next" href="GtkViewport.html" title="GtkViewport">
11
 
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="gtk.html" title="Part&#160;I.&#160;GTK+ Overview">
14
14
<link rel="part" href="gtkbase.html" title="Part&#160;II.&#160;GTK+ Core Reference">
68
68
<th width="100%" align="center">GTK+ Reference Manual</th>
69
69
<td><a accesskey="n" href="GtkViewport.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
70
70
</tr>
71
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id4069997" class="shortcut">Top</a>
72
 
                  &#160;|&#160;
73
 
                  <a href="#id4070259" class="shortcut">Description</a>
74
 
                  &#160;|&#160;
75
 
                  <a href="#id4070234" class="shortcut">Object Hierarchy</a></nobr></td></tr>
 
71
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id3825464" class="shortcut">Top</a>
 
72
                  &#160;|&#160;
 
73
                  <a href="#id3825725" class="shortcut">Description</a>
 
74
                  &#160;|&#160;
 
75
                  <a href="#id3825700" class="shortcut">Object Hierarchy</a></nobr></td></tr>
76
76
</table>
77
77
<div class="refentry" lang="en">
78
78
<a name="GtkTooltip"></a><div class="titlepage"></div>
79
79
<div class="refnamediv"><table width="100%"><tr>
80
80
<td valign="top">
81
81
<h2>
82
 
<a name="id4069997"></a><span class="refentrytitle">GtkTooltip</span>
 
82
<a name="id3825464"></a><span class="refentrytitle">GtkTooltip</span>
83
83
</h2>
84
84
<p>GtkTooltip &#8212; Add tips to your widgets</p>
85
85
</td>
92
92
#include &lt;gtk/gtk.h&gt;
93
93
 
94
94
 
95
 
                    <a href="GtkTooltip.html#GtkTooltip-struct">GtkTooltip</a>;
96
 
void                <a href="GtkTooltip.html#gtk-tooltip-set-markup">gtk_tooltip_set_markup</a>              (<a href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip,
 
95
                    <a class="link" href="GtkTooltip.html#GtkTooltip-struct">GtkTooltip</a>;
 
96
void                <a class="link" href="GtkTooltip.html#gtk-tooltip-set-markup">gtk_tooltip_set_markup</a>              (<a class="link" href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip,
97
97
                                                         const <a
98
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
98
href="../glib/glib-Basic-Types.html#gchar"
99
99
>gchar</a> *markup);
100
 
void                <a href="GtkTooltip.html#gtk-tooltip-set-text">gtk_tooltip_set_text</a>                (<a href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip,
 
100
void                <a class="link" href="GtkTooltip.html#gtk-tooltip-set-text">gtk_tooltip_set_text</a>                (<a class="link" href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip,
101
101
                                                         const <a
102
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
102
href="../glib/glib-Basic-Types.html#gchar"
103
103
>gchar</a> *text);
104
 
void                <a href="GtkTooltip.html#gtk-tooltip-set-icon">gtk_tooltip_set_icon</a>                (<a href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip,
 
104
void                <a class="link" href="GtkTooltip.html#gtk-tooltip-set-icon">gtk_tooltip_set_icon</a>                (<a class="link" href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip,
105
105
                                                         <a
106
106
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
107
107
>GdkPixbuf</a> *pixbuf);
108
 
void                <a href="GtkTooltip.html#gtk-tooltip-set-icon-from-stock">gtk_tooltip_set_icon_from_stock</a>     (<a href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip,
 
108
void                <a class="link" href="GtkTooltip.html#gtk-tooltip-set-icon-from-stock">gtk_tooltip_set_icon_from_stock</a>     (<a class="link" href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip,
109
109
                                                         const <a
110
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
110
href="../glib/glib-Basic-Types.html#gchar"
111
111
>gchar</a> *stock_id,
112
 
                                                         <a href="gtk-Themeable-Stock-Images.html#GtkIconSize">GtkIconSize</a> size);
113
 
void                <a href="GtkTooltip.html#gtk-tooltip-set-custom">gtk_tooltip_set_custom</a>              (<a href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip,
114
 
                                                         <a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *custom_widget);
115
 
void                <a href="GtkTooltip.html#gtk-tooltip-trigger-tooltip-query">gtk_tooltip_trigger_tooltip_query</a>   (<a
 
112
                                                         <a class="link" href="gtk-Themeable-Stock-Images.html#GtkIconSize">GtkIconSize</a> size);
 
113
void                <a class="link" href="GtkTooltip.html#gtk-tooltip-set-custom">gtk_tooltip_set_custom</a>              (<a class="link" href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip,
 
114
                                                         <a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *custom_widget);
 
115
void                <a class="link" href="GtkTooltip.html#gtk-tooltip-trigger-tooltip-query">gtk_tooltip_trigger_tooltip_query</a>   (<a
116
116
href="../gdk/GdkDisplay.html"
117
117
>GdkDisplay</a> *display);
118
 
void                <a href="GtkTooltip.html#gtk-tooltip-set-tip-area">gtk_tooltip_set_tip_area</a>            (<a href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip,
 
118
void                <a class="link" href="GtkTooltip.html#gtk-tooltip-set-tip-area">gtk_tooltip_set_tip_area</a>            (<a class="link" href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip,
119
119
                                                         <a
120
120
href="../gdk/gdk-Points-Rectangles-and-Regions.html#GdkRectangle"
121
121
>GdkRectangle</a> *rect);
124
124
</pre>
125
125
</div>
126
126
<div class="refsect1" lang="en">
127
 
<a name="id4070234"></a><h2>Object Hierarchy</h2>
 
127
<a name="id3825700"></a><h2>Object Hierarchy</h2>
128
128
<pre class="synopsis">
129
129
 
130
130
  <a
131
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
 
131
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
132
132
>GObject</a>
133
133
   +----GtkTooltip
134
134
</pre>
135
135
</div>
136
136
<div class="refsect1" lang="en">
137
 
<a name="id4070259"></a><h2>Description</h2>
 
137
<a name="id3825725"></a><h2>Description</h2>
138
138
<p>
139
 
<a href="GtkTooltip.html" title="GtkTooltip"><span class="type">GtkTooltip</span></a> belongs to the new tooltips API that was
 
139
<a class="link" href="GtkTooltip.html" title="GtkTooltip"><span class="type">GtkTooltip</span></a> belongs to the new tooltips API that was
140
140
introduced in GTK+ 2.12 and which deprecates the old
141
 
<a href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> API. 
 
141
<a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> API. 
142
142
</p>
143
143
<p>
144
 
Basic tooltips can be realized simply by using <a href="GtkWidget.html#gtk-widget-set-tooltip-text"><code class="function">gtk_widget_set_tooltip_text()</code></a>
145
 
or <a href="GtkWidget.html#gtk-widget-set-tooltip-markup"><code class="function">gtk_widget_set_tooltip_markup()</code></a> without any explicit tooltip object. 
 
144
Basic tooltips can be realized simply by using <a class="link" href="GtkWidget.html#gtk-widget-set-tooltip-text"><code class="function">gtk_widget_set_tooltip_text()</code></a>
 
145
or <a class="link" href="GtkWidget.html#gtk-widget-set-tooltip-markup"><code class="function">gtk_widget_set_tooltip_markup()</code></a> without any explicit tooltip object. 
146
146
</p>
147
147
<p>
148
148
When you need a tooltip with a little more fancy contents, like
151
151
</p>
152
152
<div class="itemizedlist"><ul type="disc">
153
153
<li><p>
154
 
Set the <a href="GtkWidget.html#GtkWidget--has-tooltip"><span class="type">:has-tooltip</span></a> property to <a
155
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
154
Set the <a class="link" href="GtkWidget.html#GtkWidget--has-tooltip"><span class="type">"has-tooltip"</span></a> property to <a
 
155
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
156
156
><code class="literal">TRUE</code></a>, this will
157
157
make GTK+ monitor the widget for motion and related events
158
158
which are needed to determine when and where to show a tooltip.
159
159
</p></li>
160
160
<li><p>
161
 
Connect to the <a href="GtkWidget.html#GtkWidget-query-tooltip"><span class="type">::query-tooltip</span></a> signal.  This signal
 
161
Connect to the <a class="link" href="GtkWidget.html#GtkWidget-query-tooltip"><span class="type">"query-tooltip"</span></a> signal.  This signal
162
162
will be emitted when a tooltip is supposed to be shown. One
163
 
of the arguments passed to the signal handler is a <a href="GtkTooltip.html" title="GtkTooltip"><span class="type">GtkTooltip</span></a>
 
163
of the arguments passed to the signal handler is a <a class="link" href="GtkTooltip.html" title="GtkTooltip"><span class="type">GtkTooltip</span></a>
164
164
object. This is the object that we are about to display as a 
165
165
tooltip, and can be manipulated in your callback using functions
166
 
like <a href="GtkTooltip.html#gtk-tooltip-set-icon"><code class="function">gtk_tooltip_set_icon()</code></a>. There are functions for setting
 
166
like <a class="link" href="GtkTooltip.html#gtk-tooltip-set-icon"><code class="function">gtk_tooltip_set_icon()</code></a>. There are functions for setting
167
167
the tooltip's markup, setting an image from a stock icon, or
168
168
even putting in a custom widget.
169
169
</p></li>
170
170
<li><p>
171
171
Return <a
172
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
172
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
173
173
><code class="literal">TRUE</code></a> from your query-tooltip handler. This causes
174
174
the tooltip to be show. If you return <a
175
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
 
175
href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
176
176
><code class="literal">FALSE</code></a>, it will not be shown. 
177
177
</p></li>
178
178
</ul></div>
181
181
<p>
182
182
In the probably rare case where you want to have even more control
183
183
over the tooltip that is about to be shown, you can set your own
184
 
<a href="GtkWindow.html" title="GtkWindow"><span class="type">GtkWindow</span></a> which will be used as tooltip window.  This works as
 
184
<a class="link" href="GtkWindow.html" title="GtkWindow"><span class="type">GtkWindow</span></a> which will be used as tooltip window.  This works as
185
185
follows:
186
186
</p>
187
187
<div class="itemizedlist"><ul type="disc">
188
188
<li><p>
189
 
Set <a href="GtkWidget.html#GtkWidget--has-tooltip"><span class="type">:has-tooltip</span></a> and connect to <a href="GtkWidget.html#GtkWidget-query-tooltip"><span class="type">::query-tooltip</span></a> as 
 
189
Set <a class="link" href="GtkWidget.html#GtkWidget--has-tooltip"><span class="type">"has-tooltip"</span></a> and connect to <a class="link" href="GtkWidget.html#GtkWidget-query-tooltip"><span class="type">"query-tooltip"</span></a> as 
190
190
before.
191
191
</p></li>
192
192
<li><p>
193
 
Use <a href="GtkWidget.html#gtk-widget-set-tooltip-window"><code class="function">gtk_widget_set_tooltip_window()</code></a> to set a <a href="GtkWindow.html" title="GtkWindow"><span class="type">GtkWindow</span></a> created
 
193
Use <a class="link" href="GtkWidget.html#gtk-widget-set-tooltip-window"><code class="function">gtk_widget_set_tooltip_window()</code></a> to set a <a class="link" href="GtkWindow.html" title="GtkWindow"><span class="type">GtkWindow</span></a> created
194
194
by you as tooltip window.
195
195
</p></li>
196
196
<li><p>
197
197
In the ::query-tooltip callback you can access your window
198
 
using <a href="GtkWidget.html#gtk-widget-get-tooltip-window"><code class="function">gtk_widget_get_tooltip_window()</code></a> and manipulate as you
 
198
using <a class="link" href="GtkWidget.html#gtk-widget-get-tooltip-window"><code class="function">gtk_widget_get_tooltip_window()</code></a> and manipulate as you
199
199
wish. The semantics of the return value are exactly as before,
200
200
return <a
201
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
 
201
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
202
202
><code class="literal">TRUE</code></a> to show the window, <a
203
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
 
203
href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
204
204
><code class="literal">FALSE</code></a> to not show it.
205
205
</p></li>
206
206
</ul></div>
208
208
</p>
209
209
</div>
210
210
<div class="refsect1" lang="en">
211
 
<a name="id4070527"></a><h2>Details</h2>
 
211
<a name="id3825993"></a><h2>Details</h2>
212
212
<div class="refsect2" lang="en">
213
 
<a name="id4070537"></a><h3>
 
213
<a name="id3826003"></a><h3>
214
214
<a name="GtkTooltip-struct"></a>GtkTooltip</h3>
215
 
<a class="indexterm" name="id4070550"></a><pre class="programlisting">typedef struct _GtkTooltip GtkTooltip;</pre>
 
215
<a class="indexterm" name="id3826017"></a><pre class="programlisting">typedef struct _GtkTooltip GtkTooltip;</pre>
216
216
<p>
217
217
 
218
218
</p>
219
219
</div>
220
220
<hr>
221
221
<div class="refsect2" lang="en">
222
 
<a name="id4070565"></a><h3>
 
222
<a name="id3826032"></a><h3>
223
223
<a name="gtk-tooltip-set-markup"></a>gtk_tooltip_set_markup ()</h3>
224
 
<a class="indexterm" name="id4070581"></a><pre class="programlisting">void                gtk_tooltip_set_markup              (<a href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip,
 
224
<a class="indexterm" name="id3826047"></a><pre class="programlisting">void                gtk_tooltip_set_markup              (<a class="link" href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip,
225
225
                                                         const <a
226
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
226
href="../glib/glib-Basic-Types.html#gchar"
227
227
>gchar</a> *markup);</pre>
228
228
<p>
229
229
Sets the text of the tooltip to be <em class="parameter"><code>markup</code></em>, which is marked up
230
230
with the Pango text markup language.
231
231
If <em class="parameter"><code>markup</code></em> is <a
232
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
232
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
233
233
><code class="literal">NULL</code></a>, the label will be hidden.</p>
234
234
<p>
235
235
 
238
238
<col align="left" valign="top">
239
239
<tbody>
240
240
<tr>
241
 
<td><span class="term"><em class="parameter"><code>tooltip</code></em>&#160;:</span></td>
242
 
<td> a <a href="GtkTooltip.html" title="GtkTooltip"><span class="type">GtkTooltip</span></a>
 
241
<td><p><span class="term"><em class="parameter"><code>tooltip</code></em>&#160;:</span></p></td>
 
242
<td> a <a class="link" href="GtkTooltip.html" title="GtkTooltip"><span class="type">GtkTooltip</span></a>
243
243
</td>
244
244
</tr>
245
245
<tr>
246
 
<td><span class="term"><em class="parameter"><code>markup</code></em>&#160;:</span></td>
 
246
<td><p><span class="term"><em class="parameter"><code>markup</code></em>&#160;:</span></p></td>
247
247
<td> a markup string (see Pango markup format) or <a
248
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
248
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
249
249
><code class="literal">NULL</code></a>
250
250
</td>
251
251
</tr>
256
256
</div>
257
257
<hr>
258
258
<div class="refsect2" lang="en">
259
 
<a name="id4070716"></a><h3>
 
259
<a name="id3826182"></a><h3>
260
260
<a name="gtk-tooltip-set-text"></a>gtk_tooltip_set_text ()</h3>
261
 
<a class="indexterm" name="id4070731"></a><pre class="programlisting">void                gtk_tooltip_set_text                (<a href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip,
 
261
<a class="indexterm" name="id3826198"></a><pre class="programlisting">void                gtk_tooltip_set_text                (<a class="link" href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip,
262
262
                                                         const <a
263
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
263
href="../glib/glib-Basic-Types.html#gchar"
264
264
>gchar</a> *text);</pre>
265
265
<p>
266
266
Sets the text of the tooltip to be <em class="parameter"><code>text</code></em>. If <em class="parameter"><code>text</code></em> is <a
267
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
267
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
268
268
><code class="literal">NULL</code></a>, the label
269
 
will be hidden. See also <a href="GtkTooltip.html#gtk-tooltip-set-markup"><code class="function">gtk_tooltip_set_markup()</code></a>.</p>
 
269
will be hidden. See also <a class="link" href="GtkTooltip.html#gtk-tooltip-set-markup"><code class="function">gtk_tooltip_set_markup()</code></a>.</p>
270
270
<p>
271
271
 
272
272
</p>
274
274
<col align="left" valign="top">
275
275
<tbody>
276
276
<tr>
277
 
<td><span class="term"><em class="parameter"><code>tooltip</code></em>&#160;:</span></td>
278
 
<td> a <a href="GtkTooltip.html" title="GtkTooltip"><span class="type">GtkTooltip</span></a>
 
277
<td><p><span class="term"><em class="parameter"><code>tooltip</code></em>&#160;:</span></p></td>
 
278
<td> a <a class="link" href="GtkTooltip.html" title="GtkTooltip"><span class="type">GtkTooltip</span></a>
279
279
</td>
280
280
</tr>
281
281
<tr>
282
 
<td><span class="term"><em class="parameter"><code>text</code></em>&#160;:</span></td>
 
282
<td><p><span class="term"><em class="parameter"><code>text</code></em>&#160;:</span></p></td>
283
283
<td> a text string or <a
284
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
284
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
285
285
><code class="literal">NULL</code></a>
286
286
</td>
287
287
</tr>
292
292
</div>
293
293
<hr>
294
294
<div class="refsect2" lang="en">
295
 
<a name="id4070862"></a><h3>
 
295
<a name="id3826328"></a><h3>
296
296
<a name="gtk-tooltip-set-icon"></a>gtk_tooltip_set_icon ()</h3>
297
 
<a class="indexterm" name="id4070877"></a><pre class="programlisting">void                gtk_tooltip_set_icon                (<a href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip,
 
297
<a class="indexterm" name="id3826344"></a><pre class="programlisting">void                gtk_tooltip_set_icon                (<a class="link" href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip,
298
298
                                                         <a
299
299
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
300
300
>GdkPixbuf</a> *pixbuf);</pre>
301
301
<p>
302
302
Sets the icon of the tooltip (which is in front of the text) to be
303
303
<em class="parameter"><code>pixbuf</code></em>.  If <em class="parameter"><code>pixbuf</code></em> is <a
304
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
304
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
305
305
><code class="literal">NULL</code></a>, the image will be hidden.</p>
306
306
<p>
307
307
 
310
310
<col align="left" valign="top">
311
311
<tbody>
312
312
<tr>
313
 
<td><span class="term"><em class="parameter"><code>tooltip</code></em>&#160;:</span></td>
314
 
<td> a <a href="GtkTooltip.html" title="GtkTooltip"><span class="type">GtkTooltip</span></a>
 
313
<td><p><span class="term"><em class="parameter"><code>tooltip</code></em>&#160;:</span></p></td>
 
314
<td> a <a class="link" href="GtkTooltip.html" title="GtkTooltip"><span class="type">GtkTooltip</span></a>
315
315
</td>
316
316
</tr>
317
317
<tr>
318
 
<td><span class="term"><em class="parameter"><code>pixbuf</code></em>&#160;:</span></td>
 
318
<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em>&#160;:</span></p></td>
319
319
<td> a <a
320
320
href="../gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"
321
321
><span class="type">GdkPixbuf</span></a>, or <a
322
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
322
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
323
323
><code class="literal">NULL</code></a>
324
324
</td>
325
325
</tr>
330
330
</div>
331
331
<hr>
332
332
<div class="refsect2" lang="en">
333
 
<a name="id4071005"></a><h3>
 
333
<a name="id3826471"></a><h3>
334
334
<a name="gtk-tooltip-set-icon-from-stock"></a>gtk_tooltip_set_icon_from_stock ()</h3>
335
 
<a class="indexterm" name="id4071021"></a><pre class="programlisting">void                gtk_tooltip_set_icon_from_stock     (<a href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip,
 
335
<a class="indexterm" name="id3826487"></a><pre class="programlisting">void                gtk_tooltip_set_icon_from_stock     (<a class="link" href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip,
336
336
                                                         const <a
337
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
 
337
href="../glib/glib-Basic-Types.html#gchar"
338
338
>gchar</a> *stock_id,
339
 
                                                         <a href="gtk-Themeable-Stock-Images.html#GtkIconSize">GtkIconSize</a> size);</pre>
 
339
                                                         <a class="link" href="gtk-Themeable-Stock-Images.html#GtkIconSize">GtkIconSize</a> size);</pre>
340
340
<p>
341
341
Sets the icon of the tooltip (which is in front of the text) to be
342
342
the stock item indicated by <em class="parameter"><code>stock_id</code></em> with the size indicated
343
343
by <em class="parameter"><code>size</code></em>.  If <em class="parameter"><code>stock_id</code></em> is <a
344
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
344
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
345
345
><code class="literal">NULL</code></a>, the image will be hidden.</p>
346
346
<p>
347
347
 
350
350
<col align="left" valign="top">
351
351
<tbody>
352
352
<tr>
353
 
<td><span class="term"><em class="parameter"><code>tooltip</code></em>&#160;:</span></td>
354
 
<td> a <a href="GtkTooltip.html" title="GtkTooltip"><span class="type">GtkTooltip</span></a>
 
353
<td><p><span class="term"><em class="parameter"><code>tooltip</code></em>&#160;:</span></p></td>
 
354
<td> a <a class="link" href="GtkTooltip.html" title="GtkTooltip"><span class="type">GtkTooltip</span></a>
355
355
</td>
356
356
</tr>
357
357
<tr>
358
 
<td><span class="term"><em class="parameter"><code>stock_id</code></em>&#160;:</span></td>
 
358
<td><p><span class="term"><em class="parameter"><code>stock_id</code></em>&#160;:</span></p></td>
359
359
<td> a stock icon name, or <a
360
 
href="/home/mclasen/gnome-2.18/install/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
360
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
361
361
><code class="literal">NULL</code></a>
362
362
</td>
363
363
</tr>
364
364
<tr>
365
 
<td><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
 
365
<td><p><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></p></td>
366
366
<td> a stock icon size
367
367
</td>
368
368
</tr>
373
373
</div>
374
374
<hr>
375
375
<div class="refsect2" lang="en">
376
 
<a name="id4071170"></a><h3>
 
376
<a name="id3826636"></a><h3>
377
377
<a name="gtk-tooltip-set-custom"></a>gtk_tooltip_set_custom ()</h3>
378
 
<a class="indexterm" name="id4071185"></a><pre class="programlisting">void                gtk_tooltip_set_custom              (<a href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip,
379
 
                                                         <a href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *custom_widget);</pre>
 
378
<a class="indexterm" name="id3826652"></a><pre class="programlisting">void                gtk_tooltip_set_custom              (<a class="link" href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip,
 
379
                                                         <a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a> *custom_widget);</pre>
380
380
<p>
381
381
Replaces the widget packed into the tooltip with <em class="parameter"><code>custom_widget</code></em>.  
382
 
By default a box with a <a href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> and <a href="GtkLabel.html" title="GtkLabel"><span class="type">GtkLabel</span></a> is embedded in 
383
 
the tooltip, which can be configured using <a href="GtkTooltip.html#gtk-tooltip-set-markup"><code class="function">gtk_tooltip_set_markup()</code></a> 
384
 
and <a href="GtkTooltip.html#gtk-tooltip-set-icon"><code class="function">gtk_tooltip_set_icon()</code></a>.</p>
 
382
By default a box with a <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> and <a class="link" href="GtkLabel.html" title="GtkLabel"><span class="type">GtkLabel</span></a> is embedded in 
 
383
the tooltip, which can be configured using <a class="link" href="GtkTooltip.html#gtk-tooltip-set-markup"><code class="function">gtk_tooltip_set_markup()</code></a> 
 
384
and <a class="link" href="GtkTooltip.html#gtk-tooltip-set-icon"><code class="function">gtk_tooltip_set_icon()</code></a>.</p>
385
385
<p>
386
386
 
387
387
</p>
389
389
<col align="left" valign="top">
390
390
<tbody>
391
391
<tr>
392
 
<td><span class="term"><em class="parameter"><code>tooltip</code></em>&#160;:</span></td>
393
 
<td> a <a href="GtkTooltip.html" title="GtkTooltip"><span class="type">GtkTooltip</span></a>
 
392
<td><p><span class="term"><em class="parameter"><code>tooltip</code></em>&#160;:</span></p></td>
 
393
<td> a <a class="link" href="GtkTooltip.html" title="GtkTooltip"><span class="type">GtkTooltip</span></a>
394
394
</td>
395
395
</tr>
396
396
<tr>
397
 
<td><span class="term"><em class="parameter"><code>custom_widget</code></em>&#160;:</span></td>
398
 
<td> a <a href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>
 
397
<td><p><span class="term"><em class="parameter"><code>custom_widget</code></em>&#160;:</span></p></td>
 
398
<td> a <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>
399
399
</td>
400
400
</tr>
401
401
</tbody>
405
405
</div>
406
406
<hr>
407
407
<div class="refsect2" lang="en">
408
 
<a name="id4071325"></a><h3>
 
408
<a name="id3826792"></a><h3>
409
409
<a name="gtk-tooltip-trigger-tooltip-query"></a>gtk_tooltip_trigger_tooltip_query ()</h3>
410
 
<a class="indexterm" name="id4071342"></a><pre class="programlisting">void                gtk_tooltip_trigger_tooltip_query   (<a
 
410
<a class="indexterm" name="id3826809"></a><pre class="programlisting">void                gtk_tooltip_trigger_tooltip_query   (<a
411
411
href="../gdk/GdkDisplay.html"
412
412
>GdkDisplay</a> *display);</pre>
413
413
<p>
421
421
<div class="variablelist"><table border="0">
422
422
<col align="left" valign="top">
423
423
<tbody><tr>
424
 
<td><span class="term"><em class="parameter"><code>display</code></em>&#160;:</span></td>
 
424
<td><p><span class="term"><em class="parameter"><code>display</code></em>&#160;:</span></p></td>
425
425
<td> a <a
426
426
href="../gdk/GdkDisplay.html"
427
427
><span class="type">GdkDisplay</span></a>
433
433
</div>
434
434
<hr>
435
435
<div class="refsect2" lang="en">
436
 
<a name="id4071416"></a><h3>
 
436
<a name="id3826882"></a><h3>
437
437
<a name="gtk-tooltip-set-tip-area"></a>gtk_tooltip_set_tip_area ()</h3>
438
 
<a class="indexterm" name="id4071431"></a><pre class="programlisting">void                gtk_tooltip_set_tip_area            (<a href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip,
 
438
<a class="indexterm" name="id3826898"></a><pre class="programlisting">void                gtk_tooltip_set_tip_area            (<a class="link" href="GtkTooltip.html" title="GtkTooltip">GtkTooltip</a> *tooltip,
439
439
                                                         <a
440
440
href="../gdk/gdk-Points-Rectangles-and-Regions.html#GdkRectangle"
441
441
>GdkRectangle</a> *rect);</pre>
442
442
<p>
443
443
Sets the area of the widget, where the contents of this tooltip apply,
444
444
to be <em class="parameter"><code>rect</code></em> (in widget coordinates).  This is especially useful for
445
 
properly setting tooltips on <a href="GtkTreeView.html" title="GtkTreeView"><span class="type">GtkTreeView</span></a> rows and cells, <span class="type">GtkIconViews</span>,
 
445
properly setting tooltips on <a class="link" href="GtkTreeView.html" title="GtkTreeView"><span class="type">GtkTreeView</span></a> rows and cells, <span class="type">GtkIconViews</span>,
446
446
etc.
447
447
</p>
448
448
<p>
449
 
For setting tooltips on <a href="GtkTreeView.html" title="GtkTreeView"><span class="type">GtkTreeView</span></a>, please refer to the convenience
450
 
functions for this: <a href="GtkTreeView.html#gtk-tree-view-set-tooltip-row"><code class="function">gtk_tree_view_set_tooltip_row()</code></a> and
451
 
<a href="GtkTreeView.html#gtk-tree-view-set-tooltip-cell"><code class="function">gtk_tree_view_set_tooltip_cell()</code></a>.</p>
 
449
For setting tooltips on <a class="link" href="GtkTreeView.html" title="GtkTreeView"><span class="type">GtkTreeView</span></a>, please refer to the convenience
 
450
functions for this: <a class="link" href="GtkTreeView.html#gtk-tree-view-set-tooltip-row"><code class="function">gtk_tree_view_set_tooltip_row()</code></a> and
 
451
<a class="link" href="GtkTreeView.html#gtk-tree-view-set-tooltip-cell"><code class="function">gtk_tree_view_set_tooltip_cell()</code></a>.</p>
452
452
<p>
453
453
 
454
454
</p>
456
456
<col align="left" valign="top">
457
457
<tbody>
458
458
<tr>
459
 
<td><span class="term"><em class="parameter"><code>tooltip</code></em>&#160;:</span></td>
460
 
<td> a <a href="GtkTooltip.html" title="GtkTooltip"><span class="type">GtkTooltip</span></a>
 
459
<td><p><span class="term"><em class="parameter"><code>tooltip</code></em>&#160;:</span></p></td>
 
460
<td> a <a class="link" href="GtkTooltip.html" title="GtkTooltip"><span class="type">GtkTooltip</span></a>
461
461
</td>
462
462
</tr>
463
463
<tr>
464
 
<td><span class="term"><em class="parameter"><code>rect</code></em>&#160;:</span></td>
 
464
<td><p><span class="term"><em class="parameter"><code>rect</code></em>&#160;:</span></p></td>
465
465
<td> a <a
466
466
href="../gdk/gdk-Points-Rectangles-and-Regions.html#GdkRectangle"
467
467
><span class="type">GdkRectangle</span></a>
473
473
</p>
474
474
</div>
475
475
</div>
 
476
<div class="refsect1" lang="en">
 
477
<a name="id3827055"></a><div class="refsect2" lang="en"><a name="id3827056"></a></div>
 
478
<hr>
 
479
<div class="refsect2" lang="en"><a name="id3827057"></a></div>
 
480
</div>
476
481
</div>
477
482
</body>
478
483
</html>