X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3a9a01661aa51c52b734b16abdceec2f905c5f25..12a3f2275c94a345cf83abf5151db68391859623:/docs/latex/wx/hthelpct.tex diff --git a/docs/latex/wx/hthelpct.tex b/docs/latex/wx/hthelpct.tex index 2e667c66da..acb5cbfe7e 100644 --- a/docs/latex/wx/hthelpct.tex +++ b/docs/latex/wx/hthelpct.tex @@ -81,17 +81,27 @@ all other sections (sections, subsections, ...) have a folder icon.} \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. -{\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 -(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. + +\wxheading{Parameters} -If {\it show\_wait\_msg} is 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 +different on most platforms)} \wxheading{Note}