]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/hthlpfrm.tex
test indeterminate wxGauge mode (part of patch 1551409)
[wxWidgets.git] / docs / latex / wx / hthlpfrm.tex
1 %
2 % automatically generated by HelpGen from
3 % helpfrm.h at 24/Oct/99 18:03:10
4 %
5
6 \section{\class{wxHtmlHelpDialog}}\label{wxhtmlhelpdialog}
7
8 This class is used by \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}
9 to display help.
10 It is an internal class and should not be used directly - except for the case
11 when you're writing your own HTML help controller.
12
13 \wxheading{Derived from}
14
15 \helpref{wxFrame}{wxframe}
16
17 \wxheading{Include files}
18
19 <wx/html/helpdlg.h>
20
21 \latexignore{\rtfignore{\wxheading{Members}}}
22
23 \membersection{wxHtmlHelpDialog::wxHtmlHelpDialog}\label{wxhtmlhelpdialogwxhtmlhelpdialog}
24
25 \func{}{wxHtmlHelpDialog}{\param{wxHtmlHelpData* }{data = NULL}}
26
27 \func{}{wxHtmlHelpDialog}{\param{wxWindow* }{parent}, \param{int }{wxWindowID}, \param{const wxString\& }{title = wxEmptyString}, \param{int }{style = wxHF\_DEFAULT\_STYLE}, \param{wxHtmlHelpData* }{data = NULL}}
28
29 Constructor. For the values of {\it style}, please see the documentation for \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}.
30
31 \membersection{wxHtmlHelpDialog::AddToolbarButtons}\label{wxhtmlhelpdialogaddtoolbarbuttons}
32
33 \func{virtual void}{AddToolbarButtons}{\param{wxToolBar *}{toolBar}, \param{int }{style}}
34
35 You may override this virtual method to add more buttons to the help window's
36 toolbar. {\it toolBar} is a pointer to the toolbar and {\it style} is the style
37 flag as passed to the Create method.
38
39 wxToolBar::Realize is called immediately after returning from this function.
40
41 \membersection{wxHtmlHelpDialog::Create}\label{wxhtmlhelpdialogcreate}
42
43 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{title = wxEmptyString}, \param{int }{style = wxHF\_DEFAULT\_STYLE}}
44
45 Creates the dialog. See \helpref{the constructor}{wxhtmlhelpdialogwxhtmlhelpdialog}
46 for a description of the parameters.
47
48 \membersection{wxHtmlHelpDialog::GetController}\label{wxhtmlhelpdialoggetcontroller}
49
50 \constfunc{wxHtmlHelpController* }{GetController}{\void}
51
52 Returns the help controller associated with the dialog.
53
54 \membersection{wxHtmlHelpDialog::ReadCustomization}\label{wxhtmlhelpdialogreadcustomization}
55
56 \func{void}{ReadCustomization}{\param{wxConfigBase* }{cfg}, \param{const wxString\& }{path = wxEmptyString}}
57
58 Reads the user's settings for this dialog see \helpref{wxHtmlHelpController::ReadCustomization}{wxhtmlhelpcontrollerreadcustomization})
59
60 \membersection{wxHtmlHelpDialog::SetController}\label{wxhtmlhelpdialogsetcontroller}
61
62 \func{void}{SetController}{\param{wxHtmlHelpController* }{contoller}}
63
64 Sets the help controller associated with the dialog.
65
66 \membersection{wxHtmlHelpDialog::SetTitleFormat}\label{wxhtmlhelpdialogsettitleformat}
67
68 \func{void}{SetTitleFormat}{\param{const wxString\& }{format}}
69
70 Sets the dialog's title format. {\it format} must contain exactly one "\%s"
71 (it will be replaced by the page title).
72
73 \membersection{wxHtmlHelpDialog::WriteCustomization}\label{wxhtmlhelpdialogwritecustomization}
74
75 \func{void}{WriteCustomization}{\param{wxConfigBase* }{cfg}, \param{const wxString\& }{path = wxEmptyString}}
76
77 Saves the user's settings for this dialog (see \helpref{wxHtmlHelpController::WriteCustomization}{wxhtmlhelpcontrollerwritecustomization}).
78
79 \section{\class{wxHtmlHelpFrame}}\label{wxhtmlhelpframe}
80
81 This class is used by \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}
82 to display help.
83 It is an internal class and should not be used directly - except for the case
84 when you're writing your own HTML help controller.
85
86 \wxheading{Derived from}
87
88 \helpref{wxFrame}{wxframe}
89
90 \wxheading{Include files}
91
92 <wx/html/helpfrm.h>
93
94 \latexignore{\rtfignore{\wxheading{Members}}}
95
96 \membersection{wxHtmlHelpFrame::wxHtmlHelpFrame}\label{wxhtmlhelpframewxhtmlhelpframe}
97
98 \func{}{wxHtmlHelpFrame}{\param{wxHtmlHelpData* }{data = NULL}}
99
100 \func{}{wxHtmlHelpFrame}{\param{wxWindow* }{parent}, \param{int }{wxWindowID}, \param{const wxString\& }{title = wxEmptyString}, \param{int }{style = wxHF\_DEFAULT\_STYLE}, \param{wxHtmlHelpData* }{data = NULL}}
101
102 Constructor. For the values of {\it style}, please see the documentation for \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}.
103
104 \membersection{wxHtmlHelpFrame::AddToolbarButtons}\label{wxhtmlhelpframeaddtoolbarbuttons}
105
106 \func{virtual void}{AddToolbarButtons}{\param{wxToolBar *}{toolBar}, \param{int }{style}}
107
108 You may override this virtual method to add more buttons to the help window's
109 toolbar. {\it toolBar} is a pointer to the toolbar and {\it style} is the style
110 flag as passed to the Create method.
111
112 wxToolBar::Realize is called immediately after returning from this function.
113
114 \membersection{wxHtmlHelpFrame::Create}\label{wxhtmlhelpframecreate}
115
116 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{title = wxEmptyString}, \param{int }{style = wxHF\_DEFAULT\_STYLE}}
117
118 Creates the frame. See \helpref{the constructor}{wxhtmlhelpframewxhtmlhelpframe}
119 for a description of the parameters.
120
121 \membersection{wxHtmlHelpFrame::GetController}\label{wxhtmlhelpframegetcontroller}
122
123 \constfunc{wxHtmlHelpController* }{GetController}{\void}
124
125 Returns the help controller associated with the frame.
126
127 \membersection{wxHtmlHelpFrame::ReadCustomization}\label{wxhtmlhelpframereadcustomization}
128
129 \func{void}{ReadCustomization}{\param{wxConfigBase* }{cfg}, \param{const wxString\& }{path = wxEmptyString}}
130
131 Reads the user's settings for this frame see \helpref{wxHtmlHelpController::ReadCustomization}{wxhtmlhelpcontrollerreadcustomization})
132
133 \membersection{wxHtmlHelpFrame::SetController}\label{wxhtmlhelpframesetcontroller}
134
135 \func{void}{SetController}{\param{wxHtmlHelpController* }{contoller}}
136
137 Sets the help controller associated with the frame.
138
139 \membersection{wxHtmlHelpFrame::SetTitleFormat}\label{wxhtmlhelpframesettitleformat}
140
141 \func{void}{SetTitleFormat}{\param{const wxString\& }{format}}
142
143 Sets the frame's title format. {\it format} must contain exactly one "\%s"
144 (it will be replaced by the page title).
145
146 \membersection{wxHtmlHelpFrame::WriteCustomization}\label{wxhtmlhelpframewritecustomization}
147
148 \func{void}{WriteCustomization}{\param{wxConfigBase* }{cfg}, \param{const wxString\& }{path = wxEmptyString}}
149
150 Saves the user's settings for this frame (see \helpref{wxHtmlHelpController::WriteCustomization}{wxhtmlhelpcontrollerwritecustomization}).
151
152 \section{\class{wxHtmlHelpWindow}}\label{wxhtmlhelpwindow}
153
154 This class is used by \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}
155 to display help within a frame or dialog, but you can use it yourself to create an embedded HTML help window.
156
157 For example:
158
159 \begin{verbatim}
160 // m_embeddedHelpWindow is a wxHtmlHelpWindow
161 // m_embeddedHtmlHelp is a wxHtmlHelpController
162
163 // Create embedded HTML Help window
164 m_embeddedHelpWindow = new wxHtmlHelpWindow;
165 m_embeddedHtmlHelp.UseConfig(config, rootPath); // Set your own config object here
166 m_embeddedHtmlHelp.SetHelpWindow(m_embeddedHelpWindow);
167 m_embeddedHelpWindow->Create(this,
168 wxID_ANY, wxDefaultPosition, GetClientSize(), wxTAB_TRAVERSAL|wxNO_BORDER, wxHF_DEFAULT_STYLE);
169 m_embeddedHtmlHelp.AddBook(wxFileName(_T("doc.zip")));
170 \end{verbatim}
171
172 You should pass the style wxHF\_EMBEDDED to the style parameter of wxHtmlHelpController to allow
173 the embedded window to be destroyed independently of the help controller.
174
175 \wxheading{Derived from}
176
177 \helpref{wxWindow}{wxwindow}
178
179 \wxheading{Include files}
180
181 <wx/html/helpwnd.h>
182
183 \latexignore{\rtfignore{\wxheading{Members}}}
184
185 \membersection{wxHtmlHelpWindow::wxHtmlHelpWindow}\label{wxhtmlhelpwindowwxhtmlhelpwindow}
186
187 \func{}{wxHtmlHelpWindow}{\param{wxHtmlHelpData* }{data = NULL}}
188
189 \func{}{wxHtmlHelpWindow}{\param{wxWindow* }{parent}, \param{int }{wxWindowID}, \param{int }{style = wxHF\_DEFAULT\_STYLE}, \param{wxHtmlHelpData* }{data = NULL}}
190
191 Constructor.
192
193 Constructor. For the values of {\it style}, please see the documentation for \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}.
194
195 \membersection{wxHtmlHelpWindow::Create}\label{wxhtmlhelpwindowcreate}
196
197 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{title = wxEmptyString}, \param{int }{style = wxHF\_DEFAULT\_STYLE}}
198
199 Creates the frame. See \helpref{the constructor}{wxhtmlhelpwindowwxhtmlhelpwindow}
200 for a description of the parameters.
201
202 \membersection{wxHtmlHelpWindow::CreateContents}\label{wxhtmlhelpwindowcreatecontents}
203
204 \func{void}{CreateContents}{\void}
205
206 Creates contents panel. (May take some time.)
207
208 Protected.
209
210 \membersection{wxHtmlHelpWindow::CreateIndex}\label{wxhtmlhelpwindowcreateindex}
211
212 \func{void}{CreateIndex}{\void}
213
214 Creates index panel. (May take some time.)
215
216 Protected.
217
218 \membersection{wxHtmlHelpWindow::CreateSearch}\label{wxhtmlhelpwindowcreatesearch}
219
220 \func{void}{CreateSearch}{\void}
221
222 Creates search panel.
223
224 \membersection{wxHtmlHelpWindow::Display}\label{wxhtmlhelpwindowdisplay}
225
226 \func{bool}{Display}{\param{const wxString\& }{x}}
227
228 \func{bool}{Display}{\param{const int }{id}}
229
230 Displays page x. If not found it will give the user the choice of
231 searching books.
232 Looking for the page runs in these steps:
233
234 \begin{enumerate}\itemsep=0pt
235 \item try to locate file named x (if x is for example "doc/howto.htm")
236 \item try to open starting page of book x
237 \item try to find x in contents (if x is for example "How To ...")
238 \item try to find x in index (if x is for example "How To ...")
239 \end{enumerate}
240
241 The second form takes numeric ID as the parameter.
242 (uses extension to MS format, <param name="ID" value=id>)
243
244 \pythonnote{The second form of this method is named DisplayId in
245 wxPython.}
246
247 \membersection{wxHtmlHelpWindow::DisplayContents}\label{wxhtmlhelpwindowdisplaycontents}
248
249 \func{bool}{DisplayContents}{\void}
250
251 Displays contents panel.
252
253 \membersection{wxHtmlHelpWindow::DisplayIndex}\label{wxhtmlhelpwindowdisplayindex}
254
255 \func{bool}{DisplayIndex}{\void}
256
257 Displays index panel.
258
259 \membersection{wxHtmlHelpWindow::GetData}\label{wxhtmlhelpwindowgetdata}
260
261 \func{wxHtmlHelpData*}{GetData}{\void}
262
263 Returns the wxHtmlHelpData object, which is usually a pointer to the controller's data.
264
265 \membersection{wxHtmlHelpWindow::KeywordSearch}\label{wxhtmlhelpwindowkeywordsearch}
266
267 \func{bool}{KeywordSearch}{\param{const wxString\& }{keyword}, \param{wxHelpSearchMode }{mode = wxHELP\_SEARCH\_ALL}}
268
269 Search for given keyword. Optionally it searches through the index (mode =
270 wxHELP\_SEARCH\_INDEX), default the content (mode = wxHELP\_SEARCH\_ALL).
271
272 \membersection{wxHtmlHelpWindow::ReadCustomization}\label{wxhtmlhelpwindowreadcustomization}
273
274 \func{void}{ReadCustomization}{\param{wxConfigBase* }{cfg}, \param{const wxString\& }{path = wxEmptyString}}
275
276 Reads the user's settings for this window (see \helpref{wxHtmlHelpController::ReadCustomization}{wxhtmlhelpcontrollerreadcustomization})
277
278 \membersection{wxHtmlHelpWindow::RefreshLists}\label{wxhtmlhelpwindowrefreshlists}
279
280 \func{void}{RefreshLists}{\void}
281
282 Refresh all panels. This is necessary if a new book was added.
283
284 Protected.
285
286 \membersection{wxHtmlHelpWindow::SetTitleFormat}\label{wxhtmlhelpwindowsettitleformat}
287
288 \func{void}{SetTitleFormat}{\param{const wxString\& }{format}}
289
290 Sets the frame's title format. {\it format} must contain exactly one "\%s"
291 (it will be replaced by the page title).
292
293 \membersection{wxHtmlHelpWindow::UseConfig}\label{wxhtmlhelpwindowuseconfig}
294
295 \func{void}{UseConfig}{\param{wxConfigBase* }{config}, \param{const wxString\& }{rootpath = wxEmptyString}}
296
297 Associates a wxConfig object with the help window. It is recommended that you use \helpref{wxHtmlHelpController::UseConfig}{wxhtmlhelpcontrolleruseconfig} instead.
298
299 \membersection{wxHtmlHelpWindow::WriteCustomization}\label{wxhtmlhelpwindowwritecustomization}
300
301 \func{void}{WriteCustomization}{\param{wxConfigBase* }{cfg}, \param{const wxString\& }{path = wxEmptyString}}
302
303 Saves the user's settings for this window(see \helpref{wxHtmlHelpController::WriteCustomization}{wxhtmlhelpcontrollerwritecustomization}).
304
305 \membersection{wxHtmlHelpWindow::AddToolbarButtons}\label{wxhtmlhelpwindowaddtoolbarbuttons}
306
307 \func{virtual void}{AddToolbarButtons}{\param{wxToolBar *}{toolBar}, \param{int }{style}}
308
309 You may override this virtual method to add more buttons to the help window's
310 toolbar. {\it toolBar} is a pointer to the toolbar and {\it style} is the style
311 flag as passed to the Create method.
312
313 wxToolBar::Realize is called immediately after returning from this function.
314
315 See {\it samples/html/helpview} for an example.
316
317 \section{\class{wxHtmlModalHelp}}\label{wxhtmlmodalhelp}
318
319 This class uses \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}
320 to display help in a modal dialog. This is useful on platforms such as wxMac
321 where if you display help from a modal dialog, the help window must itself be a modal
322 dialog.
323
324 Create objects of this class on the stack, for example:
325
326 \begin{verbatim}
327 // The help can be browsed during the lifetime of this object; when the user quits
328 // the help, program execution will continue.
329 wxHtmlModalHelp help(parent, wxT("help"), wxT("My topic"));
330 \end{verbatim}
331
332 \wxheading{Derived from}
333
334 None
335
336 \wxheading{Include files}
337
338 <wx/html/helpctrl.h>
339
340 \latexignore{\rtfignore{\wxheading{Members}}}
341
342 \membersection{wxHtmlModalHelp::wxHtmlModalHelp}\label{wxhtmlmodalhelpctor}
343
344 \func{}{wxHtmlModalHelp}{\param{wxWindow* }{parent}, \param{const wxString\& }{helpFile}, \param{const wxString\& }{topic = wxEmptyString},
345 \param{int }{style = wxHF\_DEFAULT\_STYLE | wxHF\_DIALOG | wxHF\_MODAL}}
346
347 \wxheading{Parameters}
348
349 {\it parent} is the parent of the dialog.
350
351 {\it helpFile} is the HTML help file to show.
352
353 {\it topic} is an optional topic. If this is empty, the help contents will be shown.
354
355 {\it style} is a combination of the flags described in the \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} documentation.
356
357