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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-1"
http-equiv="content-type">
<title>GTK+ Foundation Classes</title>
<link href="gfc.css" rel="stylesheet" type="text/css">
<meta content="The GFC Development Team" name="author">
<meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td
style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
alt="GFC Logo" src="../images/gfc.png"
style="width: 207px; height: 92px;"></td>
<td
style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
alt="GFC Title Logo" src="../images/gfc-title.png"
style="width: 418px; height: 76px;"><br>
</td>
</tr>
<tr>
<td
style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
</td>
<td
style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
style="font-family: helvetica,arial,sans-serif;"><a
href="../html/index.html">Main Page</a> | <a
href="../html/namespaces.html">Namespace List</a> | <a
href="classes.html">Alphabetical List</a> | <a
href="../html/annotated.html">Class List</a> | <a
href="../html/files.html">File List</a></small><br>
</td>
</tr>
</tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>GFC::Gtk::Tooltips Class Reference</h1>A GtkTooltips C++ wrapper class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="tooltips_8hh-source.html">gfc/gtk/tooltips.hh</a>></code>
<p>
<p>Inheritance diagram for GFC::Gtk::Tooltips:
<p><center><img src="classGFC_1_1Gtk_1_1Tooltips.png" usemap="#GFC::Gtk::Tooltips_map" border="0" alt=""></center>
<map name="GFC::Gtk::Tooltips_map">
<area href="classGFC_1_1Gtk_1_1Object.html" alt="GFC::Gtk::Object" shape="rect" coords="0,168,134,192">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html" alt="GFC::G::Object" shape="rect" coords="0,112,134,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1TypeInstance.html" alt="GFC::G::TypeInstance" shape="rect" coords="0,56,134,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,134,24">
</map>
<a href="classGFC_1_1Gtk_1_1Tooltips-members.html">List of all members.</a><h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="anchor" name="z957_0" doxytag="GFC::Gtk::Tooltips::Tooltips" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html#z957_0">Tooltips</a> ()
<dl class="el"><dd class="mdescRight">Constructs an empty group of tooltips. <br></dl><li><a class="anchor" name="z957_1" doxytag="GFC::Gtk::Tooltips::~Tooltips" ></a>
virtual <a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html#z957_1">~Tooltips</a> ()
<dl class="el"><dd class="mdescRight">Destructor. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z958_0" doxytag="GFC::Gtk::Tooltips::gtk_tooltips" ></a>
GtkTooltips * <a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html#z958_0">gtk_tooltips</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GtkTooltips structure. <br></dl><li><a class="anchor" name="z958_1" doxytag="GFC::Gtk::Tooltips::operator GtkTooltips *" ></a>
<a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html#z958_1">operator GtkTooltips *</a> () const
<dl class="el"><dd class="mdescRight">Conversion operator; safely converts a <a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html">Tooltips</a> to a GtkTooltips pointer. <br></dl><li><a class="anchor" name="z958_2" doxytag="GFC::Gtk::Tooltips::is_enabled" ></a>
bool <a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html#z958_2">is_enabled</a> () const
<dl class="el"><dd class="mdescRight">Returns true if tooltips are enabled. <br></dl></ul>
<tr><td colspan="2"><div class="groupHeader">Methods</div></td></tr>
<ul>
<li><a class="anchor" name="z959_0" doxytag="GFC::Gtk::Tooltips::enable" ></a>
void <a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html#z959_0">enable</a> ()
<dl class="el"><dd class="mdescRight">Allows the user to see your tooltips as they navigate your application. <br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html#z959_1">disable</a> ()
<dl class="el"><dd class="mdescRight">Causes all tooltips in tooltips to become inactive. <a href="#z959_1"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html#z959_3">set_tip</a> (<a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> &widget, const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &tip_text, const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> &tip_private=0)
<dl class="el"><dd class="mdescRight">Adds a tooltip containing the message <em>tip_text</em> to the specified <a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a>. <a href="#z959_3"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html#z959_4">unset_tip</a> (<a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> &widget)
<dl class="el"><dd class="mdescRight">Unsets any previously set tooltip associated with <em>widget</em>. <a href="#z959_4"></a><br></dl><li>void <a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html#z959_5">force_window</a> ()
<dl class="el"><dd class="mdescRight">Ensures that the window used for displaying the given tooltips is created. <a href="#z959_5"></a><br></dl></ul>
<h2>Static Public Member Functions</h2>
<ul>
<li><a class="el" href="classGFC_1_1Gtk_1_1TooltipsData.html">TooltipsData</a> * <a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html#e0">data_get</a> (<a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> &widget)
<dl class="el"><dd class="mdescRight">Retrieves any <a class="el" href="classGFC_1_1Gtk_1_1TooltipsData.html">TooltipsData</a> previously associated with the given widget. <a href="#e0"></a><br></dl></ul>
<h2>Protected Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Constructors</div></td></tr>
<ul>
<li><a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html#z956_0">Tooltips</a> (GtkTooltips *tooltips, bool <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html#z143_1">owns_reference</a>=false)
<dl class="el"><dd class="mdescRight">Construct a new <a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html">Tooltips</a> from an existing GtkTooltips. <a href="#z956_0"></a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GtkTooltips C++ wrapper class.
<p>
<a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html">Tooltips</a> are the messages that appear next to a widget when the mouse pointer is held over it for a short amount of time. They are especially helpful for adding more verbose descriptions of things such as buttons in a toolbar.<p>
An individual tooltip belongs to a group of tooltips. A group is created with the default constructor <a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html#z957_0">Tooltips()</a>. Every tooltip in the group can then be turned off with a call to <a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html#z959_1">disable()</a> and enabled with <a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html#z959_0">enable()</a>. To assign a tip to a particular <a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a>, <a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html#z959_3">set_tip()</a> is used.<p>
Note, <a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html">Tooltips</a> can only be set on widgets which have their own X window. To check if a widget has its own window use <a class="el" href="classGFC_1_1Gtk_1_1Widget.html#z1052_3">Gtk::Widget::has_no_window()</a>. To add a tooltip to a widget that doesn't have its own window, place the widget inside an <a class="el" href="classGFC_1_1Gtk_1_1EventBox.html">EventBox</a> and add a tooltip to that instead.<p>
The default appearance of all tooltips in a program is determined by the current GTK+ theme that the user has selected. Information about the tooltip (if any) associated with an arbitrary widget can be retrieved using <a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html#e0">data_get()</a>.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="z956_0" doxytag="GFC::Gtk::Tooltips::Tooltips" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> GFC::Gtk::Tooltips::Tooltips </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">GtkTooltips * </td>
<td class="mdname" nowrap> <em>tooltips</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>owns_reference</em> = <code>false</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [explicit, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Construct a new <a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html">Tooltips</a> from an existing GtkTooltips.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>tooltips</em> </td><td>A pointer to a GtkTooltips. </td></tr>
<tr><td></td><td valign=top><em>owns_reference</em> </td><td>Set false if the initial reference count is floating, set true if it's not.</td></tr>
</table>
</dl>
<br>
The <em>tooltips</em> can be a newly created GtkTooltips or an existing GtkTooltips (see <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Object.html#z68_0">G::Object::Object</a>). </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e0" doxytag="GFC::Gtk::Tooltips::data_get" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="classGFC_1_1Gtk_1_1TooltipsData.html">TooltipsData</a>* GFC::Gtk::Tooltips::data_get </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>widget</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Retrieves any <a class="el" href="classGFC_1_1Gtk_1_1TooltipsData.html">TooltipsData</a> previously associated with the given widget.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>widget</em> </td><td>A <a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a>. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="classGFC_1_1Gtk_1_1TooltipsData.html">TooltipsData</a> object, or null if the widget has no tooltip. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z959_1" doxytag="GFC::Gtk::Tooltips::disable" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::Tooltips::disable </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Causes all tooltips in tooltips to become inactive.
<p>
Any widgets that have tips associated with that group will no longer display their tips until they are enabled again with <a class="el" href="classGFC_1_1Gtk_1_1Tooltips.html#z959_0">enable()</a>. </td>
</tr>
</table>
<a class="anchor" name="z959_5" doxytag="GFC::Gtk::Tooltips::force_window" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::Tooltips::force_window </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Ensures that the window used for displaying the given tooltips is created.
<p>
Applications should never have to call this method, since GTK+ takes care of this. </td>
</tr>
</table>
<a class="anchor" name="z959_3" doxytag="GFC::Gtk::Tooltips::set_tip" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::Tooltips::set_tip </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> & </td>
<td class="mdname" nowrap> <em>widget</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>tip_text</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>const <a class="elRef" doxygen="gfccore.tag:" href="classGFC_1_1String.html">String</a> & </td>
<td class="mdname" nowrap> <em>tip_private</em> = <code>0</code></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Adds a tooltip containing the message <em>tip_text</em> to the specified <a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>widget</em> </td><td>The <a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> you wish to associate the tip with. </td></tr>
<tr><td></td><td valign=top><em>tip_text</em> </td><td>A string containing the tip itself. </td></tr>
<tr><td></td><td valign=top><em>tip_private</em> </td><td>A string of any further information that may be useful if the user gets stuck. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="z959_4" doxytag="GFC::Gtk::Tooltips::unset_tip" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void GFC::Gtk::Tooltips::unset_tip </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>widget</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Unsets any previously set tooltip associated with <em>widget</em>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>widget</em> </td><td>A <a class="el" href="classGFC_1_1Gtk_1_1Widget.html">Widget</a>. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="tooltips_8hh-source.html">tooltips.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:43 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
|
