Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added wxHtmlHelpController::AddBook(wxFileName)

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@18118 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Václav Slavík
2002-12-08 20:30:42 +00:00
parent cc37ecaf2d
commit fcf77487ed
4 changed files with 28 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/latex/wx/hthelpct.tex
View File

@@ -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.
If {\it show\_wait\_msg} is TRUE then a decoration-less 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}

8
docs/latex/wx/hthlpdat.tex
View File

@@ -28,11 +28,11 @@ Constructor.
\membersection{wxHtmlHelpData::AddBook}\label{wxhtmlhelpdataaddbook}
\func{bool}{AddBook}{\param{const wxString\& }{book}}
\func{bool}{AddBook}{\param{const wxString\& }{book\_url}}
Adds new book. 'book' is location of HTML help project (hhp) or ZIP file
that contains arbitrary number of .hhp projects (this zip file can have
either .zip or .htb extension, htb stands for "html book").
Adds new book. {\it book} is URL (not filename!) of HTML help project (hhp)
or ZIP file that contains arbitrary number of .hhp projects (this zip
file can have either .zip or .htb extension, htb stands for "html book").
Returns success.
\membersection{wxHtmlHelpData::FindPageById}\label{wxhtmlhelpdatafindpagebyid}