]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/hthelpct.tex
AddPendingEvent() is not virtual
[wxWidgets.git] / 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 wxFileName\& }{book\_file}, \param{bool }{show\_wait\_msg}}
85
86 \func{bool}{AddBook}{\param{const wxString\& }{book\_url}, \param{bool }{show\_wait\_msg}}
87
88 Adds book (\helpref{.hhp file}{helpformat} - HTML Help Workshop project file) into the list of loaded books.
89 This must be called at least once before displaying any help.
90
91 {\it book\_file} or {\it book\_url} may be either .hhp file or ZIP archive
92 that contains arbitrary number of .hhp files in
93 top-level directory. This ZIP archive must have .zip or .htb extension
94 (the latter stands for "HTML book"). In other words,
95 {\tt AddBook(wxFileName("help.zip"))}
96 is possible and, in fact, recommended way.
97
98 \wxheading{Parameters}
99
100 \docparam{show\_wait\_msg}{If true then a decoration-less window with progress message is displayed.}
101 \docparam{book\_file}{Help book filename. It is recommended to use this prototype
102 instead of the one taking URL, because it is less error-prone.}
103 \docparam{book\_url}{Help book URL (note that syntax of filename and URL is
104 different on most platforms)}
105
106 \wxheading{Note}
107
108 Don't forget to install wxFileSystem ZIP handler with
109 {\tt wxFileSystem::AddHandler(new wxZipFSHandler);} before calling this method
110 on a .zip or .htb file!
111
112 \membersection{wxHtmlHelpController::CreateHelpFrame}\label{wxhtmlhelpcontrollercreatehelpframe}
113
114 \func{virtual wxHtmlHelpFrame*}{CreateHelpFrame}{\param{wxHtmlHelpData * }{data}}
115
116 This protected virtual method may be overridden so that the controller
117 uses slightly different frame. See {\it samples/html/helpview} sample for
118 an example.
119
120 \membersection{wxHtmlHelpController::Display}\label{wxhtmlhelpcontrollerdisplay}
121
122 \func{void}{Display}{\param{const wxString\& }{x}}
123
124 Displays page {\it x}. This is THE important function - it is used to display
125 the help in application.
126
127 You can specify the page in many ways:
128
129 \begin{itemize}\itemsep=0pt
130 \item as direct filename of HTML document
131 \item as chapter name (from contents) or as a book name
132 \item as some word from index
133 \item even as any word (will be searched)
134 \end{itemize}
135
136 Looking for the page runs in these steps:
137
138 \begin{enumerate}\itemsep=0pt
139 \item try to locate file named x (if x is for example "doc/howto.htm")
140 \item try to open starting page of book named x
141 \item try to find x in contents (if x is for example "How To ...")
142 \item try to find x in index (if x is for example "How To ...")
143 \item switch to Search panel and start searching
144 \end{enumerate}
145
146 \func{void}{Display}{\param{const int }{id}}
147
148 This alternative form is used to search help contents by numeric IDs.
149
150 \pythonnote{The second form of this method is named DisplayId in
151 wxPython.}
152
153 \membersection{wxHtmlHelpController::DisplayContents}\label{wxhtmlhelpcontrollerdisplaycontents}
154
155 \func{void}{DisplayContents}{\void}
156
157 Displays help window and focuses contents panel.
158
159 \membersection{wxHtmlHelpController::DisplayIndex}\label{wxhtmlhelpcontrollerdisplayindex}
160
161 \func{void}{DisplayIndex}{\void}
162
163 Displays help window and focuses index panel.
164
165 \membersection{wxHtmlHelpController::KeywordSearch}\label{wxhtmlhelpcontrollerkeywordsearch}
166
167 \func{bool}{KeywordSearch}{\param{const wxString\& }{keyword}, \param{wxHelpSearchMode }{mode = wxHELP\_SEARCH\_ALL}}
168
169 Displays help window, focuses search panel and starts searching. Returns true
170 if the keyword was found. Optionally it searches through the index (mode =
171 wxHELP\_SEARCH\_INDEX), default the content (mode = wxHELP\_SEARCH\_ALL).
172
173 {\bf Important:} KeywordSearch searches only pages listed in .hhc file(s).
174 You should list all pages in the contents file.
175
176 \membersection{wxHtmlHelpController::ReadCustomization}\label{wxhtmlhelpcontrollerreadcustomization}
177
178 \func{void}{ReadCustomization}{\param{wxConfigBase* }{cfg}, \param{wxString }{path = wxEmptyString}}
179
180 Reads the controller's setting (position of window, etc.)
181
182 \membersection{wxHtmlHelpController::SetTempDir}\label{wxhtmlhelpcontrollersettempdir}
183
184 \func{void}{SetTempDir}{\param{const wxString\& }{path}}
185
186 Sets the path for storing temporary files - cached binary versions of index and contents files. These binary
187 forms are much faster to read. Default value is empty string (empty string means
188 that no cached data are stored). Note that these files are {\it not}
189 deleted when program exits.
190
191 Once created these cached files will be used in all subsequent executions
192 of your application. If cached files become older than corresponding .hhp
193 file (e.g. if you regenerate documentation) it will be refreshed.
194
195 \membersection{wxHtmlHelpController::SetTitleFormat}\label{wxhtmlhelpcontrollersettitleformat}
196
197 \func{void}{SetTitleFormat}{\param{const wxString\& }{format}}
198
199 Sets format of title of the frame. Must contain exactly one "\%s"
200 (for title of displayed HTML page).
201
202 \membersection{wxHtmlHelpController::UseConfig}\label{wxhtmlhelpcontrolleruseconfig}
203
204 \func{void}{UseConfig}{\param{wxConfigBase* }{config}, \param{const wxString\& }{rootpath = wxEmptyString}}
205
206 Associates {\it config} object with the controller.
207
208 If there is associated config object, wxHtmlHelpController automatically
209 reads and writes settings (including wxHtmlWindow's settings) when needed.
210
211 The only thing you must do is create wxConfig object and call UseConfig.
212
213 If you do not use {\it UseConfig}, wxHtmlHelpController will use
214 default wxConfig object if available (for details see
215 \helpref{wxConfigBase::Get}{wxconfigbaseget} and
216 \helpref{wxConfigBase::Set}{wxconfigbaseset}).
217
218 \membersection{wxHtmlHelpController::WriteCustomization}\label{wxhtmlhelpcontrollerwritecustomization}
219
220 \func{void}{WriteCustomization}{\param{wxConfigBase* }{cfg}, \param{wxString }{path = wxEmptyString}}
221
222 Stores controllers setting (position of window etc.)
223