projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| f6bcfd97 BP |
1 | ///////////////////////////////////////////////////////////////////////////// |
| 2 | // Name: helpchm.h | |
| 3 | // Purpose: Help system: MS HTML Help implementation | |
| 4 | // Author: Julian Smart | |
| 5 | // Modified by: | |
| 6 | // Created: 16/04/2000 | |
| 7 | // RCS-ID: $Id$ | |
| 8 | // Copyright: (c) Julian Smart | |
| 9 | // Licence: wxWindows licence | |
| 10 | ///////////////////////////////////////////////////////////////////////////// | |
| 11 | ||
| 12 | #ifndef _WX_HELPCHM_H_ | |
| 13 | #define _WX_HELPCHM_H_ | |
| 14 | ||
| 15 | #ifdef __GNUG__ | |
| 16 | #pragma interface "helpchm.h" | |
| 17 | #endif | |
| 18 | ||
| 19 | #include "wx/wx.h" | |
| 20 | ||
| 21 | #if wxUSE_HELP | |
| 22 | ||
| 23 | #include "wx/helpbase.h" | |
| 24 | ||
| 25 | class WXDLLEXPORT wxCHMHelpController: public wxHelpControllerBase | |
| 26 | { | |
| 27 | DECLARE_CLASS(wxCHMHelpController) | |
| 28 | ||
| 29 | public: | |
| 30 | wxCHMHelpController() {} | |
| 31 | ~wxCHMHelpController() {} | |
| 32 | ||
| 33 | // Must call this to set the filename | |
| 34 | virtual bool Initialize(const wxString& file); | |
| 35 | ||
| 36 | // If file is "", reloads file given in Initialize | |
| 37 | virtual bool LoadFile(const wxString& file = wxEmptyString); | |
| 38 | virtual bool DisplayContents(); | |
| 39 | virtual bool DisplaySection(int sectionNo); | |
| 40 | virtual bool DisplaySection(const wxString& section); | |
| 41 | virtual bool DisplayBlock(long blockNo); | |
| 5100cabf JS |
42 | virtual bool DisplayContextPopup(int contextId); |
| 43 | virtual bool DisplayTextPopup(const wxString& text, const wxPoint& pos); | |
| f6bcfd97 BP |
44 | virtual bool KeywordSearch(const wxString& k); |
| 45 | virtual bool Quit(); | |
| 46 | ||
| 47 | inline wxString GetHelpFile() const { return m_helpFile; } | |
| 48 | ||
| 49 | protected: | |
| 50 | // Append extension if necessary. | |
| 51 | wxString GetValidFilename(const wxString& file) const; | |
| 52 | ||
| 53 | protected: | |
| 54 | wxString m_helpFile; | |
| 55 | }; | |
| 56 | ||
| 57 | #endif // wxUSE_HELP | |
| 58 | #endif | |
| 59 | // _WX_HELPCHM_H_ |