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
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.ToolTip:
==========================================================================================================================================
|phoenix_title| **wx.ToolTip**
==========================================================================================================================================
This class holds information about a tooltip associated with a window (see :meth:`wx.Window.SetToolTip` ).
The four static methods, :meth:`wx.ToolTip.Enable` , :meth:`wx.ToolTip.SetDelay` :meth:`wx.ToolTip.SetAutoPop` and :meth:`wx.ToolTip.SetReshow` can be used to globally alter tooltips behaviour.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>ToolTip</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.ToolTip_inheritance.png" alt="Inheritance diagram of ToolTip" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.ToolTip.html" title="wx.ToolTip" alt="" coords="5,83,88,112"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="5,5,87,35"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.ToolTip.__init__` Constructor.
:meth:`~wx.ToolTip.Enable` Enable or disable tooltips globally.
:meth:`~wx.ToolTip.GetTip` Get the tooltip text.
:meth:`~wx.ToolTip.GetWindow` Get the associated window.
:meth:`~wx.ToolTip.SetAutoPop` Set the delay after which the tooltip disappears or how long a tooltip remains visible.
:meth:`~wx.ToolTip.SetDelay` Set the delay after which the tooltip appears.
:meth:`~wx.ToolTip.SetMaxWidth` Set tooltip maximal width in pixels.
:meth:`~wx.ToolTip.SetReshow` Set the delay between subsequent tooltips to appear.
:meth:`~wx.ToolTip.SetTip` Set the tooltip text.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.ToolTip.Tip` See :meth:`~wx.ToolTip.GetTip` and :meth:`~wx.ToolTip.SetTip`
:attr:`~wx.ToolTip.Window` See :meth:`~wx.ToolTip.GetWindow`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.ToolTip(Object)
**Possible constructors**::
ToolTip(tip)
This class holds information about a tooltip associated with a window
(see `Window.SetToolTip()).`
.. method:: __init__(self, tip)
Constructor.
:param `tip`:
:type `tip`: string
.. staticmethod:: Enable(flag)
Enable or disable tooltips globally.
:param `flag`:
:type `flag`: bool
.. note::
May not be supported on all platforms (eg. Cocoa).
.. method:: GetTip(self)
Get the tooltip text.
:rtype: `string`
.. method:: GetWindow(self)
Get the associated window.
:rtype: :ref:`wx.Window`
.. staticmethod:: SetAutoPop(msecs)
Set the delay after which the tooltip disappears or how long a tooltip remains visible.
:param `msecs`:
:type `msecs`: long
.. note::
May not be supported on all platforms (eg. Cocoa, GTK).
.. staticmethod:: SetDelay(msecs)
Set the delay after which the tooltip appears.
:param `msecs`:
:type `msecs`: long
.. note::
May not be supported on all platforms (eg. Cocoa).
.. staticmethod:: SetMaxWidth(width)
Set tooltip maximal width in pixels.
By default, tooltips are wrapped at a suitably chosen width. You can pass -1 as `width` to disable wrapping them completely, 0 to restore the default behaviour or an arbitrary positive value to wrap them at the given width.
Notice that this function does not change the width of the tooltips created before calling it.
:param `width`:
:type `width`: int
.. note::
Currently this function is MSW-only.
.. staticmethod:: SetReshow(msecs)
Set the delay between subsequent tooltips to appear.
:param `msecs`:
:type `msecs`: long
.. note::
May not be supported on all platforms (eg. Cocoa, GTK).
.. method:: SetTip(self, tip)
Set the tooltip text.
:param `tip`:
:type `tip`: string
.. attribute:: Tip
See :meth:`~wx.ToolTip.GetTip` and :meth:`~wx.ToolTip.SetTip`
.. attribute:: Window
See :meth:`~wx.ToolTip.GetWindow`
|
