\section{\class{wxHtmlHelpData}}\label{wxhtmlhelpdata}
-This class is used by \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}
+This class is used by \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}
and \helpref{wxHtmlHelpFrame}{wxhtmlhelpframe} to access HTML help items.
It is internal class and should not be used directly - except for the case
you're writing your own HTML help controller.
-
\wxheading{Derived from}
\helpref{wxObject}{wxobject}
+\wxheading{Include files}
-\latexignore{\rtfignore{\wxheading{Members}}}
+<wx/html/helpdata.h>
+\latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxHtmlHelpData::wxHtmlHelpData}\label{wxhtmlhelpdatawxhtmlhelpdata}
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}
\func{wxString}{FindPageById}{\param{int }{id}}
Returns page's URL based on integer ID stored in project.
-
\membersection{wxHtmlHelpData::FindPageByName}\label{wxhtmlhelpdatafindpagebyname}
\func{wxString}{FindPageByName}{\param{const wxString\& }{page}}
Returns page's URL based on its (file)name.
-
\membersection{wxHtmlHelpData::GetBookRecArray}\label{wxhtmlhelpdatagetbookrecarray}
\func{const wxHtmlBookRecArray\&}{GetBookRecArray}{\void}
Returns size of index list.
-\membersection{wxHtmlHelpData::LoadCachedBook}\label{wxhtmlhelpdataloadcachedbook}
-
-\func{bool}{LoadCachedBook}{\param{wxHtmlBookRecord* }{book}, \param{wxInputStream* }{f}}
-
-Reads binary cached book.
-
-
-\membersection{wxHtmlHelpData::LoadMSProject}\label{wxhtmlhelpdataloadmsproject}
-
-\func{bool}{LoadMSProject}{\param{wxHtmlBookRecord* }{book}, \param{wxFileSystem\& }{fsys}, \param{const wxString\& }{indexfile}, \param{const wxString\& }{contentsfile}}
-
-Imports .hhp files (MS HTML Help Workshop).
-
-\membersection{wxHtmlHelpData::SaveCachedBook}\label{wxhtmlhelpdatasavecachedbook}
-
-\func{bool}{SaveCachedBook}{\param{wxHtmlBookRecord* }{book}, \param{wxOutputStream* }{f}}
-
-Saves binary cached book. (Internal - this methods is used automatically
-if you call SetTempDir!)
-
\membersection{wxHtmlHelpData::SetTempDir}\label{wxhtmlhelpdatasettempdir}
\func{void}{SetTempDir}{\param{const wxString\& }{path}}