docs/latex/wx/hthlpdat.tex

   1 %
   2 % automatically generated by HelpGen from
   3 % helpdata.h at 24/Oct/99 18:03:10
   4 %
   5
   6 \section{\class{wxHtmlHelpData}}\label{wxhtmlhelpdata}
   7
   8 This class is used by \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller}
   9 and \helpref{wxHtmlHelpFrame}{wxhtmlhelpframe} to access HTML help items.
  10 It is internal class and should not be used directly - except for the case
  11 you're writing your own HTML help controller.
  12
  13
  14 \wxheading{Derived from}
  15
  16 \helpref{wxObject}{wxobject}
  17
  18
  19 \latexignore{\rtfignore{\wxheading{Members}}}
  20
  21
  22 \membersection{wxHtmlHelpData::wxHtmlHelpData}\label{wxhtmlhelpdatawxhtmlhelpdata}
  23
  24 \func{}{wxHtmlHelpData}{\void}
  25
  26 Constructor.
  27
  28
  29 \membersection{wxHtmlHelpData::AddBook}\label{wxhtmlhelpdataaddbook}
  30
  31 \func{bool}{AddBook}{\param{const wxString\& }{book}}
  32
  33 Adds new book. 'book' is location of HTML help project (hhp) or ZIP file
  34 that contains arbitrary number of .hhp projects (this zip file can have
  35 either .zip or .htb extension, htb stands for "html book").
  36 Returns success.
  37
  38
  39 \membersection{wxHtmlHelpData::FindPageById}\label{wxhtmlhelpdatafindpagebyid}
  40
  41 \func{wxString}{FindPageById}{\param{int }{id}}
  42
  43 Returns page's URL based on integer ID stored in project.
  44
  45
  46 \membersection{wxHtmlHelpData::FindPageByName}\label{wxhtmlhelpdatafindpagebyname}
  47
  48 \func{wxString}{FindPageByName}{\param{const wxString\& }{page}}
  49
  50 Returns page's URL based on its (file)name.
  51
  52
  53 \membersection{wxHtmlHelpData::GetBookRecArray}\label{wxhtmlhelpdatagetbookrecarray}
  54
  55 \func{const wxHtmlBookRecArray\&}{GetBookRecArray}{\void}
  56
  57 Returns array with help books info.
  58
  59 \membersection{wxHtmlHelpData::GetContents}\label{wxhtmlhelpdatagetcontents}
  60
  61 \func{wxHtmlContentsItem*}{GetContents}{\void}
  62
  63 Returns contents lists pointer.
  64
  65 \membersection{wxHtmlHelpData::GetContentsCnt}\label{wxhtmlhelpdatagetcontentscnt}
  66
  67 \func{int}{GetContentsCnt}{\void}
  68
  69 Returns size of contents list.
  70
  71 \membersection{wxHtmlHelpData::GetIndex}\label{wxhtmlhelpdatagetindex}
  72
  73 \func{wxHtmlContentsItem*}{GetIndex}{\void}
  74
  75 Returns pointer to index items list.
  76
  77 \membersection{wxHtmlHelpData::GetIndexCnt}\label{wxhtmlhelpdatagetindexcnt}
  78
  79 \func{int}{GetIndexCnt}{\void}
  80
  81 Returns size of index list.
  82
  83 \membersection{wxHtmlHelpData::LoadCachedBook}\label{wxhtmlhelpdataloadcachedbook}
  84
  85 \func{bool}{LoadCachedBook}{\param{wxHtmlBookRecord* }{book}, \param{wxInputStream* }{f}}
  86
  87 Reads binary cached book.
  88
  89
  90 \membersection{wxHtmlHelpData::LoadMSProject}\label{wxhtmlhelpdataloadmsproject}
  91
  92 \func{bool}{LoadMSProject}{\param{wxHtmlBookRecord* }{book}, \param{wxFileSystem\& }{fsys}, \param{const wxString\& }{indexfile}, \param{const wxString\& }{contentsfile}}
  93
  94 Imports .hhp files (MS HTML Help Workshop).
  95
  96 \membersection{wxHtmlHelpData::SaveCachedBook}\label{wxhtmlhelpdatasavecachedbook}
  97
  98 \func{bool}{SaveCachedBook}{\param{wxHtmlBookRecord* }{book}, \param{wxOutputStream* }{f}}
  99
 100 Saves binary cached book. (Internal - this methods is used automatically
 101 if you call SetTempDir!)
 102
 103 \membersection{wxHtmlHelpData::SetTempDir}\label{wxhtmlhelpdatasettempdir}
 104
 105 \func{void}{SetTempDir}{\param{const wxString\& }{path}}
 106
 107 Sets temporary directory where binary cached versions of MS HTML Workshop
 108 files will be stored. (This is turned off by default and you can enable
 109 this feature by setting non-empty temp dir.)
 110