]>
Commit | Line | Data |
---|---|---|
1 | ///////////////////////////////////////////////////////////////////////////// | |
2 | // Name: helpxxxx.h | |
3 | // Purpose: Help system: native implementation for your system. | |
4 | // Author: David Webster | |
5 | // Modified by: | |
6 | // Created: 10/09/99 | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) David Webster | |
9 | // Licence: wxWindows licence | |
10 | ///////////////////////////////////////////////////////////////////////////// | |
11 | ||
12 | #ifndef _WX_HELPWIN_H_ | |
13 | #define _WX_HELPWIN_H_ | |
14 | ||
15 | #include "wx/wx.h" | |
16 | ||
17 | #if wxUSE_HELP | |
18 | ||
19 | #include "wx/helpbase.h" | |
20 | ||
21 | class WXDLLEXPORT wxWinHelpController: public wxHelpControllerBase | |
22 | { | |
23 | DECLARE_CLASS(wxWinHelpController) | |
24 | ||
25 | public: | |
26 | wxWinHelpController(); | |
27 | ~wxWinHelpController(); | |
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 | |
33 | virtual bool LoadFile(const wxString& file = ""); | |
34 | virtual bool DisplayContents(); | |
35 | virtual bool DisplaySection(int sectionNo); | |
36 | virtual bool DisplayBlock(long blockNo); | |
37 | virtual bool KeywordSearch(const wxString& k, | |
38 | wxHelpSearchMode mode = wxHELP_SEARCH_ALL); | |
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; | |
47 | private: | |
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); } | |
51 | }; | |
52 | ||
53 | #endif //wxUSE_HELP | |
54 | ||
55 | #endif | |
56 | // _WX_HELPWIN_H_ |