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
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>wxWidgets: wxHelpProvider Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="page_container">
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0" style="width: 100%;">
<tbody>
<tr>
<td id="projectlogo">
<a href="http://www.wxwidgets.org/" target="_new">
<img alt="wxWidgets" src="logo.png"/>
</a>
</td>
<td style="padding-left: 0.5em; text-align: right;">
<span id="projectnumber">Version: 3.0.2</span>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.8.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Categories</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classwx_help_provider-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">wxHelpProvider Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__group__class__help.html">Help</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <wx/cshelp.h></code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for wxHelpProvider:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classwx_help_provider__inherit__graph.png" border="0" usemap="#wx_help_provider_inherit__map" alt="Inheritance graph"/></div>
<map name="wx_help_provider_inherit__map" id="wx_help_provider_inherit__map">
<area shape="rect" id="node3" href="classwx_simple_help_provider.html" title="wxSimpleHelpProvider is an implementation of wxHelpProvider which supports only plain text help strin..." alt="" coords="25,83,175,111"/><area shape="rect" id="node5" href="classwx_help_controller_help_provider.html" title="wxHelpControllerHelpProvider is an implementation of wxHelpProvider which supports both context ident..." alt="" coords="5,161,195,189"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classwx_help_provider.html" title="wxHelpProvider is an abstract class used by a program implementing context-sensitive help to show the...">wxHelpProvider</a> is an abstract class used by a program implementing context-sensitive help to show the help text for the given window. </p>
<p>The current help provider must be explicitly set by the application using <a class="el" href="classwx_help_provider.html#ae706d7d7bcc79ae894c021706670311c" title="Set the current, application-wide help provider.">Set()</a>.</p>
<h2></h2>
<div><span class="lib">Library:</span>  <span class="lib_text"><a class="el" href="page_libs.html#page_libs_wxcore">wxCore</a></span></div><div><span class="category">Category:</span>  <span class="category_text"><a class="el" href="group__group__class__help.html">Help</a></span></div><dl class="section see"><dt>See Also</dt><dd><a class="el" href="classwx_context_help.html" title="This class changes the cursor to a query and puts the application into a 'context-sensitive help mode...">wxContextHelp</a>, <a class="el" href="classwx_context_help_button.html" title="Instances of this class may be used to add a question mark button that when pressed, puts the application into context-help mode.">wxContextHelpButton</a>, <a class="el" href="classwx_simple_help_provider.html" title="wxSimpleHelpProvider is an implementation of wxHelpProvider which supports only plain text help strin...">wxSimpleHelpProvider</a>, <a class="el" href="classwx_help_controller_help_provider.html" title="wxHelpControllerHelpProvider is an implementation of wxHelpProvider which supports both context ident...">wxHelpControllerHelpProvider</a>, <a class="el" href="classwx_window.html#a4c1a2cbc7363237b3a7c70af4e702c72" title="Sets the help text to be used as context-sensitive help for this window.">wxWindow::SetHelpText()</a>, <a class="el" href="classwx_window.html#afa448f4e01bedc4a5e3d4324929e5d5d" title="Gets the help text to be used as context-sensitive help for this window.">wxWindow::GetHelpTextAtPoint()</a> </dd></dl>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a7bdefa89e55d140528baa8d493b5685a"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_provider.html#a7bdefa89e55d140528baa8d493b5685a">~wxHelpProvider</a> ()</td></tr>
<tr class="memdesc:a7bdefa89e55d140528baa8d493b5685a"><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor for any base class. <a href="#a7bdefa89e55d140528baa8d493b5685a"></a><br/></td></tr>
<tr class="separator:a7bdefa89e55d140528baa8d493b5685a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae4b53b23804a04ce2c4eb93c17e4e8c6"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_provider.html#ae4b53b23804a04ce2c4eb93c17e4e8c6">AddHelp</a> (wxWindowBase *window, const <a class="el" href="classwx_string.html">wxString</a> &text)</td></tr>
<tr class="memdesc:ae4b53b23804a04ce2c4eb93c17e4e8c6"><td class="mdescLeft"> </td><td class="mdescRight">Associates the text with the given window. <a href="#ae4b53b23804a04ce2c4eb93c17e4e8c6"></a><br/></td></tr>
<tr class="separator:ae4b53b23804a04ce2c4eb93c17e4e8c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afcfbc0885cd60700d2b7f8fe66ebcc17"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_provider.html#afcfbc0885cd60700d2b7f8fe66ebcc17">AddHelp</a> (<a class="el" href="windowid_8h.html#ae8091432cc2cb2485d45f2302fb51133">wxWindowID</a> id, const <a class="el" href="classwx_string.html">wxString</a> &text)</td></tr>
<tr class="memdesc:afcfbc0885cd60700d2b7f8fe66ebcc17"><td class="mdescLeft"> </td><td class="mdescRight">Associates the text with the given ID. <a href="#afcfbc0885cd60700d2b7f8fe66ebcc17"></a><br/></td></tr>
<tr class="separator:afcfbc0885cd60700d2b7f8fe66ebcc17"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8a3ced6995edd8bfc856070d9c1ece8d"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classwx_string.html">wxString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_provider.html#a8a3ced6995edd8bfc856070d9c1ece8d">GetHelp</a> (const wxWindowBase *window)=0</td></tr>
<tr class="memdesc:a8a3ced6995edd8bfc856070d9c1ece8d"><td class="mdescLeft"> </td><td class="mdescRight">This version associates the given text with all windows with this id. <a href="#a8a3ced6995edd8bfc856070d9c1ece8d"></a><br/></td></tr>
<tr class="separator:a8a3ced6995edd8bfc856070d9c1ece8d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af41c1502690ee6d62c421014903e6adf"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_provider.html#af41c1502690ee6d62c421014903e6adf">RemoveHelp</a> (wxWindowBase *window)</td></tr>
<tr class="memdesc:af41c1502690ee6d62c421014903e6adf"><td class="mdescLeft"> </td><td class="mdescRight">Removes the association between the window pointer and the help text. <a href="#af41c1502690ee6d62c421014903e6adf"></a><br/></td></tr>
<tr class="separator:af41c1502690ee6d62c421014903e6adf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7a5559d236d746371d12851fe6dce591"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_provider.html#a7a5559d236d746371d12851fe6dce591">ShowHelp</a> (wxWindowBase *window)</td></tr>
<tr class="memdesc:a7a5559d236d746371d12851fe6dce591"><td class="mdescLeft"> </td><td class="mdescRight">Shows help for the given window. <a href="#a7a5559d236d746371d12851fe6dce591"></a><br/></td></tr>
<tr class="separator:a7a5559d236d746371d12851fe6dce591"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5e67cbd17663ad9b7d0c8f407762a0bd"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_provider.html#a5e67cbd17663ad9b7d0c8f407762a0bd">ShowHelpAtPoint</a> (wxWindowBase *window, const <a class="el" href="classwx_point.html">wxPoint</a> &point, <a class="el" href="classwx_help_event.html#a29fe3ca1a548472f0abd0ae94b5def0c">wxHelpEvent::Origin</a> origin)</td></tr>
<tr class="memdesc:a5e67cbd17663ad9b7d0c8f407762a0bd"><td class="mdescLeft"> </td><td class="mdescRight">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 <a class="el" href="classwx_help_provider.html#a7a5559d236d746371d12851fe6dce591" title="Shows help for the given window.">ShowHelp()</a>, so it is enough to only implement the latter if the help doesn't depend on the position. <a href="#a5e67cbd17663ad9b7d0c8f407762a0bd"></a><br/></td></tr>
<tr class="separator:a5e67cbd17663ad9b7d0c8f407762a0bd"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a4ca308e7efb71f50bed602c31faed1d8"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classwx_help_provider.html">wxHelpProvider</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_provider.html#a4ca308e7efb71f50bed602c31faed1d8">Get</a> ()</td></tr>
<tr class="memdesc:a4ca308e7efb71f50bed602c31faed1d8"><td class="mdescLeft"> </td><td class="mdescRight">Returns pointer to help provider instance. <a href="#a4ca308e7efb71f50bed602c31faed1d8"></a><br/></td></tr>
<tr class="separator:a4ca308e7efb71f50bed602c31faed1d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae706d7d7bcc79ae894c021706670311c"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classwx_help_provider.html">wxHelpProvider</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_provider.html#ae706d7d7bcc79ae894c021706670311c">Set</a> (<a class="el" href="classwx_help_provider.html">wxHelpProvider</a> *helpProvider)</td></tr>
<tr class="memdesc:ae706d7d7bcc79ae894c021706670311c"><td class="mdescLeft"> </td><td class="mdescRight">Set the current, application-wide help provider. <a href="#ae706d7d7bcc79ae894c021706670311c"></a><br/></td></tr>
<tr class="separator:ae706d7d7bcc79ae894c021706670311c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7bdefa89e55d140528baa8d493b5685a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual wxHelpProvider::~wxHelpProvider </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Virtual destructor for any base class. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ae4b53b23804a04ce2c4eb93c17e4e8c6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void wxHelpProvider::AddHelp </td>
<td>(</td>
<td class="paramtype">wxWindowBase * </td>
<td class="paramname"><em>window</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>text</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Associates the text with the given window. </p>
<dl class="section remark"><dt>Remarks</dt><dd>Although all help providers have these functions to allow making <a class="el" href="classwx_window.html#a4c1a2cbc7363237b3a7c70af4e702c72" title="Sets the help text to be used as context-sensitive help for this window.">wxWindow::SetHelpText()</a> work, not all of them implement the functions. </dd></dl>
</div>
</div>
<a class="anchor" id="afcfbc0885cd60700d2b7f8fe66ebcc17"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void wxHelpProvider::AddHelp </td>
<td>(</td>
<td class="paramtype"><a class="el" href="windowid_8h.html#ae8091432cc2cb2485d45f2302fb51133">wxWindowID</a> </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classwx_string.html">wxString</a> & </td>
<td class="paramname"><em>text</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Associates the text with the given ID. </p>
<p>This help text will be shown for all windows with ID <em>id</em>, unless they have more specific help text associated using the other <a class="el" href="classwx_help_provider.html#ae4b53b23804a04ce2c4eb93c17e4e8c6" title="Associates the text with the given window.">AddHelp()</a> prototype. May be used to set the same help string for all Cancel buttons in the application, for example.</p>
<dl class="section remark"><dt>Remarks</dt><dd>Although all help providers have these functions to allow making <a class="el" href="classwx_window.html#a4c1a2cbc7363237b3a7c70af4e702c72" title="Sets the help text to be used as context-sensitive help for this window.">wxWindow::SetHelpText()</a> work, not all of them implement the functions. </dd></dl>
</div>
</div>
<a class="anchor" id="a4ca308e7efb71f50bed602c31faed1d8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classwx_help_provider.html">wxHelpProvider</a>* wxHelpProvider::Get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns pointer to help provider instance. </p>
<p>Unlike some other classes, the help provider is not created on demand. This must be explicitly done by the application using <a class="el" href="classwx_help_provider.html#ae706d7d7bcc79ae894c021706670311c" title="Set the current, application-wide help provider.">Set()</a>. </p>
</div>
</div>
<a class="anchor" id="a8a3ced6995edd8bfc856070d9c1ece8d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classwx_string.html">wxString</a> wxHelpProvider::GetHelp </td>
<td>(</td>
<td class="paramtype">const wxWindowBase * </td>
<td class="paramname"><em>window</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This version associates the given text with all windows with this id. </p>
<p>May be used to set the same help string for all Cancel buttons in the application, for example. </p>
</div>
</div>
<a class="anchor" id="af41c1502690ee6d62c421014903e6adf"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void wxHelpProvider::RemoveHelp </td>
<td>(</td>
<td class="paramtype">wxWindowBase * </td>
<td class="paramname"><em>window</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes the association between the window pointer and the help text. </p>
<p>This is called by the <a class="el" href="classwx_window.html" title="wxWindow is the base class for all windows and represents any visible object on screen.">wxWindow</a> destructor. Without this, the table of help strings will fill up and when window pointers are reused, the wrong help string will be found. </p>
</div>
</div>
<a class="anchor" id="ae706d7d7bcc79ae894c021706670311c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classwx_help_provider.html">wxHelpProvider</a>* wxHelpProvider::Set </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwx_help_provider.html">wxHelpProvider</a> * </td>
<td class="paramname"><em>helpProvider</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the current, application-wide help provider. </p>
<dl class="section return"><dt>Returns</dt><dd>Pointer to previous help provider or <span class="literal">NULL</span> if there wasn't any. </dd></dl>
</div>
</div>
<a class="anchor" id="a7a5559d236d746371d12851fe6dce591"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool wxHelpProvider::ShowHelp </td>
<td>(</td>
<td class="paramtype">wxWindowBase * </td>
<td class="paramname"><em>window</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Shows help for the given window. </p>
<p>Override this function if the help doesn't depend on the exact position inside the window, otherwise you need to override <a class="el" href="classwx_help_provider.html#a5e67cbd17663ad9b7d0c8f407762a0bd" title="This function may be overridden to show help for the window when it should depend on the position ins...">ShowHelpAtPoint()</a>. Returns <span class="literal">true</span> if help was shown, or <span class="literal">false</span> if no help was available for this window. </p>
</div>
</div>
<a class="anchor" id="a5e67cbd17663ad9b7d0c8f407762a0bd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool wxHelpProvider::ShowHelpAtPoint </td>
<td>(</td>
<td class="paramtype">wxWindowBase * </td>
<td class="paramname"><em>window</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classwx_point.html">wxPoint</a> & </td>
<td class="paramname"><em>point</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classwx_help_event.html#a29fe3ca1a548472f0abd0ae94b5def0c">wxHelpEvent::Origin</a> </td>
<td class="paramname"><em>origin</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>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 <a class="el" href="classwx_help_provider.html#a7a5559d236d746371d12851fe6dce591" title="Shows help for the given window.">ShowHelp()</a>, so it is enough to only implement the latter if the help doesn't depend on the position. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">window</td><td>Window to show help text for. </td></tr>
<tr><td class="paramname">point</td><td>Coordinates of the mouse at the moment of help event emission. </td></tr>
<tr><td class="paramname">origin</td><td>Help event origin, see <a class="el" href="classwx_help_event.html#a55ce4340d1254116a80cb6a8352d33ae" title="Returns the origin of the help event which is one of the wxHelpEvent::Origin values.">wxHelpEvent::GetOrigin</a>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><span class="literal">true</span> if help was shown, or <span class="literal">false</span> if no help was available for this window.</dd></dl>
<dl class="section since"><dt>Since</dt><dd>2.7.0 </dd></dl>
</div>
</div>
</div><!-- contents -->
<address class="footer">
<small>
Generated on Thu Nov 27 2014 13:46:49 for wxWidgets by <a href="http://www.doxygen.org/index.html" target="_new">Doxygen</a> 1.8.2
</small>
</address>
<script src="wxwidgets.js" type="text/javascript"></script>
</div><!-- #page_container -->
</body>
</html>
|
