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