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