X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fcf77487edae715c75f0f802a96e203d88dd56c6..86b79b93fbbb0c2e90e6595f7fea0f979b80881c:/docs/latex/wx/hthelpct.tex diff --git a/docs/latex/wx/hthelpct.tex b/docs/latex/wx/hthelpct.tex index acb5cbfe7e..aef75e0ecb 100644 --- a/docs/latex/wx/hthelpct.tex +++ b/docs/latex/wx/hthelpct.tex @@ -97,7 +97,7 @@ is possible and, in fact, recommended way. \wxheading{Parameters} -\docparam{show\_wait\_msg}{If TRUE then a decoration-less window with progress message is displayed.} +\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 @@ -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.