Use the new event handler macros

[wxWidgets.git] / docs / latex / wx / hthelpct.tex

diff --git a/docs/latex/wx/hthelpct.tex b/docs/latex/wx/hthelpct.tex
index 5009daf3958b04f44cf07933675b8f69812c3f92..87eadfb919007bd1fab0d397eb3fab1655debe44 100644 (file)
--- a/docs/latex/wx/hthelpct.tex
+++ b/docs/latex/wx/hthelpct.tex
@@ -5,7 +5,7 @@
 
 \section{\class{wxHtmlHelpController}}\label{wxhtmlhelpcontroller}
 
 
 \section{\class{wxHtmlHelpController}}\label{wxhtmlhelpcontroller}
 

-{\bf WARNING!} Although this class has an API compatible with other wxWindows
+{\bf WARNING!} 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.
 
 help controllers as documented by \helpref{wxHelpController}{wxhelpcontroller}, it
 is recommended that you use the enhanced capabilities of wxHtmlHelpController's API.
 


@@ -13,7 +13,7 @@ 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} 
 (see \helpref{AddBook}{wxhtmlhelpcontrolleraddbook}). A book is a logical
 section of documentation (for example "User's Guide" or "Programmer's Guide" or
 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.
 
 wxHTML uses Microsoft's HTML Help Workshop project files (.hhp, .hhk, .hhc) as its
 many books as you want.
 
 wxHTML uses Microsoft's HTML Help Workshop project files (.hhp, .hhk, .hhc) as its


@@ -23,13 +23,6 @@ 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.
 
 You can use Tex2RTF to produce these files when generating HTML, if you set {\bf htmlWorkshopFiles} to {\bf true} in
 your tex2rtf.ini file.
 

-In order to use the controller in your application under Windows you must
-have the following line in your .rc file:
-
-\begin{verbatim}
-#include "wx/html/msw/wxhtml.rc"
-\end{verbatim}
-

 \wxheading{Note}
 
 It is strongly recommended to use preprocessed {\bf .hhp.cached} version of
 \wxheading{Note}
 
 It is strongly recommended to use preprocessed {\bf .hhp.cached} version of


@@ -39,6 +32,10 @@ projects. It can be either created on-the-fly (see
 distribute the cached version together with helpfiles. See {\it samples/html/help} 
 sample for demonstration of its use.
 
 distribute the cached version together with helpfiles. See {\it samples/html/help} 
 sample for demonstration of its use.
 

+\wxheading{See also}
+
+\helpref{Information about wxBestHelpController}{wxhelpcontroller}
+

 \wxheading{Derived from}
 
 wxHelpControllerBase
 \wxheading{Derived from}
 
 wxHelpControllerBase


@@ -84,17 +81,33 @@ all other sections (sections, subsections, ...) have a folder icon.}
 
 \membersection{wxHtmlHelpController::AddBook}\label{wxhtmlhelpcontrolleraddbook}
 
 
 \membersection{wxHtmlHelpController::AddBook}\label{wxhtmlhelpcontrolleraddbook}
 

-\func{bool}{AddBook}{\param{const wxString\& }{book}, \param{bool }{show\_wait\_msg}}
+\func{bool}{AddBook}{\param{const wxFileName\& }{book\_file}, \param{bool }{show\_wait\_msg}}
+
+\func{bool}{AddBook}{\param{const wxString\& }{book\_url}, \param{bool }{show\_wait\_msg}}

 
 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.
 
 
 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 book\_file} or {\it book\_url}  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
 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, in fact, recommended way.

 
 

-If {\it show\_wait\_msg} is TRUE then a decorationless window with progress message is displayed.
+\wxheading{Parameters}
+
+\docparam{show\_wait\_msg}{If true then a decoration-less window with progress message is displayed.}
+\docparam{book\_file}{Help book filename. It is recommended to use this prototype
+instead of the one taking URL, because it is less error-prone.}
+\docparam{book\_url}{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::CreateHelpFrame}\label{wxhtmlhelpcontrollercreatehelpframe}
 
 
 \membersection{wxHtmlHelpController::CreateHelpFrame}\label{wxhtmlhelpcontrollercreatehelpframe}
 


@@ -103,6 +116,7 @@ If {\it show\_wait\_msg} is TRUE then a decorationless window with progress mess
 This protected virtual method may be overridden so that the controller
 uses slightly different frame. See {\it samples/html/helpview} sample for
 an example.
 This protected virtual method may be overridden so that the controller
 uses slightly different frame. See {\it samples/html/helpview} sample for
 an example.

+

 \membersection{wxHtmlHelpController::Display}\label{wxhtmlhelpcontrollerdisplay}
 
 \func{void}{Display}{\param{const wxString\& }{x}}
 \membersection{wxHtmlHelpController::Display}\label{wxhtmlhelpcontrollerdisplay}
 
 \func{void}{Display}{\param{const wxString\& }{x}}


@@ -150,10 +164,11 @@ Displays help window and focuses index panel.
 
 \membersection{wxHtmlHelpController::KeywordSearch}\label{wxhtmlhelpcontrollerkeywordsearch}
 
 
 \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 .hhc file(s).
 You should list all pages in the contents file.
 
 {\bf Important:} KeywordSearch searches only pages listed in .hhc file(s).
 You should list all pages in the contents file.