X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cc81d32f2bf8c159f3b1bf6ddaf62e6d77720209..50c538600e7586c256fe0145ac8054f045be6fbb:/docs/latex/wx/hthelpct.tex diff --git a/docs/latex/wx/hthelpct.tex b/docs/latex/wx/hthelpct.tex index e7230bb8e2..87eadfb919 100644 --- a/docs/latex/wx/hthelpct.tex +++ b/docs/latex/wx/hthelpct.tex @@ -5,7 +5,7 @@ \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. @@ -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 -"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 @@ -116,6 +116,7 @@ on a .zip or .htb file! 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}} @@ -163,10 +164,11 @@ Displays help window and focuses index panel. \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.