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