]>
Commit | Line | Data |
---|---|---|
0e320a79 DW |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: helpxxxx.h | |
fb9010ed DW |
3 | // Purpose: Help system: native implementation for your system. |
4 | // Author: David Webster | |
0e320a79 | 5 | // Modified by: |
fb9010ed | 6 | // Created: 10/09/99 |
0e320a79 | 7 | // RCS-ID: $Id$ |
fb9010ed | 8 | // Copyright: (c) David Webster |
65571936 | 9 | // Licence: wxWindows licence |
0e320a79 DW |
10 | ///////////////////////////////////////////////////////////////////////////// |
11 | ||
fb9010ed DW |
12 | #ifndef _WX_HELPWIN_H_ |
13 | #define _WX_HELPWIN_H_ | |
0e320a79 | 14 | |
99f73df9 | 15 | #include "wx/wx.h" |
d7e1a322 DW |
16 | |
17 | #if wxUSE_HELP | |
0e320a79 DW |
18 | |
19 | #include "wx/helpbase.h" | |
20 | ||
fb9010ed | 21 | class WXDLLEXPORT wxWinHelpController: public wxHelpControllerBase |
0e320a79 | 22 | { |
fb9010ed | 23 | DECLARE_CLASS(wxWinHelpController) |
0e320a79 DW |
24 | |
25 | public: | |
fb9010ed | 26 | wxWinHelpController(); |
d3c7fc99 | 27 | virtual ~wxWinHelpController(); |
0e320a79 DW |
28 | |
29 | // Must call this to set the filename and server name | |
30 | virtual bool Initialize(const wxString& file); | |
31 | ||
32 | // If file is "", reloads file given in Initialize | |
edf1dfa1 | 33 | virtual bool LoadFile(const wxString& file = wxEmptyString); |
0e320a79 DW |
34 | virtual bool DisplayContents(); |
35 | virtual bool DisplaySection(int sectionNo); | |
36 | virtual bool DisplayBlock(long blockNo); | |
69b5cec2 VS |
37 | virtual bool KeywordSearch(const wxString& k, |
38 | wxHelpSearchMode mode = wxHELP_SEARCH_ALL); | |
0e320a79 DW |
39 | |
40 | virtual bool Quit(); | |
41 | virtual void OnQuit(); | |
42 | ||
43 | inline wxString GetHelpFile() const { return m_helpFile; } | |
44 | ||
45 | protected: | |
46 | wxString m_helpFile; | |
fb9010ed | 47 | private: |
f6bcfd97 BP |
48 | // virtual function hiding supression :: do not use |
49 | bool Initialize(const wxString& rFile, int WXUNUSED(nServer) ) { return(Initialize(rFile)); } | |
50 | bool DisplaySection(const wxString& rSection) { return wxHelpControllerBase::DisplaySection(rSection); } | |
0e320a79 DW |
51 | }; |
52 | ||
d7e1a322 DW |
53 | #endif //wxUSE_HELP |
54 | ||
0e320a79 | 55 | #endif |
fb9010ed | 56 | // _WX_HELPWIN_H_ |