\section{\class{wxHtmlHelpController}}\label{wxhtmlhelpcontroller}
-{\bf WARNING! This help controller has an API incompatible with wxWindows
-wxHelpController!}
-
This help controller provides an easy way of displaying HTML help in your
-application (see {\it test} sample). The help system is based on {\bf books}
+application (see {\it test} sample). The help system is based on {\bf books}
(see \helpref{AddBook}{wxhtmlhelpcontrolleraddbook}). A book is a logical
section of documentation (for example "User's Guide" or "Programmer's Guide" or
-"C++ Reference" or "wxWindows Reference"). The help controller can handle as
+"C++ Reference" or "wxWidgets Reference"). The help controller can handle as
many books as you want.
+Although this class has an API compatible with other wxWidgets
+help controllers as documented by \helpref{wxHelpController}{wxhelpcontroller}, it
+is recommended that you use the enhanced capabilities of wxHtmlHelpController's API.
+
wxHTML uses Microsoft's HTML Help Workshop project files (.hhp, .hhk, .hhc) as its
native format. The file format is described \helpref{here}{helpformat}.
Have a look at docs/html/ directory where sample project files are stored.
You can use Tex2RTF to produce these files when generating HTML, if you set {\bf htmlWorkshopFiles} to {\bf true} in
-your tex2rtf.ini file.
+your tex2rtf.ini file. The commercial tool HelpBlocks (www.helpblocks.com) can also create these files.
+
+\wxheading{Note}
-In order to use the controller in your application under Windows you must
-have the following line in your .rc file:
+It is strongly recommended to use preprocessed {\bf .hhp.cached} version of
+projects. It can be either created on-the-fly (see
+\helpref{SetTempDir}{wxhtmlhelpcontrollersettempdir}) or you can use
+{\bf hhp2cached} utility from {\it utils/hhp2cached} to create it and
+distribute the cached version together with helpfiles. See {\it samples/html/help}
+sample for demonstration of its use.
-\begin{verbatim}
-#include "wx/html/msw/wxhtml.rc"
-\end{verbatim}
+\wxheading{See also}
+
+\helpref{Information about wxBestHelpController}{wxhelpcontroller},
+\helpref{wxHtmlHelpFrame}{wxhtmlhelpframe},
+\helpref{wxHtmlHelpDialog}{wxhtmlhelpdialog},
+\helpref{wxHtmlHelpWindow}{wxhtmlhelpwindow},
+\helpref{wxHtmlModalHelp}{wxhtmlmodalhelp}
\wxheading{Derived from}
-wxEvtHandler
+wxHelpControllerBase
+
+\wxheading{Include files}
+
+<wx/html/helpctrl.h>
\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxHtmlHelpController::wxHtmlHelpController}\label{wxhtmlhelpcontrollerwxhtmlhelpcontroller}
-\func{}{wxHtmlHelpController}{\param{int }{style = wxHF_DEFAULTSTYLE}}
+\func{}{wxHtmlHelpController}{\param{int }{style = wxHF\_DEFAULT\_STYLE}, \param{wxWindow* }{parentWindow = NULL}}
Constructor.
\wxheading{Parameters}
-{\it style} is combination of these flags:
-
-\begin{twocollist}
-\twocolitem{\windowstyle{wxHF\_TOOLBAR}}{Help frame has toolbar.}
-\twocolitem{\windowstyle{wxHF\_CONTENTS}}{Help frame has contents panel.}
-\twocolitem{\windowstyle{wxHF\_INDEX}}{Help frame has index panel.}
-\twocolitem{\windowstyle{wxHF\_SEARCH}}{Help frame has search panel.}
-\twocolitem{\windowstyle{wxHF\_BOOKMARKS}}{Help frame has bookmarks controls.}
+{\it style} is a combination of these flags:
+
+\begin{twocollist}\itemsep=0pt
+\twocolitem{\windowstyle{wxHF\_TOOLBAR}}{The help window has a toolbar.}
+\twocolitem{\windowstyle{wxHF\_FLAT\_TOOLBAR}}{The help window has a toolbar with flat buttons (aka coolbar).}
+\twocolitem{\windowstyle{wxHF\_CONTENTS}}{The help window has a contents panel.}
+\twocolitem{\windowstyle{wxHF\_INDEX}}{The help window has an index panel.}
+\twocolitem{\windowstyle{wxHF\_SEARCH}}{The help window has a search panel.}
+\twocolitem{\windowstyle{wxHF\_BOOKMARKS}}{The help window has bookmarks controls.}
+\twocolitem{\windowstyle{wxHF\_OPEN\_FILES}}{Allows user to open arbitrary HTML document.}
+\twocolitem{\windowstyle{wxHF\_PRINT}}{The toolbar contains "print" button.}
+\twocolitem{\windowstyle{wxHF\_MERGE\_BOOKS}}{The contents pane does not show
+book nodes. All books are merged together and appear as single book to the
+user.}
+\twocolitem{\windowstyle{wxHF\_ICONS\_BOOK}}{All nodes in contents pane
+have a book icon. This is how Microsoft's HTML help viewer behaves.}
+\twocolitem{\windowstyle{wxHF\_ICONS\_FOLDER}}{Book nodes in contents pane have
+a book icon, book's sections have a folder icon. This is the default.}
+\twocolitem{\windowstyle{wxHF\_ICONS\_BOOK\_CHAPTER}}{Both book nodes and
+nodes of top-level sections of a book (i.e. chapters) have a book icon,
+all other sections (sections, subsections, ...) have a folder icon.}
+\twocolitem{\windowstyle{wxHF\_EMBEDDED}}{Specifies that the help controller controls an embedded window of class \helpref{wxHtmlHelpWindow}{wxhtmlhelpwindow} that
+should not be destroyed when the controller is destroyed.}
+\twocolitem{\windowstyle{wxHF\_DIALOG}}{Specifies that the help controller should create a dialog containing the help window.}
+\twocolitem{\windowstyle{wxHF\_FRAME}}{Specifies that the help controller should create a frame containing the help window. This is the default if neither wxHF\_DIALOG nor wxHF\_EMBEDDED is specified.}
+\twocolitem{\windowstyle{wxHF\_MODAL}}{Specifies that the help controller should create a modal dialog containing the help window (used with the wxHF\_DIALOG style).}
+\twocolitem{\windowstyle{wxHF\_DEFAULT\_STYLE}}{{\tt wxHF\_TOOLBAR | wxHF\_CONTENTS
+| wxHF\_INDEX | wxHF\_SEARCH | wxHF\_BOOKMARKS | wxHF\_PRINT}}
\end{twocollist}
-Default value : everything enabled.
+{\it parentWindow} is an optional window to be used as the parent for the help window.
\membersection{wxHtmlHelpController::AddBook}\label{wxhtmlhelpcontrolleraddbook}
-\func{bool}{AddBook}{\param{const wxString\& }{book}, \param{bool }{show_wait_msg}}
+\func{bool}{AddBook}{\param{const wxFileName\& }{bookFile}, \param{bool }{showWaitMsg}}
+
+\func{bool}{AddBook}{\param{const wxString\& }{bookUrl}, \param{bool }{showWaitMsg}}
Adds book (\helpref{.hhp file}{helpformat} - HTML Help Workshop project file) into the list of loaded books.
This must be called at least once before displaying any help.
-{\it book} may be either .hhp file or ZIP archive that contains arbitrary number of .hhp files in
+{\it bookFile} or {\it bookUrl} may be either .hhp file or ZIP archive
+that contains arbitrary number of .hhp files in
top-level directory. This ZIP archive must have .zip or .htb extension
-(the latter stands for "HTML book"). In other words, {\tt AddBook("help.zip")} is possible and, in fact,
-recommended way.
+(the latter stands for "HTML book"). In other words, {\tt AddBook(wxFileName("help.zip"))}
+is possible and is the recommended way.
+
+\wxheading{Parameters}
-If {\it show\_wait\_msg} is TRUE then a decorationless window with progress message is displayed.
+\docparam{showWaitMsg}{If true then a decoration-less window with progress message is displayed.}
+\docparam{bookFile}{Help book filename. It is recommended to use this prototype
+instead of the one taking URL, because it is less error-prone.}
+\docparam{bookUrl}{Help book URL (note that syntax of filename and URL is
+different on most platforms)}
+
+\wxheading{Note}
+
+Don't forget to install wxFileSystem ZIP handler with
+{\tt wxFileSystem::AddHandler(new wxZipFSHandler);} before calling this method
+on a .zip or .htb file!
+
+\membersection{wxHtmlHelpController::CreateHelpDialog}\label{wxhtmlhelpcontrollercreatehelpdialog}
+
+\func{virtual wxHtmlHelpDialog*}{CreateHelpDialog}{\param{wxHtmlHelpData * }{data}}
+
+This protected virtual method may be overridden so that when specifying the wxHF\_DIALOG style, the controller
+uses a different dialog.
+
+\membersection{wxHtmlHelpController::CreateHelpFrame}\label{wxhtmlhelpcontrollercreatehelpframe}
+
+\func{virtual wxHtmlHelpFrame*}{CreateHelpFrame}{\param{wxHtmlHelpData * }{data}}
+
+This protected virtual method may be overridden so that the controller
+uses a different frame.
\membersection{wxHtmlHelpController::Display}\label{wxhtmlhelpcontrollerdisplay}
\membersection{wxHtmlHelpController::KeywordSearch}\label{wxhtmlhelpcontrollerkeywordsearch}
-\func{bool}{KeywordSearch}{\param{const wxString\& }{keyword}}
+\func{bool}{KeywordSearch}{\param{const wxString\& }{keyword}, \param{wxHelpSearchMode }{mode = wxHELP\_SEARCH\_ALL}}
-Displays help window, focuses search panel and starts searching.
-Returns TRUE if the keyword was found.
+Displays help window, focuses search panel and starts searching. Returns true
+if the keyword was found. Optionally it searches through the index (mode =
+wxHELP\_SEARCH\_INDEX), default the content (mode = wxHELP\_SEARCH\_ALL).
-{\bf Important:} KeywordSearch searches only pages listed in .htc file(s).
+{\bf Important:} KeywordSearch searches only pages listed in .hhc file(s).
You should list all pages in the contents file.
\membersection{wxHtmlHelpController::ReadCustomization}\label{wxhtmlhelpcontrollerreadcustomization}
Sets the path for storing temporary files - cached binary versions of index and contents files. These binary
forms are much faster to read. Default value is empty string (empty string means
-that no cached data are stored). Note that these files are {\it not}
+that no cached data are stored). Note that these files are {\it not}
deleted when program exits.
+Once created these cached files will be used in all subsequent executions
+of your application. If cached files become older than corresponding .hhp
+file (e.g. if you regenerate documentation) it will be refreshed.
+
\membersection{wxHtmlHelpController::SetTitleFormat}\label{wxhtmlhelpcontrollersettitleformat}
\func{void}{SetTitleFormat}{\param{const wxString\& }{format}}
The only thing you must do is create wxConfig object and call UseConfig.
+If you do not use {\it UseConfig}, wxHtmlHelpController will use
+default wxConfig object if available (for details see
+\helpref{wxConfigBase::Get}{wxconfigbaseget} and
+\helpref{wxConfigBase::Set}{wxconfigbaseset}).
+
\membersection{wxHtmlHelpController::WriteCustomization}\label{wxhtmlhelpcontrollerwritecustomization}
\func{void}{WriteCustomization}{\param{wxConfigBase* }{cfg}, \param{wxString }{path = wxEmptyString}}
projects / wxWidgets.git / blobdiff