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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkTooltips: GTK+ 2 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GTK+ 2 Reference Manual">
<link rel="up" href="DeprecatedObjects.html" title="Deprecated">
<link rel="prev" href="GtkText.html" title="GtkText">
<link rel="next" href="GtkTipsQuery.html" title="GtkTipsQuery">
<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#GtkTooltips.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GtkTooltips.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="DeprecatedObjects.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkText.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkTipsQuery.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkTooltips"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkTooltips.top_of_page"></a>GtkTooltips</span></h2>
<p>GtkTooltips</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkTooltips.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="returnvalue">GtkTooltips</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkTooltips.html#gtk-tooltips-new" title="gtk_tooltips_new ()">gtk_tooltips_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkTooltips.html#gtk-tooltips-enable" title="gtk_tooltips_enable ()">gtk_tooltips_enable</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkTooltips.html#gtk-tooltips-disable" title="gtk_tooltips_disable ()">gtk_tooltips_disable</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkTooltips.html#gtk-tooltips-set-delay" title="gtk_tooltips_set_delay ()">gtk_tooltips_set_delay</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkTooltips.html#gtk-tooltips-set-tip" title="gtk_tooltips_set_tip ()">gtk_tooltips_set_tip</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GtkTooltips.html#GtkTooltipsData" title="struct GtkTooltipsData"><span class="returnvalue">GtkTooltipsData</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkTooltips.html#gtk-tooltips-data-get" title="gtk_tooltips_data_get ()">gtk_tooltips_data_get</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkTooltips.html#gtk-tooltips-force-window" title="gtk_tooltips_force_window ()">gtk_tooltips_force_window</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="GtkTooltips.html#gtk-tooltips-get-info-from-tip-window" title="gtk_tooltips_get_info_from_tip_window ()">gtk_tooltips_get_info_from_tip_window</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkTooltips.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkTooltips.html#GtkTooltips-struct" title="struct GtkTooltips">GtkTooltips</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkTooltips.html#GtkTooltipsData" title="struct GtkTooltipsData">GtkTooltipsData</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkTooltips.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> <a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
<span class="lineart">╰──</span> GtkTooltips
</pre>
</div>
<div class="refsect1">
<a name="GtkTooltips.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <gtk/gtk.h>
</pre>
</div>
<div class="refsect1">
<a name="GtkTooltips.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="GtkTooltips.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-tooltips-new"></a><h3>gtk_tooltips_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="returnvalue">GtkTooltips</span></a> *
gtk_tooltips_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning"><p><code class="literal">gtk_tooltips_new</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-tooltips-enable"></a><h3>gtk_tooltips_enable ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_tooltips_enable (<em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> *tooltips</code></em>);</pre>
<div class="warning"><p><code class="literal">gtk_tooltips_enable</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-tooltips-disable"></a><h3>gtk_tooltips_disable ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_tooltips_disable (<em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> *tooltips</code></em>);</pre>
<div class="warning"><p><code class="literal">gtk_tooltips_disable</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-tooltips-set-delay"></a><h3>gtk_tooltips_set_delay ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_tooltips_set_delay (<em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> *tooltips</code></em>,
<em class="parameter"><code><span class="type">guint</span> delay</code></em>);</pre>
<div class="warning"><p><code class="literal">gtk_tooltips_set_delay</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-tooltips-set-tip"></a><h3>gtk_tooltips_set_tip ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_tooltips_set_tip (<em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> *tooltips</code></em>,
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *tip_text</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *tip_private</code></em>);</pre>
<div class="warning"><p><code class="literal">gtk_tooltips_set_tip</code> has been deprecated since version 2.12 and should not be used in newly-written code.</p></div>
<p>Adds a tooltip containing the message <em class="parameter"><code>tip_text</code></em>
to the specified <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>.</p>
<div class="refsect3">
<a name="gtk-tooltips-set-tip.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>tooltips</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>widget</p></td>
<td class="parameter_description"><p>the <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> you wish to associate the tip with.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tip_text</p></td>
<td class="parameter_description"><p>a string containing the tip itself. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>tip_private</p></td>
<td class="parameter_description"><p>a string of any further information that may be useful if the user gets stuck. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-tooltips-data-get"></a><h3>gtk_tooltips_data_get ()</h3>
<pre class="programlisting"><a class="link" href="GtkTooltips.html#GtkTooltipsData" title="struct GtkTooltipsData"><span class="returnvalue">GtkTooltipsData</span></a> *
gtk_tooltips_data_get (<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>);</pre>
<div class="warning"><p><code class="literal">gtk_tooltips_data_get</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-tooltips-force-window"></a><h3>gtk_tooltips_force_window ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_tooltips_force_window (<em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> *tooltips</code></em>);</pre>
<div class="warning"><p><code class="literal">gtk_tooltips_force_window</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-tooltips-get-info-from-tip-window"></a><h3>gtk_tooltips_get_info_from_tip_window ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
gtk_tooltips_get_info_from_tip_window (<em class="parameter"><code><a class="link" href="GtkWindow.html" title="GtkWindow"><span class="type">GtkWindow</span></a> *tip_window</code></em>,
<em class="parameter"><code><a class="link" href="GtkTooltips.html" title="GtkTooltips"><span class="type">GtkTooltips</span></a> **tooltips</code></em>,
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> **current_widget</code></em>);</pre>
<div class="warning"><p><code class="literal">gtk_tooltips_get_info_from_tip_window</code> has been deprecated since version 2.12 and should not be used in newly-written code.</p></div>
<p>Determines the tooltips and the widget they belong to from the window in
which they are displayed. </p>
<p>This function is mostly intended for use by accessibility technologies;
applications should have little use for it.</p>
<div class="refsect3">
<a name="gtk-tooltips-get-info-from-tip-window.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>tip_window</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkWindow.html" title="GtkWindow"><span class="type">GtkWindow</span></a> </p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tooltips</p></td>
<td class="parameter_description"><p>the return location for the tooltips which are displayed
in <em class="parameter"><code>tip_window</code></em>
, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>current_widget</p></td>
<td class="parameter_description"><p>the return location for the widget whose tooltips
are displayed, or <code class="literal">NULL</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-tooltips-get-info-from-tip-window.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>tip_window</code></em>
is displaying tooltips, otherwise <code class="literal">FALSE</code>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-4.html#api-index-2.4">2.4</a></p>
</div>
</div>
<div class="refsect1">
<a name="GtkTooltips.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkTooltips-struct"></a><h3>struct GtkTooltips</h3>
<pre class="programlisting">struct GtkTooltips;</pre>
<div class="warning"><p><code class="literal">GtkTooltips</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
<hr>
<div class="refsect2">
<a name="GtkTooltipsData"></a><h3>struct GtkTooltipsData</h3>
<pre class="programlisting">struct GtkTooltipsData {
GtkTooltips *tooltips;
GtkWidget *widget;
gchar *tip_text;
gchar *tip_private;
};
</pre>
<div class="warning"><p><code class="literal">GtkTooltipsData</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.0</div>
</body>
</html>
|
