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