X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2b5f62a0b2db198609b45dec622a018dae37008e..3ac7b44cc0765b8444324d71b58cf648009d41c2:/docs/latex/wx/helpinst.tex diff --git a/docs/latex/wx/helpinst.tex b/docs/latex/wx/helpinst.tex index 43a266c295..758105130c 100644 --- a/docs/latex/wx/helpinst.tex +++ b/docs/latex/wx/helpinst.tex @@ -125,7 +125,7 @@ contents. Displays the section as a popup window using a context id. -Returns FALSE if unsuccessful or not implemented. +Returns false if unsuccessful or not implemented. \membersection{wxHelpController::DisplaySection}\label{wxhelpcontrollerdisplaysection} @@ -163,7 +163,7 @@ See also the help sample for notes on how to specify section numbers for various Displays the text in a popup window, if possible. -Returns FALSE if unsuccessful or not implemented. +Returns false if unsuccessful or not implemented. \membersection{wxHelpController::GetFrameParameters}\label{wxhelpcontrollergetframeparameters} @@ -184,10 +184,13 @@ that the viewer is a variant of Netscape Navigator.} \membersection{wxHelpController::KeywordSearch}\label{wxhelpcontrollerkeywordsearch} -\func{virtual bool}{KeywordSearch}{\param{const wxString\& }{keyWord}} +\func{virtual bool}{KeywordSearch}{\param{const wxString\& }{keyWord}, \param{wxHelpSearchMode }{mode = wxHELP\_SEARCH\_ALL}} -If the help viewer is not running, runs it, and searches for sections matching the given keyword. If one -match is found, the file is displayed at this section. +If the help viewer is not running, runs it, and searches for sections matching +the given keyword. If one match is found, the file is displayed at this +section. The optional parameter allows the search the index +(wxHELP\_SEARCH\_INDEX) but this currently only supported by the +wxHtmlHelpController. {\it WinHelp, MS HTML Help:} If more than one match is found, the first topic is displayed. @@ -222,7 +225,7 @@ This does not work for all help controllers. \func{virtual void}{SetFrameParameters}{\param{const wxString \& }{title}, \param{const wxSize \& }{size}, \param{const wxPoint \& }{pos = wxDefaultPosition}, - \param{bool }{newFrameEachTime = FALSE}} + \param{bool }{newFrameEachTime = false}} For wxHtmlHelpController, the title is set (again with \%s indicating the page title) and also the size and position of the frame if the frame is already