projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 2bda0e17 KB |
1 | ///////////////////////////////////////////////////////////////////////////// |
| 2 | // Name: helpwin.h | |
| 3 | // Purpose: Help system: WinHelp implementation | |
| 4 | // Author: Julian Smart | |
| 5 | // Modified by: | |
| 6 | // Created: 04/01/98 | |
| 7 | // RCS-ID: $Id$ | |
| 8 | // Copyright: (c) Julian Smart and Markus Holzem | |
| 9 | // Licence: wxWindows license | |
| 10 | ///////////////////////////////////////////////////////////////////////////// | |
| 11 | ||
| 12 | #ifndef __HELPWINH__ | |
| 13 | #define __HELPWINH__ | |
| 14 | ||
| 15 | #ifdef __GNUG__ | |
| 16 | #pragma interface "helpwin.h" | |
| 17 | #endif | |
| 18 | ||
| 19 | #include "wx/wx.h" | |
| 20 | ||
| 21 | #if USE_HELP | |
| 22 | ||
| 23 | #include "wx/helpbase.h" | |
| 24 | ||
| 25 | class WXDLLEXPORT wxWinHelpController: public wxHelpControllerBase | |
| 26 | { | |
| 27 | DECLARE_CLASS(wxWinHelpController) | |
| 28 | ||
| 29 | public: | |
| 30 | wxWinHelpController(void); | |
| 31 | ~wxWinHelpController(void); | |
| 32 | ||
| 33 | // Must call this to set the filename and server name | |
| 34 | virtual bool Initialize(const wxString& file, int server = -1); | |
| 35 | ||
| 36 | // If file is "", reloads file given in Initialize | |
| 37 | virtual bool LoadFile(const wxString& file = ""); | |
| 38 | virtual bool DisplayContents(void); | |
| 39 | virtual bool DisplaySection(int sectionNo); | |
| 40 | virtual bool DisplayBlock(long blockNo); | |
| 41 | virtual bool KeywordSearch(const wxString& k); | |
| 42 | ||
| 43 | virtual bool Quit(void); | |
| 44 | virtual void OnQuit(void); | |
| 45 | ||
| 46 | inline wxString GetHelpFile(void) const { return m_helpFile; } | |
| 47 | ||
| 48 | protected: | |
| 49 | wxString m_helpFile; | |
| 50 | }; | |
| 51 | ||
| 52 | #endif // USE_HELP | |
| 53 | #endif | |
| 54 | // __HELPWINH__ |