projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| c801d85f KB |
1 | ///////////////////////////////////////////////////////////////////////////// |
| 2 | // Name: helpbase.h | |
| 3 | // Purpose: Help system base classes | |
| 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 __HELPBASEH__ | |
| 13 | #define __HELPBASEH__ | |
| 14 | ||
| 15 | #ifdef __GNUG__ | |
| 16 | #pragma interface "helpbase.h" | |
| 17 | #endif | |
| 18 | ||
| 19 | #include "wx/wx.h" | |
| 20 | ||
| 21 | #if USE_HELP | |
| 22 | ||
| 23 | // Defines the API for help controllers | |
| 24 | class WXDLLEXPORT wxHelpControllerBase: public wxObject | |
| 25 | { | |
| 26 | DECLARE_CLASS(wxHelpControllerBase) | |
| 27 | ||
| 28 | public: | |
| 29 | inline wxHelpControllerBase(void) {} | |
| 30 | inline ~wxHelpControllerBase(void) {}; | |
| 31 | ||
| 32 | // Must call this to set the filename and server name. | |
| 33 | // server is only required when implementing TCP/IP-based | |
| 34 | // help controllers. | |
| 35 | virtual bool Initialize(const wxString& file, int server = -1) = 0; | |
| 36 | ||
| 37 | // If file is "", reloads file given in Initialize | |
| 38 | virtual bool LoadFile(const wxString& file = "") = 0; | |
| 39 | virtual bool DisplayContents(void) = 0; | |
| 40 | virtual bool DisplaySection(int sectionNo) = 0; | |
| 41 | virtual bool DisplayBlock(long blockNo) = 0; | |
| 42 | virtual bool KeywordSearch(const wxString& k) = 0; | |
| 43 | ||
| 44 | virtual bool Quit(void) = 0; | |
| 45 | virtual void OnQuit(void) {}; | |
| 46 | }; | |
| 47 | ||
| 48 | #endif // USE_HELP | |
| 49 | #endif | |
| 50 | // __HELPBASEH__ |