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