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
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.HelpProvider:
==========================================================================================================================================
|phoenix_title| **wx.HelpProvider**
==========================================================================================================================================
:ref:`wx.HelpProvider` is an abstract class used by a program implementing context-sensitive help to show the help text for the given window.
The current help provider must be explicitly set by the application using :meth:`~wx.HelpProvider.Set`.
.. seealso:: :ref:`wx.ContextHelp`, :ref:`wx.ContextHelpButton`, :ref:`wx.SimpleHelpProvider`, :ref:`wx.HelpControllerHelpProvider`, :meth:`wx.Window.SetHelpText` , :meth:`wx.Window.GetHelpTextAtPoint`
|
|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>HelpProvider</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.HelpProvider_inheritance.png" alt="Inheritance diagram of HelpProvider" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.HelpProvider.html" title="wx.HelpProvider" alt="" coords="5,5,135,35"/> </map>
</p>
</div>
|
|sub_classes| Known Subclasses
==============================
:ref:`wx.SimpleHelpProvider`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.HelpProvider.AddHelp` Associates the text with the given window.
:meth:`~wx.HelpProvider.Get` Returns pointer to help provider instance.
:meth:`~wx.HelpProvider.GetHelp` This version associates the given text with all windows with this id.
:meth:`~wx.HelpProvider.RemoveHelp` Removes the association between the window pointer and the help text.
:meth:`~wx.HelpProvider.Set` Set the current, application-wide help provider.
:meth:`~wx.HelpProvider.ShowHelp` Shows help for the given window.
:meth:`~wx.HelpProvider.ShowHelpAtPoint` This function may be overridden to show help for the window when it should depend on the position inside the window, By default this method forwards to :meth:`~HelpProvider.ShowHelp` , so it is enough to only implement the latter if the help doesn't depend on the position.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.HelpProvider(object)
HelpProvider is an abstract class used by a program implementing
context-sensitive help to show the help text for the given window.
.. method:: AddHelp(self, *args, **kw)
|overload| Overloaded Implementations:
:html:`<hr class="overloadsep" /><br />`
**AddHelp** `(self, window, text)`
Associates the text with the given window.
:param `window`:
:type `window`: wx.WindowBase
:param `text`:
:type `text`: string
.. note::
Although all help providers have these functions to allow making :meth:`wx.Window.SetHelpText` work, not all of them implement the functions.
:html:`<hr class="overloadsep" /><br />`
**AddHelp** `(self, id, text)`
Associates the text with the given ``ID``.
This help text will be shown for all windows with ``ID`` `id`, unless they have more specific help text associated using the other :meth:`AddHelp` prototype. May be used to set the same help string for all Cancel buttons in the application, for example.
:param `id`:
:type `id`: wx.WindowID
:param `text`:
:type `text`: string
.. note::
Although all help providers have these functions to allow making :meth:`wx.Window.SetHelpText` work, not all of them implement the functions.
:html:`<hr class="overloadsep" /><br />`
.. staticmethod:: Get()
Returns pointer to help provider instance.
Unlike some other classes, the help provider is not created on demand. This must be explicitly done by the application using :meth:`Set` .
:rtype: :ref:`wx.HelpProvider`
.. method:: GetHelp(self, window)
This version associates the given text with all windows with this id.
May be used to set the same help string for all Cancel buttons in the application, for example.
:param `window`:
:type `window`: wx.Window
:rtype: `string`
.. method:: RemoveHelp(self, window)
Removes the association between the window pointer and the help text.
This is called by the :ref:`wx.Window` destructor. Without this, the table of help strings will fill up and when window pointers are reused, the wrong help string will be found.
:param `window`:
:type `window`: wx.WindowBase
.. staticmethod:: Set(helpProvider)
Set the current, application-wide help provider.
:param `helpProvider`:
:type `helpProvider`: wx.HelpProvider
:rtype: :ref:`wx.HelpProvider`
:returns:
Pointer to previous help provider or ``None`` if there wasn't any.
.. method:: ShowHelp(self, window)
Shows help for the given window.
Override this function if the help doesn't depend on the exact position inside the window, otherwise you need to override :meth:`ShowHelpAtPoint` . Returns ``True`` if help was shown, or ``False`` if no help was available for this window.
:param `window`:
:type `window`: wx.WindowBase
:rtype: `bool`
.. method:: ShowHelpAtPoint(self, window, point, origin)
This function may be overridden to show help for the window when it should depend on the position inside the window, By default this method forwards to :meth:`ShowHelp` , so it is enough to only implement the latter if the help doesn't depend on the position.
:param `window`: Window to show help text for.
:type `window`: wx.WindowBase
:param `point`: Coordinates of the mouse at the moment of help event emission.
:type `point`: wx.Point
:param `origin`: Help event origin, see :meth:`wx.HelpEvent.GetOrigin` .
:type `origin`: HelpEvent.Origin
:rtype: `bool`
:returns:
``True`` if help was shown, or ``False`` if no help was available for this window.
.. versionadded:: 2.7.0
|
