]>
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$ | |
bbcdf8bc JS |
8 | // Copyright: (c) Julian Smart |
9 | // Licence: wxWindows licence | |
2bda0e17 KB |
10 | ///////////////////////////////////////////////////////////////////////////// |
11 | ||
bbcdf8bc JS |
12 | #ifndef _WX_HELPWIN_H_ |
13 | #define _WX_HELPWIN_H_ | |
2bda0e17 KB |
14 | |
15 | #ifdef __GNUG__ | |
16 | #pragma interface "helpwin.h" | |
17 | #endif | |
18 | ||
19 | #include "wx/wx.h" | |
20 | ||
47d67540 | 21 | #if wxUSE_HELP |
2bda0e17 KB |
22 | |
23 | #include "wx/helpbase.h" | |
24 | ||
25 | class WXDLLEXPORT wxWinHelpController: public wxHelpControllerBase | |
26 | { | |
f6bcfd97 BP |
27 | DECLARE_CLASS(wxWinHelpController) |
28 | ||
29 | public: | |
30 | wxWinHelpController() {}; | |
31 | ~wxWinHelpController() {}; | |
2bda0e17 | 32 | |
f6bcfd97 BP |
33 | // Must call this to set the filename |
34 | virtual bool Initialize(const wxString& file); | |
2bda0e17 | 35 | |
f6bcfd97 BP |
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 DisplayBlock(long blockNo); | |
5100cabf | 41 | virtual bool DisplayContextPopup(int contextId); |
f6bcfd97 BP |
42 | virtual bool KeywordSearch(const wxString& k); |
43 | virtual bool Quit(); | |
2bda0e17 | 44 | |
f6bcfd97 | 45 | inline wxString GetHelpFile() const { return m_helpFile; } |
2bda0e17 KB |
46 | |
47 | protected: | |
f6bcfd97 BP |
48 | // Append extension if necessary. |
49 | wxString GetValidFilename(const wxString& file) const; | |
50 | ||
51 | private: | |
52 | wxString m_helpFile; | |
2bda0e17 KB |
53 | }; |
54 | ||
47d67540 | 55 | #endif // wxUSE_HELP |
2bda0e17 | 56 | #endif |
f6bcfd97 | 57 | // _WX_HELPWIN_H_ |