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
|
<!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: wxHelpController 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="classwx_help_controller-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">wxHelpController Class Reference<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/help.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 wxHelpController:</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_controller__inherit__graph.png" border="0" usemap="#wx_help_controller_inherit__map" alt="Inheritance graph"/></div>
<map name="wx_help_controller_inherit__map" id="wx_help_controller_inherit__map">
<area shape="rect" id="node2" href="classwx_help_controller_base.html" title="This is the abstract base class a family of classes by which applications may invoke a help viewer to..." alt="" coords="5,83,152,111"/><area shape="rect" id="node4" href="classwx_object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="41,6,116,34"/></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>This is an alias for one of a family of help controller classes which is most appropriate for the current platform. </p>
<p>A help controller allows an application to display help, at the contents or at a particular topic, and shut the help program down on termination. This avoids proliferation of many instances of the help viewer whenever the user requests a different topic via the application's menus or buttons.</p>
<p>Typically, an application will create a help controller instance when it starts, and immediately call <a class="el" href="classwx_help_controller_base.html#ac7a8fa6e2f659cdca5863f8a3e35e1f0" title="Initializes the help instance with a help filename, and optionally a server socket number if using wx...">wxHelpController::Initialize</a> to associate a filename with it. The help viewer will only get run, however, just before the first call to display something.</p>
<p>Most help controller classes actually derive from <a class="el" href="classwx_help_controller_base.html" title="This is the abstract base class a family of classes by which applications may invoke a help viewer to...">wxHelpControllerBase</a> and have names of the form wxXXXHelpController or wxHelpControllerXXX. An appropriate class is aliased to the name <a class="el" href="classwx_help_controller.html" title="This is an alias for one of a family of help controller classes which is most appropriate for the cur...">wxHelpController</a> for each platform, as follows:</p>
<ul>
<li>On desktop Windows, wxCHMHelpController is used (MS HTML Help).</li>
<li>On Windows CE, wxWinceHelpController is used.</li>
<li>On all other platforms, <a class="el" href="classwx_html_help_controller.html" title="This help controller provides an easy way of displaying HTML help in your application (see HTML Sampl...">wxHtmlHelpController</a> is used if wxHTML is compiled into wxWidgets; otherwise <a class="el" href="classwx_ext_help_controller.html" title="This class implements help via an external browser.">wxExtHelpController</a> is used (for invoking an external browser).</li>
</ul>
<p>The remaining help controller classes need to be named explicitly by an application that wishes to make use of them.</p>
<p>The following help controller classes are defined:</p>
<ul>
<li>wxWinHelpController, for controlling Windows Help.</li>
<li>wxCHMHelpController, for controlling MS HTML Help. To use this, you need to set wxUSE_MS_HTML_HELP to 1 in setup.h and have the htmlhelp.h header from Microsoft's HTML Help kit. (You don't need the VC++-specific htmlhelp.lib because wxWidgets loads necessary DLL at runtime and so it works with all compilers.)</li>
<li>wxBestHelpController, for controlling MS HTML Help or, if Microsoft's runtime is not available, <a class="el" href="classwx_html_help_controller.html" title="This help controller provides an easy way of displaying HTML help in your application (see HTML Sampl...">wxHtmlHelpController</a>. You need to provide <b>both</b> CHM and HTB versions of the help file. For wxMSW only.</li>
<li><a class="el" href="classwx_ext_help_controller.html" title="This class implements help via an external browser.">wxExtHelpController</a>, for controlling external browsers under Unix. The default browser is Netscape Navigator. The 'help' sample shows its use.</li>
<li>wxWinceHelpController, for controlling a simple <code></code>.htm help controller for Windows CE applications.</li>
<li><a class="el" href="classwx_html_help_controller.html" title="This help controller provides an easy way of displaying HTML help in your application (see HTML Sampl...">wxHtmlHelpController</a>, a sophisticated help controller using wxHTML, in a similar style to the Microsoft HTML Help viewer and using some of the same files. Although it has an API compatible with other help controllers, it has more advanced features, so it is recommended that you use the specific API for this class instead. Note that if you use .zip or .htb formats for your books, you must add this line to your application initialization: <div class="fragment"><div class="line"><a class="code" href="classwx_file_system.html#a442d841b2baa5a0eb83c3a985b1e3119" title="This static function adds new handler into the list of handlers (see wxFileSystemHandler) which provi...">wxFileSystem::AddHandler</a>(<span class="keyword">new</span> <a class="code" href="classwx_archive_f_s_handler.html" title="A file system handler for accessing files inside of archives.">wxArchiveFSHandler</a>); </div>
</div><!-- fragment --> or nothing will be shown in your help window.</li>
</ul>
<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_html_help_controller.html" title="This help controller provides an easy way of displaying HTML help in your application (see HTML Sampl...">wxHtmlHelpController</a>, <a class="el" href="overview_html.html">wxHTML Overview</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:a33ea318ec42fbe28b84abfec61094209"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_controller.html#a33ea318ec42fbe28b84abfec61094209">wxHelpController</a> (<a class="el" href="classwx_window.html">wxWindow</a> *parentWindow=NULL)</td></tr>
<tr class="memdesc:a33ea318ec42fbe28b84abfec61094209"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a help instance object, but does not invoke the help viewer. <a href="#a33ea318ec42fbe28b84abfec61094209"></a><br/></td></tr>
<tr class="separator:a33ea318ec42fbe28b84abfec61094209"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classwx_help_controller_base"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classwx_help_controller_base')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classwx_help_controller_base.html">wxHelpControllerBase</a></td></tr>
<tr class="memitem:a2373627b7ca45b75810926154bf65843 inherit pub_methods_classwx_help_controller_base"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_controller_base.html#a2373627b7ca45b75810926154bf65843">wxHelpControllerBase</a> (<a class="el" href="classwx_window.html">wxWindow</a> *parentWindow=NULL)</td></tr>
<tr class="memdesc:a2373627b7ca45b75810926154bf65843 inherit pub_methods_classwx_help_controller_base"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a help instance object, but does not invoke the help viewer. <a href="#a2373627b7ca45b75810926154bf65843"></a><br/></td></tr>
<tr class="separator:a2373627b7ca45b75810926154bf65843 inherit pub_methods_classwx_help_controller_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a14a0b4e5433e6b03e11804a15fa432a2 inherit pub_methods_classwx_help_controller_base"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_controller_base.html#a14a0b4e5433e6b03e11804a15fa432a2">~wxHelpControllerBase</a> ()</td></tr>
<tr class="memdesc:a14a0b4e5433e6b03e11804a15fa432a2 inherit pub_methods_classwx_help_controller_base"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the help instance, closing down the viewer if it is running. <a href="#a14a0b4e5433e6b03e11804a15fa432a2"></a><br/></td></tr>
<tr class="separator:a14a0b4e5433e6b03e11804a15fa432a2 inherit pub_methods_classwx_help_controller_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acef270454911598d88e31016124f487c inherit pub_methods_classwx_help_controller_base"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_controller_base.html#acef270454911598d88e31016124f487c">DisplayBlock</a> (long blockNo)=0</td></tr>
<tr class="memdesc:acef270454911598d88e31016124f487c inherit pub_methods_classwx_help_controller_base"><td class="mdescLeft"> </td><td class="mdescRight">If the help viewer is not running, runs it and displays the file at the given block number. <a href="#acef270454911598d88e31016124f487c"></a><br/></td></tr>
<tr class="separator:acef270454911598d88e31016124f487c inherit pub_methods_classwx_help_controller_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a369c8bd9974b06105778226399563cbb inherit pub_methods_classwx_help_controller_base"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_controller_base.html#a369c8bd9974b06105778226399563cbb">DisplayContents</a> ()=0</td></tr>
<tr class="memdesc:a369c8bd9974b06105778226399563cbb inherit pub_methods_classwx_help_controller_base"><td class="mdescLeft"> </td><td class="mdescRight">If the help viewer is not running, runs it and displays the contents. <a href="#a369c8bd9974b06105778226399563cbb"></a><br/></td></tr>
<tr class="separator:a369c8bd9974b06105778226399563cbb inherit pub_methods_classwx_help_controller_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8ec7169cdc87678e2bbee7f1c6a8cdca inherit pub_methods_classwx_help_controller_base"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_controller_base.html#a8ec7169cdc87678e2bbee7f1c6a8cdca">DisplayContextPopup</a> (int contextId)</td></tr>
<tr class="memdesc:a8ec7169cdc87678e2bbee7f1c6a8cdca inherit pub_methods_classwx_help_controller_base"><td class="mdescLeft"> </td><td class="mdescRight">Displays the section as a popup window using a context id. <a href="#a8ec7169cdc87678e2bbee7f1c6a8cdca"></a><br/></td></tr>
<tr class="separator:a8ec7169cdc87678e2bbee7f1c6a8cdca inherit pub_methods_classwx_help_controller_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a57ad6b821d19d61de836a445fb9a1365 inherit pub_methods_classwx_help_controller_base"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_controller_base.html#a57ad6b821d19d61de836a445fb9a1365">DisplaySection</a> (const <a class="el" href="classwx_string.html">wxString</a> &section)</td></tr>
<tr class="memdesc:a57ad6b821d19d61de836a445fb9a1365 inherit pub_methods_classwx_help_controller_base"><td class="mdescLeft"> </td><td class="mdescRight">If the help viewer is not running, runs it and displays the given section. <a href="#a57ad6b821d19d61de836a445fb9a1365"></a><br/></td></tr>
<tr class="separator:a57ad6b821d19d61de836a445fb9a1365 inherit pub_methods_classwx_help_controller_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a84351b9fd7d02de52bd0a292995f06e4 inherit pub_methods_classwx_help_controller_base"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_controller_base.html#a84351b9fd7d02de52bd0a292995f06e4">DisplaySection</a> (int sectionNo)=0</td></tr>
<tr class="memdesc:a84351b9fd7d02de52bd0a292995f06e4 inherit pub_methods_classwx_help_controller_base"><td class="mdescLeft"> </td><td class="mdescRight">If the help viewer is not running, runs it and displays the given section. <a href="#a84351b9fd7d02de52bd0a292995f06e4"></a><br/></td></tr>
<tr class="separator:a84351b9fd7d02de52bd0a292995f06e4 inherit pub_methods_classwx_help_controller_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a416082870baafe1719ee4af2a9c50a26 inherit pub_methods_classwx_help_controller_base"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_controller_base.html#a416082870baafe1719ee4af2a9c50a26">DisplayTextPopup</a> (const <a class="el" href="classwx_string.html">wxString</a> &text, const <a class="el" href="classwx_point.html">wxPoint</a> &pos)</td></tr>
<tr class="memdesc:a416082870baafe1719ee4af2a9c50a26 inherit pub_methods_classwx_help_controller_base"><td class="mdescLeft"> </td><td class="mdescRight">Displays the text in a popup window, if possible. <a href="#a416082870baafe1719ee4af2a9c50a26"></a><br/></td></tr>
<tr class="separator:a416082870baafe1719ee4af2a9c50a26 inherit pub_methods_classwx_help_controller_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a756498b71be6d604e358551ad2d2289e inherit pub_methods_classwx_help_controller_base"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classwx_frame.html">wxFrame</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_controller_base.html#a756498b71be6d604e358551ad2d2289e">GetFrameParameters</a> (<a class="el" href="classwx_size.html">wxSize</a> *size=NULL, <a class="el" href="classwx_point.html">wxPoint</a> *pos=NULL, bool *newFrameEachTime=NULL)</td></tr>
<tr class="memdesc:a756498b71be6d604e358551ad2d2289e inherit pub_methods_classwx_help_controller_base"><td class="mdescLeft"> </td><td class="mdescRight">For <a class="el" href="classwx_html_help_controller.html" title="This help controller provides an easy way of displaying HTML help in your application (see HTML Sampl...">wxHtmlHelpController</a>, returns the latest frame size and position settings and whether a new frame is drawn with each invocation. <a href="#a756498b71be6d604e358551ad2d2289e"></a><br/></td></tr>
<tr class="separator:a756498b71be6d604e358551ad2d2289e inherit pub_methods_classwx_help_controller_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae5d5da2c6d5c0eb23b31070d3abc158f inherit pub_methods_classwx_help_controller_base"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classwx_window.html">wxWindow</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_controller_base.html#ae5d5da2c6d5c0eb23b31070d3abc158f">GetParentWindow</a> () const </td></tr>
<tr class="memdesc:ae5d5da2c6d5c0eb23b31070d3abc158f inherit pub_methods_classwx_help_controller_base"><td class="mdescLeft"> </td><td class="mdescRight">Returns the window to be used as the parent for the help window. <a href="#ae5d5da2c6d5c0eb23b31070d3abc158f"></a><br/></td></tr>
<tr class="separator:ae5d5da2c6d5c0eb23b31070d3abc158f inherit pub_methods_classwx_help_controller_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a725195abad79988412d6f9708cee9641 inherit pub_methods_classwx_help_controller_base"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_controller_base.html#a725195abad79988412d6f9708cee9641">KeywordSearch</a> (const <a class="el" href="classwx_string.html">wxString</a> &keyWord, <a class="el" href="help_8h.html#a6545e1763e46507e94ca603a9b75ead9">wxHelpSearchMode</a> mode=<a class="el" href="help_8h.html#a6545e1763e46507e94ca603a9b75ead9aa0d270468c352bcf71beda6a6fd543b9">wxHELP_SEARCH_ALL</a>)=0</td></tr>
<tr class="memdesc:a725195abad79988412d6f9708cee9641 inherit pub_methods_classwx_help_controller_base"><td class="mdescLeft"> </td><td class="mdescRight">If the help viewer is not running, runs it, and searches for sections matching the given keyword. <a href="#a725195abad79988412d6f9708cee9641"></a><br/></td></tr>
<tr class="separator:a725195abad79988412d6f9708cee9641 inherit pub_methods_classwx_help_controller_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9c43cb16bb10f3dd70b75e73996189b6 inherit pub_methods_classwx_help_controller_base"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_controller_base.html#a9c43cb16bb10f3dd70b75e73996189b6">LoadFile</a> (const <a class="el" href="classwx_string.html">wxString</a> &file=<a class="el" href="interface_2wx_2string_8h.html#a9a321d587166a30017b608dd2d234033">wxEmptyString</a>)=0</td></tr>
<tr class="memdesc:a9c43cb16bb10f3dd70b75e73996189b6 inherit pub_methods_classwx_help_controller_base"><td class="mdescLeft"> </td><td class="mdescRight">If the help viewer is not running, runs it and loads the given file. <a href="#a9c43cb16bb10f3dd70b75e73996189b6"></a><br/></td></tr>
<tr class="separator:a9c43cb16bb10f3dd70b75e73996189b6 inherit pub_methods_classwx_help_controller_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe4eee3105ed7529420cde766a156a13 inherit pub_methods_classwx_help_controller_base"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_controller_base.html#afe4eee3105ed7529420cde766a156a13">OnQuit</a> ()</td></tr>
<tr class="memdesc:afe4eee3105ed7529420cde766a156a13 inherit pub_methods_classwx_help_controller_base"><td class="mdescLeft"> </td><td class="mdescRight">Overridable member called when this application's viewer is quit by the user. <a href="#afe4eee3105ed7529420cde766a156a13"></a><br/></td></tr>
<tr class="separator:afe4eee3105ed7529420cde766a156a13 inherit pub_methods_classwx_help_controller_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a66380fa26b81c64bb3ead8b22ae620cb inherit pub_methods_classwx_help_controller_base"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_controller_base.html#a66380fa26b81c64bb3ead8b22ae620cb">Quit</a> ()=0</td></tr>
<tr class="memdesc:a66380fa26b81c64bb3ead8b22ae620cb inherit pub_methods_classwx_help_controller_base"><td class="mdescLeft"> </td><td class="mdescRight">If the viewer is running, quits it by disconnecting. <a href="#a66380fa26b81c64bb3ead8b22ae620cb"></a><br/></td></tr>
<tr class="separator:a66380fa26b81c64bb3ead8b22ae620cb inherit pub_methods_classwx_help_controller_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ea0be94d89b1c8171865cb5d956e39e inherit pub_methods_classwx_help_controller_base"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_controller_base.html#a7ea0be94d89b1c8171865cb5d956e39e">SetFrameParameters</a> (const <a class="el" href="classwx_string.html">wxString</a> &titleFormat, const <a class="el" href="classwx_size.html">wxSize</a> &size, const <a class="el" href="classwx_point.html">wxPoint</a> &pos=<a class="el" href="gdicmn_8h.html#af5a90c753eaf3d3e3e5068a19ec3c1d0">wxDefaultPosition</a>, bool newFrameEachTime=false)</td></tr>
<tr class="memdesc:a7ea0be94d89b1c8171865cb5d956e39e inherit pub_methods_classwx_help_controller_base"><td class="mdescLeft"> </td><td class="mdescRight">Set the parameters of the frame window. <a href="#a7ea0be94d89b1c8171865cb5d956e39e"></a><br/></td></tr>
<tr class="separator:a7ea0be94d89b1c8171865cb5d956e39e inherit pub_methods_classwx_help_controller_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8cb9ceb25ef38343812758131d4c464f inherit pub_methods_classwx_help_controller_base"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_controller_base.html#a8cb9ceb25ef38343812758131d4c464f">SetParentWindow</a> (<a class="el" href="classwx_window.html">wxWindow</a> *parentWindow)</td></tr>
<tr class="memdesc:a8cb9ceb25ef38343812758131d4c464f inherit pub_methods_classwx_help_controller_base"><td class="mdescLeft"> </td><td class="mdescRight">Sets the window to be used as the parent for the help window. <a href="#a8cb9ceb25ef38343812758131d4c464f"></a><br/></td></tr>
<tr class="separator:a8cb9ceb25ef38343812758131d4c464f inherit pub_methods_classwx_help_controller_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac8c3e391bdf373ece23ac69dcc59d874 inherit pub_methods_classwx_help_controller_base"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_controller_base.html#ac8c3e391bdf373ece23ac69dcc59d874">SetViewer</a> (const <a class="el" href="classwx_string.html">wxString</a> &viewer, long flags=<a class="el" href="help_8h.html#acd0d0af47426ef60ed7f286ff8b7a8e8">wxHELP_NETSCAPE</a>)</td></tr>
<tr class="memdesc:ac8c3e391bdf373ece23ac69dcc59d874 inherit pub_methods_classwx_help_controller_base"><td class="mdescLeft"> </td><td class="mdescRight">Sets detailed viewer information. <a href="#ac8c3e391bdf373ece23ac69dcc59d874"></a><br/></td></tr>
<tr class="separator:ac8c3e391bdf373ece23ac69dcc59d874 inherit pub_methods_classwx_help_controller_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac7a8fa6e2f659cdca5863f8a3e35e1f0 inherit pub_methods_classwx_help_controller_base"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_controller_base.html#ac7a8fa6e2f659cdca5863f8a3e35e1f0">Initialize</a> (const <a class="el" href="classwx_string.html">wxString</a> &file)</td></tr>
<tr class="memdesc:ac7a8fa6e2f659cdca5863f8a3e35e1f0 inherit pub_methods_classwx_help_controller_base"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the help instance with a help filename, and optionally a server socket number if using wxHelp (now obsolete). <a href="#ac7a8fa6e2f659cdca5863f8a3e35e1f0"></a><br/></td></tr>
<tr class="separator:ac7a8fa6e2f659cdca5863f8a3e35e1f0 inherit pub_methods_classwx_help_controller_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae637c7add0d5f48544c72d8982691568 inherit pub_methods_classwx_help_controller_base"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_help_controller_base.html#ae637c7add0d5f48544c72d8982691568">Initialize</a> (const <a class="el" href="classwx_string.html">wxString</a> &file, int server)</td></tr>
<tr class="memdesc:ae637c7add0d5f48544c72d8982691568 inherit pub_methods_classwx_help_controller_base"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the help instance with a help filename, and optionally a server socket number if using wxHelp (now obsolete). <a href="#ae637c7add0d5f48544c72d8982691568"></a><br/></td></tr>
<tr class="separator:ae637c7add0d5f48544c72d8982691568 inherit pub_methods_classwx_help_controller_base"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classwx_object"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classwx_object')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classwx_object.html">wxObject</a></td></tr>
<tr class="memitem:acaa378363a28af421ab56ad7b46eadf0 inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#acaa378363a28af421ab56ad7b46eadf0">wxObject</a> ()</td></tr>
<tr class="memdesc:acaa378363a28af421ab56ad7b46eadf0 inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Default ctor; initializes to <span class="literal">NULL</span> the internal reference data. <a href="#acaa378363a28af421ab56ad7b46eadf0"></a><br/></td></tr>
<tr class="separator:acaa378363a28af421ab56ad7b46eadf0 inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4721b4dc9b7aff0f30904ba2ea3954cf inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a4721b4dc9b7aff0f30904ba2ea3954cf">wxObject</a> (const <a class="el" href="classwx_object.html">wxObject</a> &other)</td></tr>
<tr class="memdesc:a4721b4dc9b7aff0f30904ba2ea3954cf inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Copy ctor. <a href="#a4721b4dc9b7aff0f30904ba2ea3954cf"></a><br/></td></tr>
<tr class="separator:a4721b4dc9b7aff0f30904ba2ea3954cf inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2a51aa8bfbab47ca2f051bcf84b3f35b inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a2a51aa8bfbab47ca2f051bcf84b3f35b">~wxObject</a> ()</td></tr>
<tr class="memdesc:a2a51aa8bfbab47ca2f051bcf84b3f35b inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a2a51aa8bfbab47ca2f051bcf84b3f35b"></a><br/></td></tr>
<tr class="separator:a2a51aa8bfbab47ca2f051bcf84b3f35b inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab3a0c6f723cbaddb47be4e8dd98cc8e2 inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classwx_class_info.html">wxClassInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#ab3a0c6f723cbaddb47be4e8dd98cc8e2">GetClassInfo</a> () const </td></tr>
<tr class="memdesc:ab3a0c6f723cbaddb47be4e8dd98cc8e2 inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">This virtual function is redefined for every class that requires run-time type information, when using the <a class="el" href="group__group__funcmacro__rtti.html#ga20465fc7e022e29a5dacfad46e152e75" title="Used inside a class declaration to declare that the class should be made known to the class hierarchy...">wxDECLARE_CLASS</a> macro (or similar). <a href="#ab3a0c6f723cbaddb47be4e8dd98cc8e2"></a><br/></td></tr>
<tr class="separator:ab3a0c6f723cbaddb47be4e8dd98cc8e2 inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aabdb4fc957226544a8408167844e4f42 inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwx_object_ref_data.html">wxObjectRefData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#aabdb4fc957226544a8408167844e4f42">GetRefData</a> () const </td></tr>
<tr class="memdesc:aabdb4fc957226544a8408167844e4f42 inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="classwx_object.html#a9e31954530a0abd54982effc443ed2b8" title="Pointer to an object which is the object's reference-counted data.">wxObject::m_refData</a> pointer, i.e. the data referenced by this object. <a href="#aabdb4fc957226544a8408167844e4f42"></a><br/></td></tr>
<tr class="separator:aabdb4fc957226544a8408167844e4f42 inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af40d580385cf4f8112fae7713404b01e inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#af40d580385cf4f8112fae7713404b01e">IsKindOf</a> (const <a class="el" href="classwx_class_info.html">wxClassInfo</a> *info) const </td></tr>
<tr class="memdesc:af40d580385cf4f8112fae7713404b01e inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether this class is a subclass of (or the same class as) the given class. <a href="#af40d580385cf4f8112fae7713404b01e"></a><br/></td></tr>
<tr class="separator:af40d580385cf4f8112fae7713404b01e inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a80a1a3fda7b14396a9ddd3d7a46a88bd inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a80a1a3fda7b14396a9ddd3d7a46a88bd">IsSameAs</a> (const <a class="el" href="classwx_object.html">wxObject</a> &obj) const </td></tr>
<tr class="memdesc:a80a1a3fda7b14396a9ddd3d7a46a88bd inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Returns <span class="literal">true</span> if this object has the same data pointer as <em>obj</em>. <a href="#a80a1a3fda7b14396a9ddd3d7a46a88bd"></a><br/></td></tr>
<tr class="separator:a80a1a3fda7b14396a9ddd3d7a46a88bd inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f6f1aa51fe9fc2b1415ca4211a90e9e inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a2f6f1aa51fe9fc2b1415ca4211a90e9e">Ref</a> (const <a class="el" href="classwx_object.html">wxObject</a> &clone)</td></tr>
<tr class="memdesc:a2f6f1aa51fe9fc2b1415ca4211a90e9e inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Makes this object refer to the data in <em>clone</em>. <a href="#a2f6f1aa51fe9fc2b1415ca4211a90e9e"></a><br/></td></tr>
<tr class="separator:a2f6f1aa51fe9fc2b1415ca4211a90e9e inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afab780710f2adc1bb33310e27590140b inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#afab780710f2adc1bb33310e27590140b">SetRefData</a> (<a class="el" href="classwx_object_ref_data.html">wxObjectRefData</a> *data)</td></tr>
<tr class="memdesc:afab780710f2adc1bb33310e27590140b inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Sets the <a class="el" href="classwx_object.html#a9e31954530a0abd54982effc443ed2b8" title="Pointer to an object which is the object's reference-counted data.">wxObject::m_refData</a> pointer. <a href="#afab780710f2adc1bb33310e27590140b"></a><br/></td></tr>
<tr class="separator:afab780710f2adc1bb33310e27590140b inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af51efc6b1ae632fc7f0cd7ebbce9fa36 inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#af51efc6b1ae632fc7f0cd7ebbce9fa36">UnRef</a> ()</td></tr>
<tr class="memdesc:af51efc6b1ae632fc7f0cd7ebbce9fa36 inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Decrements the reference count in the associated data, and if it is zero, deletes the data. <a href="#af51efc6b1ae632fc7f0cd7ebbce9fa36"></a><br/></td></tr>
<tr class="separator:af51efc6b1ae632fc7f0cd7ebbce9fa36 inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a74b40e42d19a4b9e9bec0b57d62a5725 inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a74b40e42d19a4b9e9bec0b57d62a5725">UnShare</a> ()</td></tr>
<tr class="memdesc:a74b40e42d19a4b9e9bec0b57d62a5725 inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">This is the same of <a class="el" href="classwx_object.html#a60204063f3cc3aa2fa1c7ff5bda9eb13" title="Ensure that this object's data is not shared with any other object.">AllocExclusive()</a> but this method is public. <a href="#a74b40e42d19a4b9e9bec0b57d62a5725"></a><br/></td></tr>
<tr class="separator:a74b40e42d19a4b9e9bec0b57d62a5725 inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a07b8f34f5afc5743195c5fed052f55d3 inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a07b8f34f5afc5743195c5fed052f55d3">operator delete</a> (void *buf)</td></tr>
<tr class="memdesc:a07b8f34f5afc5743195c5fed052f55d3 inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">The <em>delete</em> operator is defined for debugging versions of the library only, when the identifier <code><b>WXDEBUG</b></code> is defined. <a href="#a07b8f34f5afc5743195c5fed052f55d3"></a><br/></td></tr>
<tr class="separator:a07b8f34f5afc5743195c5fed052f55d3 inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a96fa423a1dbc212c8227a5d83825971f inherit pub_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a96fa423a1dbc212c8227a5d83825971f">operator new</a> (size_t size, const <a class="el" href="classwx_string.html">wxString</a> &filename=NULL, int lineNum=0)</td></tr>
<tr class="memdesc:a96fa423a1dbc212c8227a5d83825971f inherit pub_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">The <em>new</em> operator is defined for debugging versions of the library only, when the identifier <code><b>WXDEBUG</b></code> is defined. <a href="#a96fa423a1dbc212c8227a5d83825971f"></a><br/></td></tr>
<tr class="separator:a96fa423a1dbc212c8227a5d83825971f inherit pub_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classwx_object"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classwx_object')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classwx_object.html">wxObject</a></td></tr>
<tr class="memitem:a60204063f3cc3aa2fa1c7ff5bda9eb13 inherit pro_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a60204063f3cc3aa2fa1c7ff5bda9eb13">AllocExclusive</a> ()</td></tr>
<tr class="memdesc:a60204063f3cc3aa2fa1c7ff5bda9eb13 inherit pro_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Ensure that this object's data is not shared with any other object. <a href="#a60204063f3cc3aa2fa1c7ff5bda9eb13"></a><br/></td></tr>
<tr class="separator:a60204063f3cc3aa2fa1c7ff5bda9eb13 inherit pro_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a95c6a5e4e1e03ff23c7b9efe4cff0c1a inherit pro_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classwx_object_ref_data.html">wxObjectRefData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a95c6a5e4e1e03ff23c7b9efe4cff0c1a">CreateRefData</a> () const </td></tr>
<tr class="memdesc:a95c6a5e4e1e03ff23c7b9efe4cff0c1a inherit pro_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. <a href="#a95c6a5e4e1e03ff23c7b9efe4cff0c1a"></a><br/></td></tr>
<tr class="separator:a95c6a5e4e1e03ff23c7b9efe4cff0c1a inherit pro_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1d39f1d3650fe0982c9a1abe7f9fe7b7 inherit pro_methods_classwx_object"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classwx_object_ref_data.html">wxObjectRefData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a1d39f1d3650fe0982c9a1abe7f9fe7b7">CloneRefData</a> (const <a class="el" href="classwx_object_ref_data.html">wxObjectRefData</a> *data) const </td></tr>
<tr class="memdesc:a1d39f1d3650fe0982c9a1abe7f9fe7b7 inherit pro_methods_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying <em>data</em>. <a href="#a1d39f1d3650fe0982c9a1abe7f9fe7b7"></a><br/></td></tr>
<tr class="separator:a1d39f1d3650fe0982c9a1abe7f9fe7b7 inherit pro_methods_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_attribs_classwx_object"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classwx_object')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classwx_object.html">wxObject</a></td></tr>
<tr class="memitem:a9e31954530a0abd54982effc443ed2b8 inherit pro_attribs_classwx_object"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classwx_object_ref_data.html">wxObjectRefData</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwx_object.html#a9e31954530a0abd54982effc443ed2b8">m_refData</a></td></tr>
<tr class="memdesc:a9e31954530a0abd54982effc443ed2b8 inherit pro_attribs_classwx_object"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to an object which is the object's reference-counted data. <a href="#a9e31954530a0abd54982effc443ed2b8"></a><br/></td></tr>
<tr class="separator:a9e31954530a0abd54982effc443ed2b8 inherit pro_attribs_classwx_object"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a33ea318ec42fbe28b84abfec61094209"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">wxHelpController::wxHelpController </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classwx_window.html">wxWindow</a> * </td>
<td class="paramname"><em>parentWindow</em> = <code>NULL</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a help instance object, but does not invoke the help viewer. </p>
<p>If you provide a window, it will be used by some help controller classes, such as wxCHMHelpController, wxWinHelpController and <a class="el" href="classwx_html_help_controller.html" title="This help controller provides an easy way of displaying HTML help in your application (see HTML Sampl...">wxHtmlHelpController</a>, as the parent for the help window instead of the value of <a class="el" href="classwx_app.html#abc2b3305178f59f4024f492855c1bfdc" title="Returns a pointer to the top window.">wxApp::GetTopWindow</a>.</p>
<p>You can also change the parent window later with <a class="el" href="classwx_help_controller_base.html#a8cb9ceb25ef38343812758131d4c464f" title="Sets the window to be used as the parent for the help window.">SetParentWindow()</a>. </p>
</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>
|
