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
8This class is used by \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} 
9and \helpref{wxHtmlHelpFrame}{wxhtmlhelpframe} to access HTML help items.
10It is internal class and should not be used directly - except for the case 
11you're writing your own HTML help controller.
12
13\wxheading{Derived from}
14
15\helpref{wxObject}{wxobject}
16
17\wxheading{Include files}
18
19<wx/html/helpdata.h>
20
21\latexignore{\rtfignore{\wxheading{Members}}}
22
23\membersection{wxHtmlHelpData::wxHtmlHelpData}\label{wxhtmlhelpdatawxhtmlhelpdata}
24
25\func{}{wxHtmlHelpData}{\void}
26
27Constructor.
28
29\membersection{wxHtmlHelpData::AddBook}\label{wxhtmlhelpdataaddbook}
30
31\func{bool}{AddBook}{\param{const wxString\& }{book\_url}}
32
33Adds new book. {\it book} is URL (not filename!) of HTML help project (hhp)
34or ZIP file that contains arbitrary number of .hhp projects (this zip
35file can have either .zip or .htb extension, htb stands for "html book").
36Returns success.
37
38\membersection{wxHtmlHelpData::FindPageById}\label{wxhtmlhelpdatafindpagebyid}
39
40\func{wxString}{FindPageById}{\param{int }{id}}
41
42Returns page's URL based on integer ID stored in project.
43
44\membersection{wxHtmlHelpData::FindPageByName}\label{wxhtmlhelpdatafindpagebyname}
45
46\func{wxString}{FindPageByName}{\param{const wxString\& }{page}}
47
48Returns page's URL based on its (file)name.
49
50\membersection{wxHtmlHelpData::GetBookRecArray}\label{wxhtmlhelpdatagetbookrecarray}
51
52\func{const wxHtmlBookRecArray\&}{GetBookRecArray}{\void}
53
54Returns array with help books info.
55
56\membersection{wxHtmlHelpData::GetContentsArray}\label{wxhtmlhelpdatagetcontentsarray}
57
58\func{const wxHtmlHelpDataItems\&}{GetContentsArray}{\void}
59
60Returns reference to array with contents entries.
61
62\membersection{wxHtmlHelpData::GetIndexArray}\label{wxhtmlhelpdatagetindexarray}
63
64\func{const wxHtmlHelpDataItems\&}{GetIndexArray}{\void}
65
66Returns reference to array with index entries.
67
68\membersection{wxHtmlHelpData::SetTempDir}\label{wxhtmlhelpdatasettempdir}
69
70\func{void}{SetTempDir}{\param{const wxString\& }{path}}
71
72Sets temporary directory where binary cached versions of MS HTML Workshop
73files will be stored. (This is turned off by default and you can enable
74this feature by setting non-empty temp dir.)
75
76