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{Derived from}
  33
  34 wxEvtHandler
  35
  36 \latexignore{\rtfignore{\wxheading{Members}}}
  37
  38 \membersection{wxHtmlHelpController::wxHtmlHelpController}\label{wxhtmlhelpcontrollerwxhtmlhelpcontroller}
  39
  40 \func{}{wxHtmlHelpController}{\param{int }{style = wxHF\_DEFAULTSTYLE}}
  41
  42 Constructor.
  43
  44 \wxheading{Parameters}
  45
  46 {\it style} is combination of these flags:
  47
  48 \begin{twocollist}
  49 \twocolitem{\windowstyle{wxHF\_TOOLBAR}}{Help frame has toolbar.}
  50 \twocolitem{\windowstyle{wxHF\_CONTENTS}}{Help frame has contents panel.}
  51 \twocolitem{\windowstyle{wxHF\_INDEX}}{Help frame has index panel.}
  52 \twocolitem{\windowstyle{wxHF\_SEARCH}}{Help frame has search panel.}
  53 \twocolitem{\windowstyle{wxHF\_BOOKMARKS}}{Help frame has bookmarks controls.}
  54 \end{twocollist}
  55
  56 Default value : everything enabled.
  57
  58 \membersection{wxHtmlHelpController::AddBook}\label{wxhtmlhelpcontrolleraddbook}
  59
  60 \func{bool}{AddBook}{\param{const wxString\& }{book}, \param{bool }{show\_wait\_msg}}
  61
  62 Adds book (\helpref{.hhp file}{helpformat} - HTML Help Workshop project file) into the list of loaded books.
  63 This must be called at least once before displaying  any help.
  64
  65 {\it book} may be either .hhp file or ZIP archive that contains arbitrary number of .hhp files in
  66 top-level directory. This ZIP archive must have .zip or .htb extension
  67 (the latter stands for "HTML book"). In other words, {\tt AddBook("help.zip")} is possible and, in fact,
  68 recommended way.
  69
  70 If {\it show\_wait\_msg} is TRUE then a decorationless window with progress message is displayed.
  71
  72 \membersection{wxHtmlHelpController::Display}\label{wxhtmlhelpcontrollerdisplay}
  73
  74 \func{void}{Display}{\param{const wxString\& }{x}}
  75
  76 Displays page {\it x}. This is THE important function - it is used to display
  77 the help in application.
  78
  79 You can specify the page in many ways:
  80
  81 \begin{itemize}\itemsep=0pt
  82 \item as direct filename of HTML document
  83 \item as chapter name (from contents) or as a book name
  84 \item as some word from index
  85 \item even as any word (will be searched)
  86 \end{itemize}
  87
  88 Looking for the page runs in these steps:
  89
  90 \begin{enumerate}\itemsep=0pt
  91 \item try to locate file named x (if x is for example "doc/howto.htm")
  92 \item try to open starting page of book named x
  93 \item try to find x in contents (if x is for example "How To ...")
  94 \item try to find x in index (if x is for example "How To ...")
  95 \item switch to Search panel and start searching
  96 \end{enumerate}
  97
  98 \func{void}{Display}{\param{const int }{id}}
  99
 100 This alternative form is used to search help contents by numeric IDs.
 101
 102 \pythonnote{The second form of this method is named DisplayId in
 103 wxPython.}
 104
 105 \membersection{wxHtmlHelpController::DisplayContents}\label{wxhtmlhelpcontrollerdisplaycontents}
 106
 107 \func{void}{DisplayContents}{\void}
 108
 109 Displays help window and focuses contents panel.
 110
 111 \membersection{wxHtmlHelpController::DisplayIndex}\label{wxhtmlhelpcontrollerdisplayindex}
 112
 113 \func{void}{DisplayIndex}{\void}
 114
 115 Displays help window and focuses index panel.
 116
 117 \membersection{wxHtmlHelpController::KeywordSearch}\label{wxhtmlhelpcontrollerkeywordsearch}
 118
 119 \func{bool}{KeywordSearch}{\param{const wxString\& }{keyword}}
 120
 121 Displays help window, focuses search panel and starts searching.
 122 Returns TRUE if the keyword was found.
 123
 124 {\bf Important:} KeywordSearch searches only pages listed in .htc file(s).
 125 You should list all pages in the contents file.
 126
 127 \membersection{wxHtmlHelpController::ReadCustomization}\label{wxhtmlhelpcontrollerreadcustomization}
 128
 129 \func{void}{ReadCustomization}{\param{wxConfigBase* }{cfg}, \param{wxString }{path = wxEmptyString}}
 130
 131 Reads the controller's setting (position of window, etc.)
 132
 133 \membersection{wxHtmlHelpController::SetTempDir}\label{wxhtmlhelpcontrollersettempdir}
 134
 135 \func{void}{SetTempDir}{\param{const wxString\& }{path}}
 136
 137 Sets the path for storing temporary files - cached binary versions of index and contents files. These binary
 138 forms are much faster to read. Default value is empty string (empty string means
 139 that no cached data are stored). Note that these files are {\it not}
 140 deleted when program exits.
 141
 142 \membersection{wxHtmlHelpController::SetTitleFormat}\label{wxhtmlhelpcontrollersettitleformat}
 143
 144 \func{void}{SetTitleFormat}{\param{const wxString\& }{format}}
 145
 146 Sets format of title of the frame. Must contain exactly one "\%s"
 147 (for title of displayed HTML page).
 148
 149 \membersection{wxHtmlHelpController::UseConfig}\label{wxhtmlhelpcontrolleruseconfig}
 150
 151 \func{void}{UseConfig}{\param{wxConfigBase* }{config}, \param{const wxString\& }{rootpath = wxEmptyString}}
 152
 153 Associates {\it config} object with the controller.
 154
 155 If there is associated config object, wxHtmlHelpController automatically
 156 reads and writes settings (including wxHtmlWindow's settings) when needed.
 157
 158 The only thing you must do is create wxConfig object and call UseConfig.
 159
 160 \membersection{wxHtmlHelpController::WriteCustomization}\label{wxhtmlhelpcontrollerwritecustomization}
 161
 162 \func{void}{WriteCustomization}{\param{wxConfigBase* }{cfg}, \param{wxString }{path = wxEmptyString}}
 163
 164 Stores controllers setting (position of window etc.)
 165