projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 23324ae1 FM |
1 | ///////////////////////////////////////////////////////////////////////////// |
| 2 | // Name: html/helpdata.h | |
| 3 | // Purpose: documentation for wxHtmlHelpData class | |
| 4 | // Author: wxWidgets team | |
| 5 | // RCS-ID: $Id$ | |
| 6 | // Licence: wxWindows license | |
| 7 | ///////////////////////////////////////////////////////////////////////////// | |
| 8 | ||
| 9 | /** | |
| 10 | @class wxHtmlHelpData | |
| 11 | @headerfile helpdata.h wx/html/helpdata.h | |
| 7c913512 FM |
12 | |
| 13 | This class is used by wxHtmlHelpController | |
| 23324ae1 | 14 | and wxHtmlHelpFrame to access HTML help items. |
| 7c913512 | 15 | It is internal class and should not be used directly - except for the case |
| 23324ae1 | 16 | you're writing your own HTML help controller. |
| 7c913512 | 17 | |
| 23324ae1 FM |
18 | @library{wxhtml} |
| 19 | @category{FIXME} | |
| 20 | */ | |
| 21 | class wxHtmlHelpData : public wxObject | |
| 22 | { | |
| 23 | public: | |
| 24 | /** | |
| 25 | Constructor. | |
| 26 | */ | |
| 27 | wxHtmlHelpData(); | |
| 28 | ||
| 29 | /** | |
| 30 | Adds new book. @e book is URL (not filename!) of HTML help project (hhp) | |
| 31 | or ZIP file that contains arbitrary number of .hhp projects (this zip | |
| 32 | file can have either .zip or .htb extension, htb stands for "html book"). | |
| 33 | Returns success. | |
| 34 | */ | |
| 35 | bool AddBook(const wxString& book_url); | |
| 36 | ||
| 37 | /** | |
| 38 | Returns page's URL based on integer ID stored in project. | |
| 39 | */ | |
| 40 | wxString FindPageById(int id); | |
| 41 | ||
| 42 | /** | |
| 43 | Returns page's URL based on its (file)name. | |
| 44 | */ | |
| 45 | wxString FindPageByName(const wxString& page); | |
| 46 | ||
| 47 | /** | |
| 48 | Returns array with help books info. | |
| 49 | */ | |
| 50 | const wxHtmlBookRecArray GetBookRecArray(); | |
| 51 | ||
| 52 | /** | |
| 53 | Returns reference to array with contents entries. | |
| 54 | */ | |
| 55 | const wxHtmlHelpDataItems GetContentsArray(); | |
| 56 | ||
| 57 | /** | |
| 58 | Returns reference to array with index entries. | |
| 59 | */ | |
| 60 | const wxHtmlHelpDataItems GetIndexArray(); | |
| 61 | ||
| 62 | /** | |
| 63 | Sets temporary directory where binary cached versions of MS HTML Workshop | |
| 64 | files will be stored. (This is turned off by default and you can enable | |
| 65 | this feature by setting non-empty temp dir.) | |
| 66 | */ | |
| 67 | void SetTempDir(const wxString& path); | |
| 68 | }; |