]>
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 | 8 | // Copyright: (c) Julian Smart |
59af881e | 9 | // Licence: wxWindows licence |
2bda0e17 KB |
10 | ///////////////////////////////////////////////////////////////////////////// |
11 | ||
bbcdf8bc JS |
12 | #ifndef _WX_HELPWIN_H_ |
13 | #define _WX_HELPWIN_H_ | |
2bda0e17 | 14 | |
2bda0e17 KB |
15 | #include "wx/wx.h" |
16 | ||
47d67540 | 17 | #if wxUSE_HELP |
2bda0e17 KB |
18 | |
19 | #include "wx/helpbase.h" | |
20 | ||
21 | class WXDLLEXPORT wxWinHelpController: public wxHelpControllerBase | |
22 | { | |
f6bcfd97 | 23 | DECLARE_CLASS(wxWinHelpController) |
59af881e | 24 | |
f6bcfd97 | 25 | public: |
3db52265 | 26 | wxWinHelpController(wxWindow* parentWindow = NULL): wxHelpControllerBase(parentWindow) {} |
d3c7fc99 | 27 | virtual ~wxWinHelpController() {} |
2bda0e17 | 28 | |
f6bcfd97 BP |
29 | // Must call this to set the filename |
30 | virtual bool Initialize(const wxString& file); | |
0e4acbd4 | 31 | virtual bool Initialize(const wxString& file, int WXUNUSED(server) ) { return Initialize( file ); } |
2bda0e17 | 32 | |
f6bcfd97 BP |
33 | // If file is "", reloads file given in Initialize |
34 | virtual bool LoadFile(const wxString& file = wxEmptyString); | |
35 | virtual bool DisplayContents(); | |
36 | virtual bool DisplaySection(int sectionNo); | |
0e4acbd4 | 37 | virtual bool DisplaySection(const wxString& section) { return KeywordSearch(section); } |
f6bcfd97 | 38 | virtual bool DisplayBlock(long blockNo); |
5100cabf | 39 | virtual bool DisplayContextPopup(int contextId); |
69b5cec2 VS |
40 | virtual bool KeywordSearch(const wxString& k, |
41 | wxHelpSearchMode mode = wxHELP_SEARCH_ALL); | |
f6bcfd97 | 42 | virtual bool Quit(); |
2bda0e17 | 43 | |
f6bcfd97 | 44 | inline wxString GetHelpFile() const { return m_helpFile; } |
2bda0e17 KB |
45 | |
46 | protected: | |
f6bcfd97 BP |
47 | // Append extension if necessary. |
48 | wxString GetValidFilename(const wxString& file) const; | |
59af881e | 49 | |
f6bcfd97 BP |
50 | private: |
51 | wxString m_helpFile; | |
2bda0e17 KB |
52 | }; |
53 | ||
47d67540 | 54 | #endif // wxUSE_HELP |
2bda0e17 | 55 | #endif |
f6bcfd97 | 56 | // _WX_HELPWIN_H_ |