]>
Commit | Line | Data |
---|---|---|
1 | ///////////////////////////////////////////////////////////////////////////// | |
2 | // Name: wx/palmos/helpwin.h | |
3 | // Purpose: Help system: WinHelp implementation | |
4 | // Author: William Osborne - minimal working wxPalmOS port | |
5 | // Modified by: | |
6 | // Created: 10/13/04 | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) William Osborne | |
9 | // Licence: wxWindows licence | |
10 | ///////////////////////////////////////////////////////////////////////////// | |
11 | ||
12 | #ifndef _WX_HELP_H_ | |
13 | #define _WX_HELP_H_ | |
14 | ||
15 | #include "wx/wx.h" | |
16 | ||
17 | #if wxUSE_HELP | |
18 | ||
19 | #include "wx/helpbase.h" | |
20 | ||
21 | class WXDLLEXPORT wxPalmHelpController: public wxHelpControllerBase | |
22 | { | |
23 | DECLARE_CLASS(wxPalmHelpController) | |
24 | ||
25 | public: | |
26 | wxPalmHelpController() {} | |
27 | virtual ~wxPalmHelpController() {} | |
28 | ||
29 | // Must call this to set the filename | |
30 | virtual bool Initialize(const wxString& file); | |
31 | virtual bool Initialize(const wxString& file, int WXUNUSED(server) ) { return Initialize( file ); } | |
32 | ||
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); | |
37 | virtual bool DisplaySection(const wxString& section) { return KeywordSearch(section); } | |
38 | virtual bool DisplayBlock(long blockNo); | |
39 | virtual bool DisplayContextPopup(int contextId); | |
40 | virtual bool KeywordSearch(const wxString& k, | |
41 | wxHelpSearchMode mode = wxHELP_SEARCH_ALL); | |
42 | virtual bool Quit(); | |
43 | ||
44 | inline wxString GetHelpFile() const { return m_helpFile; } | |
45 | ||
46 | protected: | |
47 | // Append extension if necessary. | |
48 | wxString GetValidFilename(const wxString& file) const; | |
49 | ||
50 | private: | |
51 | wxString m_helpFile; | |
52 | }; | |
53 | ||
54 | #endif // wxUSE_HELP | |
55 | #endif | |
56 | // _WX_HELP_H_ |