docs/latex/wx/hthelpct.tex

   1 %
   2 % automatically generated by HelpGen from
   3 % htmlhelp.h at 02/May/99 19:58:53
   4 %
   5
   6 \section{\class{wxHtmlHelpController}}\label{wxhtmlhelpcontroller}
   7
   8 {\bf WARNING! This help controller has an API incompatible with wxWindows
   9 wxHelpController!}
  10
  11 This help controller provides an easy way of displaying HTML help in your
  12 application (see {\it test} sample). The help system is based on {\bf books}
  13 (see \helpref{AddBook}{wxhtmlhelpcontrolleraddbook}). A book is a logical
  14 section of documentation (for example "User's Guide" or "Programmer's Guide" or
  15 "C++ Reference" or "wxWindows Reference"). The help controller can handle as
  16 many books as you want.
  17
  18 wxHTML uses Microsoft's HTML Help Workshop project files (.hhp, .hhk, .hhc) as its
  19 native format. The file format is described \helpref{here}{helpformat}.
  20 Have a look at docs/html/ directory where sample project files are stored.
  21
  22 You can use Tex2RTF to produce these files when generating HTML, if you set {\bf htmlWorkshopFiles} to {\bf true} in
  23 your tex2rtf.ini file.
  24
  25 In order to use the controller in your application under Windows you must
  26 have the following line in your .rc file:
  27
  28 \begin{verbatim}
  29 #include "wx/html/msw/wxhtml.rc"
  30 \end{verbatim}
  31
  32 \wxheading{Note}
  33
  34 It is strongly recommended to use preprocessed {\bf .hhp.cached} version of
  35 projects. It can be either created on-the-fly (see
  36 \helpref{SetTempDir}{wxhtmlhelpcontrollersettempdir}) or you can use
  37 {\bf hhp2cached} utility from {\it utils/hhp2cached} to create it and
  38 distribute the cached version together with helpfiles. See {\it samples/html/help}
  39 sample for demonstration of its use.
  40
  41 \wxheading{Derived from}
  42
  43 \helpref{wxEvtHandler}{wxevthandler}
  44
  45 \wxheading{Include files}
  46
  47 <wx/html/helpctrl.h>
  48
  49 \latexignore{\rtfignore{\wxheading{Members}}}
  50
  51 \membersection{wxHtmlHelpController::wxHtmlHelpController}\label{wxhtmlhelpcontrollerwxhtmlhelpcontroller}
  52
  53 \func{}{wxHtmlHelpController}{\param{int }{style = wxHF\_DEFAULTSTYLE}}
  54
  55 Constructor.
  56
  57 \wxheading{Parameters}
  58
  59 {\it style} is combination of these flags:
  60
  61 \begin{twocollist}\itemsep=0pt
  62 \twocolitem{\windowstyle{wxHF\_TOOLBAR}}{Help frame has toolbar.}
  63 \twocolitem{\windowstyle{wxHF\_CONTENTS}}{Help frame has contents panel.}
  64 \twocolitem{\windowstyle{wxHF\_INDEX}}{Help frame has index panel.}
  65 \twocolitem{\windowstyle{wxHF\_SEARCH}}{Help frame has search panel.}
  66 \twocolitem{\windowstyle{wxHF\_BOOKMARKS}}{Help frame has bookmarks controls.}
  67 \twocolitem{\windowstyle{wxHF\_OPENFILES}}{Allow user to open arbitrary HTML document.}
  68 \twocolitem{\windowstyle{wxHF\_PRINT}}{Toolbar contains "print" button.}
  69 \end{twocollist}
  70
  71 Default value: everything but wxHF\_OPENFILES enabled.
  72
  73 \membersection{wxHtmlHelpController::AddBook}\label{wxhtmlhelpcontrolleraddbook}
  74
  75 \func{bool}{AddBook}{\param{const wxString\& }{book}, \param{bool }{show\_wait\_msg}}
  76
  77 Adds book (\helpref{.hhp file}{helpformat} - HTML Help Workshop project file) into the list of loaded books.
  78 This must be called at least once before displaying  any help.
  79
  80 {\it book} may be either .hhp file or ZIP archive that contains arbitrary number of .hhp files in
  81 top-level directory. This ZIP archive must have .zip or .htb extension
  82 (the latter stands for "HTML book"). In other words, {\tt AddBook("help.zip")} is possible and, in fact,
  83 recommended way.
  84
  85 If {\it show\_wait\_msg} is TRUE then a decorationless window with progress message is displayed.
  86
  87 \membersection{wxHtmlHelpController::CreateHelpFrame}\label{wxhtmlhelpcontrollercreatehelpframe}
  88
  89 \func{virtual wxHtmlHelpFrame*}{CreateHelpFrame}{\param{wxHtmlHelpData * }{data}}
  90
  91 This protected virtual method may be overriden so that the controller
  92 uses slightly different frame. See {\it samples/html/helpview} sample for
  93 an example.
  94 \membersection{wxHtmlHelpController::Display}\label{wxhtmlhelpcontrollerdisplay}
  95
  96 \func{void}{Display}{\param{const wxString\& }{x}}
  97
  98 Displays page {\it x}. This is THE important function - it is used to display
  99 the help in application.
 100
 101 You can specify the page in many ways:
 102
 103 \begin{itemize}\itemsep=0pt
 104 \item as direct filename of HTML document
 105 \item as chapter name (from contents) or as a book name
 106 \item as some word from index
 107 \item even as any word (will be searched)
 108 \end{itemize}
 109
 110 Looking for the page runs in these steps:
 111
 112 \begin{enumerate}\itemsep=0pt
 113 \item try to locate file named x (if x is for example "doc/howto.htm")
 114 \item try to open starting page of book named x
 115 \item try to find x in contents (if x is for example "How To ...")
 116 \item try to find x in index (if x is for example "How To ...")
 117 \item switch to Search panel and start searching
 118 \end{enumerate}
 119
 120 \func{void}{Display}{\param{const int }{id}}
 121
 122 This alternative form is used to search help contents by numeric IDs.
 123
 124 \pythonnote{The second form of this method is named DisplayId in
 125 wxPython.}
 126
 127 \membersection{wxHtmlHelpController::DisplayContents}\label{wxhtmlhelpcontrollerdisplaycontents}
 128
 129 \func{void}{DisplayContents}{\void}
 130
 131 Displays help window and focuses contents panel.
 132
 133 \membersection{wxHtmlHelpController::DisplayIndex}\label{wxhtmlhelpcontrollerdisplayindex}
 134
 135 \func{void}{DisplayIndex}{\void}
 136
 137 Displays help window and focuses index panel.
 138
 139 \membersection{wxHtmlHelpController::KeywordSearch}\label{wxhtmlhelpcontrollerkeywordsearch}
 140
 141 \func{bool}{KeywordSearch}{\param{const wxString\& }{keyword}}
 142
 143 Displays help window, focuses search panel and starts searching.
 144 Returns TRUE if the keyword was found.
 145
 146 {\bf Important:} KeywordSearch searches only pages listed in .htc file(s).
 147 You should list all pages in the contents file.
 148
 149 \membersection{wxHtmlHelpController::ReadCustomization}\label{wxhtmlhelpcontrollerreadcustomization}
 150
 151 \func{void}{ReadCustomization}{\param{wxConfigBase* }{cfg}, \param{wxString }{path = wxEmptyString}}
 152
 153 Reads the controller's setting (position of window, etc.)
 154
 155 \membersection{wxHtmlHelpController::SetTempDir}\label{wxhtmlhelpcontrollersettempdir}
 156
 157 \func{void}{SetTempDir}{\param{const wxString\& }{path}}
 158
 159 Sets the path for storing temporary files - cached binary versions of index and contents files. These binary
 160 forms are much faster to read. Default value is empty string (empty string means
 161 that no cached data are stored). Note that these files are {\it not}
 162 deleted when program exits.
 163
 164 Once created these cached files will be used in all subsequent executions
 165 of your application. If cached files become older than corresponding .hhp
 166 file (e.g. if you regenerate documentation) it will be refreshed.
 167
 168 \membersection{wxHtmlHelpController::SetTitleFormat}\label{wxhtmlhelpcontrollersettitleformat}
 169
 170 \func{void}{SetTitleFormat}{\param{const wxString\& }{format}}
 171
 172 Sets format of title of the frame. Must contain exactly one "\%s"
 173 (for title of displayed HTML page).
 174
 175 \membersection{wxHtmlHelpController::UseConfig}\label{wxhtmlhelpcontrolleruseconfig}
 176
 177 \func{void}{UseConfig}{\param{wxConfigBase* }{config}, \param{const wxString\& }{rootpath = wxEmptyString}}
 178
 179 Associates {\it config} object with the controller.
 180
 181 If there is associated config object, wxHtmlHelpController automatically
 182 reads and writes settings (including wxHtmlWindow's settings) when needed.
 183
 184 The only thing you must do is create wxConfig object and call UseConfig.
 185
 186 If you do not use {\it UseConfig}, wxHtmlHelpController will use
 187 default wxConfig object if available (for details see
 188 \helpref{wxConfigBase::Get}{wxconfigbaseget} and
 189 \helpref{wxConfigBase::Set}{wxconfigbaseset}).
 190
 191 \membersection{wxHtmlHelpController::WriteCustomization}\label{wxhtmlhelpcontrollerwritecustomization}
 192
 193 \func{void}{WriteCustomization}{\param{wxConfigBase* }{cfg}, \param{wxString }{path = wxEmptyString}}
 194
 195 Stores controllers setting (position of window etc.)
 196
 197