projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 8cf73271 SC |
1 | ///////////////////////////////////////////////////////////////////////////// |
| 2 | // Name: helpxxxx.h | |
| 3 | // Purpose: Help system: native implementation for your system. Replace | |
| 4 | // XXXX with suitable name. | |
| 5 | // Author: Stefan Csomor | |
| 6 | // Modified by: | |
| 7 | // Created: 1998-01-01 | |
| 8 | // RCS-ID: $Id$ | |
| 9 | // Copyright: (c) Stefan Csomor | |
| 77ffb593 | 10 | // Licence: wxWidgets licence |
| 8cf73271 SC |
11 | ///////////////////////////////////////////////////////////////////////////// |
| 12 | ||
| 13 | #ifndef _WX_HELPXXXX_H_ | |
| 14 | #define _WX_HELPXXXX_H_ | |
| 15 | ||
| 16 | #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) | |
| 17 | #pragma interface "helpxxxx.h" | |
| 18 | #endif | |
| 19 | ||
| 20 | #include "wx/wx.h" | |
| 21 | ||
| 22 | #include "wx/helpbase.h" | |
| 23 | ||
| 24 | class WXDLLEXPORT wxXXXXHelpController: public wxHelpControllerBase | |
| 25 | { | |
| 26 | DECLARE_CLASS(wxXXXXHelpController) | |
| 27 | ||
| 28 | public: | |
| 29 | wxXXXXHelpController(); | |
| 30 | ~wxXXXXHelpController(); | |
| 31 | ||
| 32 | // Must call this to set the filename and server name | |
| 33 | virtual bool Initialize(const wxString& file); | |
| 34 | ||
| 35 | // If file is "", reloads file given in Initialize | |
| 36 | virtual bool LoadFile(const wxString& file = ""); | |
| 37 | virtual bool DisplayContents(); | |
| 38 | virtual bool DisplaySection(int sectionNo); | |
| 39 | virtual bool DisplayBlock(long blockNo); | |
| 40 | virtual bool KeywordSearch(const wxString& k, | |
| 41 | wxHelpSearchMode mode = wxHELP_SEARCH_ALL); | |
| 42 | ||
| 43 | virtual bool Quit(); | |
| 44 | virtual void OnQuit(); | |
| 45 | ||
| 46 | inline wxString GetHelpFile() const { return m_helpFile; } | |
| 47 | ||
| 48 | protected: | |
| 49 | wxString m_helpFile; | |
| 50 | }; | |
| 51 | ||
| 52 | #endif | |
| 53 | // _WX_HELPXXXX_H_ |