Commit | Line | Data |
---|---|---|
09397bc6 VS |
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 | ||
7b28757f | 8 | This class is used by \helpref{wxHtmlHelpController}{wxhtmlhelpcontroller} |
09397bc6 VS |
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 | ||
09397bc6 VS |
13 | \wxheading{Derived from} |
14 | ||
15 | \helpref{wxObject}{wxobject} | |
16 | ||
9704b250 VS |
17 | \wxheading{Include files} |
18 | ||
19 | <wx/html/helpdata.h> | |
09397bc6 VS |
20 | |
21 | \latexignore{\rtfignore{\wxheading{Members}}} | |
22 | ||
09397bc6 VS |
23 | \membersection{wxHtmlHelpData::wxHtmlHelpData}\label{wxhtmlhelpdatawxhtmlhelpdata} |
24 | ||
25 | \func{}{wxHtmlHelpData}{\void} | |
26 | ||
27 | Constructor. | |
28 | ||
09397bc6 VS |
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 | ||
09397bc6 VS |
38 | \membersection{wxHtmlHelpData::FindPageById}\label{wxhtmlhelpdatafindpagebyid} |
39 | ||
40 | \func{wxString}{FindPageById}{\param{int }{id}} | |
41 | ||
42 | Returns page's URL based on integer ID stored in project. | |
43 | ||
09397bc6 VS |
44 | \membersection{wxHtmlHelpData::FindPageByName}\label{wxhtmlhelpdatafindpagebyname} |
45 | ||
46 | \func{wxString}{FindPageByName}{\param{const wxString\& }{page}} | |
47 | ||
48 | Returns page's URL based on its (file)name. | |
49 | ||
09397bc6 VS |
50 | \membersection{wxHtmlHelpData::GetBookRecArray}\label{wxhtmlhelpdatagetbookrecarray} |
51 | ||
52 | \func{const wxHtmlBookRecArray\&}{GetBookRecArray}{\void} | |
53 | ||
54 | Returns array with help books info. | |
55 | ||
56 | \membersection{wxHtmlHelpData::GetContents}\label{wxhtmlhelpdatagetcontents} | |
57 | ||
58 | \func{wxHtmlContentsItem*}{GetContents}{\void} | |
59 | ||
60 | Returns contents lists pointer. | |
61 | ||
62 | \membersection{wxHtmlHelpData::GetContentsCnt}\label{wxhtmlhelpdatagetcontentscnt} | |
63 | ||
64 | \func{int}{GetContentsCnt}{\void} | |
65 | ||
66 | Returns size of contents list. | |
67 | ||
68 | \membersection{wxHtmlHelpData::GetIndex}\label{wxhtmlhelpdatagetindex} | |
69 | ||
70 | \func{wxHtmlContentsItem*}{GetIndex}{\void} | |
71 | ||
72 | Returns pointer to index items list. | |
73 | ||
74 | \membersection{wxHtmlHelpData::GetIndexCnt}\label{wxhtmlhelpdatagetindexcnt} | |
75 | ||
76 | \func{int}{GetIndexCnt}{\void} | |
77 | ||
78 | Returns size of index list. | |
79 | ||
09397bc6 VS |
80 | \membersection{wxHtmlHelpData::SetTempDir}\label{wxhtmlhelpdatasettempdir} |
81 | ||
82 | \func{void}{SetTempDir}{\param{const wxString\& }{path}} | |
83 | ||
84 | Sets temporary directory where binary cached versions of MS HTML Workshop | |
85 | files will be stored. (This is turned off by default and you can enable | |
86 | this feature by setting non-empty temp dir.) | |
87 |