1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-gtktooltips">
<refnamediv>
<refname>gtk.Tooltips</refname>
<refpurpose>add tips to your widgets.</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.Tooltips</classname></ooclass>
<ooclass><classname><link
linkend="class-gtkobject">gtk.Object</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link
linkend="constructor-gtktooltips">gtk.Tooltips</link></methodname>
<methodparam></methodparam> </constructorsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtktooltips--enable">enable</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtktooltips--disable">disable</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtktooltips--set-tip">set_tip</link></methodname>
<methodparam><parameter
role="keyword">widget</parameter></methodparam>
<methodparam><parameter
role="keyword">tip_text</parameter></methodparam>
<methodparam><parameter
role="keyword">tip_private</parameter><initializer>None</initializer></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtktooltips--force-window">force_window</link></methodname>
<methodparam></methodparam> </methodsynopsis>
</classsynopsis>
<programlisting>
<emphasis role="bold">Functions</emphasis>
<methodsynopsis language="python">
<methodname><link
linkend="function-gtk--tooltips-data-get">gtk.tooltips_data_get</link></methodname>
<methodparam><parameter
role="keyword">widget</parameter></methodparam>
</methodsynopsis></programlisting>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gtkobject">gtk.Object</link>
+-- <link linkend="class-gtktooltips">gtk.Tooltips</link>
</synopsis>
</refsect1>
<refsect1 id="properties-gtktooltips">
<title>gtk.Tooltips Properties</title>
<para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
</refsect1>
<refsect1>
<title>Attributes</title>
<blockquote role="properties">
<informaltable pgwide="1" frame="none">
<tgroup cols="3">
<?dbhtml cellpadding="5"?>
<colspec column="1" colwidth="1in"/>
<colspec column="2" colwidth="1in"/>
<colspec column="3" colwidth="4in"/>
<tbody>
<row valign="top">
<entry>"tip_window"</entry>
<entry>Read</entry>
<entry>The window that the tooltip is displayed in.</entry>
</row>
<row valign="top">
<entry>"tip_label"</entry>
<entry>Read</entry>
<entry>The label that displays the tooltip text.</entry>
</row>
<row valign="top">
<entry>"active_tips_data"</entry>
<entry>Read</entry>
<entry>The data associated with the active tooltip.</entry>
</row>
<row valign="top">
<entry>"tips_data_list"</entry>
<entry>Read</entry>
<entry>A list containing the data associated with the tooltips in a tooltips group. For each tooltip the data is a tuple containing:
the tooltip object, the associated widget, the tooltip text and the tooltip
private text.</entry>
</row>
<row valign="top">
<entry>"delay"</entry>
<entry>Read</entry>
<entry>The delay between the mouse pausing over the widget and
the display of the tooltip in msec.</entry>
</row>
<row valign="top">
<entry>"enabled"</entry>
<entry>Read</entry>
<entry>If <literal>True</literal> the tooltips are
enabled</entry>
</row>
<row valign="top">
<entry>"use_sticky_delay"</entry>
<entry>Read</entry>
<entry>If <literal>True</literal> shorten the delay for
showing a tooltip on another widget is already showing a tooltip.</entry>
</row>
<row valign="top">
<entry>"timer_tag"</entry>
<entry>Read</entry>
<entry>The tag of the timeout handler used for the
delay.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1 id="signal-prototypes-gtktooltips">
<title>gtk.Tooltips Signal Prototypes</title>
<para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
</refsect1>
<refsect1>
<title>Description</title>
<warning>
<para>This method is deprecated in PyGTK 2.12 and above</para>
</warning>
<para>Tooltips 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. An individual tooltip belongs to a group of tooltips.
A group is created with a call to the <link
linkend="constructor-gtktooltips">gtk.Tooltips</link>() constructor. Every
tooltip in the group can then be turned off with a call to the <link
linkend="method-gtktooltips--disable"><methodname>disable</methodname>()</link>
method and enabled with the <link
linkend="method-gtktooltips--enable"><methodname>enable</methodname>()</link>
method. To assign a tip to a particular <link
linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>, use the
<link
linkend="method-gtktooltips--set-tip"><methodname>set_tip</methodname>()</link>
method.</para>
<note>
<para>Tooltips can only be set on widgets which have their own X
window. To check if a widget has its own window use
<literal>widget.flags()&gtk.NO_WINDOW</literal>. To add a tooltip to a
widget that doesn't have its own window, place the widget inside a <link
linkend="class-gtkeventbox"><classname>gtk.EventBox</classname></link> and
add a tooltip to the eventbox instead.</para>
</note>
<para>The default appearance of all tooltips in a program is determined
by the current theme that the user has selected. Information about the
tooltip (if any) associated with an arbitrary widget can be retrieved using
the <link
linkend="function-gtk--tooltips-data-get"><function>gtk.tooltips_data_get</function>()</link>
function.</para>
</refsect1>
<refsect1 id="constructor-gtktooltips">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gtk.Tooltips</methodname>
<methodparam></methodparam> </constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new <link
linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link>
object</simpara></listitem>
</varlistentry>
</variablelist>
<warning>
<para>This method is deprecated in PyGTK 2.12 and above</para>
</warning>
<para>Creates an empty <link
linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link>
group.</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtktooltips--enable">
<title>gtk.Tooltips.enable</title>
<programlisting><methodsynopsis language="python">
<methodname>enable</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<warning>
<para>This method is deprecated in PyGTK 2.12 and above</para>
</warning>
<para>The <methodname>enable</methodname>() method enables a group of
tooltips. A tooltip will be displayed over its associated widget when
the mouse pointer pauses over the widget.</para>
</refsect2>
<refsect2 id="method-gtktooltips--disable">
<title>gtk.Tooltips.disable</title>
<programlisting><methodsynopsis language="python">
<methodname>disable</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<warning>
<para>This method is deprecated in PyGTK 2.12 and above</para>
</warning>
<para>The <methodname>disable</methodname>() method disables a group
of tooltips. A tooltip will not be displayed over its associated widget when
the mouse pointer pauses over the widget.</para>
</refsect2>
<refsect2 id="method-gtktooltips--set-tip">
<title>gtk.Tooltips.set_tip</title>
<programlisting><methodsynopsis language="python">
<methodname>set_tip</methodname>
<methodparam><parameter role="keyword">widget</parameter></methodparam>
<methodparam><parameter role="keyword">tip_text</parameter></methodparam>
<methodparam><parameter role="keyword">tip_private</parameter><initializer>None</initializer></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">widget</parameter> :</term>
<listitem><simpara>a <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link></simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">tip_text</parameter> :</term>
<listitem><simpara>the tooltip text</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">tip_private</parameter> :</term>
<listitem><simpara>the tooltip private text for context sensitive display</simpara></listitem>
</varlistentry>
</variablelist>
<warning>
<para>This method is deprecated in PyGTK 2.12 and above</para>
</warning>
<para>The <methodname>set_tips</methodname>() method creates a tooltip
for the specified <parameter>widget</parameter>. The text specified by
<parameter>tooltip_text</parameter> will be displayed when the mouse pointer
pauses over <parameter>widget</parameter> if the tooltips are
enabled..</para>
</refsect2>
<refsect2 id="method-gtktooltips--force-window">
<title>gtk.Tooltips.force_window</title>
<programlisting><methodsynopsis language="python">
<methodname>force_window</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<warning>
<para>This method is deprecated in PyGTK 2.12 and above</para>
</warning>
<para>The <methodname>force_window</methodname>() method ensures that
the window used for displaying the given tooltips is created. Applications
should never have to call this function, since PyGTK takes care of
this.</para>
</refsect2>
</refsect1>
<refsect1>
<title>Functions</title>
<refsect2 id="function-gtk--tooltips-data-get">
<title>gtk.tooltips_data_get</title>
<programlisting><methodsynopsis language="python">
<methodname>gtk.tooltips_data_get</methodname>
<methodparam><parameter
role="keyword">widget</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">widget</parameter> :</term>
<listitem><simpara>a widget</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a tuple containing the tooltip data associated
with <parameter>widget</parameter> or
<literal>None</literal></simpara></listitem>
</varlistentry>
</variablelist>
<warning>
<para>This method is deprecated in PyGTK 2.12 and above</para>
</warning>
<para>The <function>gtk.tooltips_data_get</function>() function
returns a tuple containing the tooltip data associated with
<parameter>widget</parameter>. The tuple contains:</para>
<itemizedlist>
<listitem>
<simpara>the <link
linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link> group
containing the tooltip</simpara>
</listitem>
<listitem>
<simpara>the widget</simpara>
</listitem>
<listitem>
<simpara>the tooltip text string</simpara>
</listitem>
<listitem>
<simpara>the tooltip private text string or
<literal>None</literal></simpara>
</listitem>
</itemizedlist>
<para>If <parameter>widget</parameter> does not have an associated
tooltip this function returns <literal>None</literal>.</para>
</refsect2>
</refsect1>
</refentry>
|
