111 lines
3.2 KiB
TeX
111 lines
3.2 KiB
TeX
|
%
|
||
|
|
% automatically generated by HelpGen from
|
||
|
|
% helpdata.h at 24/Oct/99 18:03:10
|
||
|
|
%
|
||
|
|
|
||
|
|
\section{\class{wxHtmlHelpData}}\label{wxhtmlhelpdata}
|
||
|
|
|
||
|
|
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}
|
||
|
|
|
||
|
|
|
||
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
||
|
|
|
||
|
|
|
||
|
|
\membersection{wxHtmlHelpData::wxHtmlHelpData}\label{wxhtmlhelpdatawxhtmlhelpdata}
|
||
|
|
|
||
|
|
\func{}{wxHtmlHelpData}{\void}
|
||
|
|
|
||
|
|
Constructor.
|
||
|
|
|
||
|
|
|
||
|
|
\membersection{wxHtmlHelpData::AddBook}\label{wxhtmlhelpdataaddbook}
|
||
|
|
|
||
|
|
\func{bool}{AddBook}{\param{const wxString\& }{book}}
|
||
|
|
|
||
|
|
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").
|
||
|
|
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 array with help books info.
|
||
|
|
|
||
|
|
\membersection{wxHtmlHelpData::GetContents}\label{wxhtmlhelpdatagetcontents}
|
||
|
|
|
||
|
|
\func{wxHtmlContentsItem*}{GetContents}{\void}
|
||
|
|
|
||
|
|
Returns contents lists pointer.
|
||
|
|
|
||
|
|
\membersection{wxHtmlHelpData::GetContentsCnt}\label{wxhtmlhelpdatagetcontentscnt}
|
||
|
|
|
||
|
|
\func{int}{GetContentsCnt}{\void}
|
||
|
|
|
||
|
|
Returns size of contents list.
|
||
|
|
|
||
|
|
\membersection{wxHtmlHelpData::GetIndex}\label{wxhtmlhelpdatagetindex}
|
||
|
|
|
||
|
|
\func{wxHtmlContentsItem*}{GetIndex}{\void}
|
||
|
|
|
||
|
|
Returns pointer to index items list.
|
||
|
|
|
||
|
|
\membersection{wxHtmlHelpData::GetIndexCnt}\label{wxhtmlhelpdatagetindexcnt}
|
||
|
|
|
||
|
|
\func{int}{GetIndexCnt}{\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}}
|
||
|
|
|
||
|
|
Sets temporary directory where binary cached versions of MS HTML Workshop
|
||
|
|
files will be stored. (This is turned off by default and you can enable
|
||
|
|
this feature by setting non-empty temp dir.)
|
||
|
|
|