]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/os2/helpwin.h
Use wxGetTranslation() instead of _() in the public headers.
[wxWidgets.git] / include / wx / os2 / helpwin.h
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////////
2// Name: wx/os2/helpwin.h
3// Purpose: Help system: native implementation for your system.
4// Author: David Webster
5// Modified by:
6// Created: 10/09/99
7// Copyright: (c) David Webster
8// Licence: wxWindows licence
9/////////////////////////////////////////////////////////////////////////////
10
11#ifndef _WX_HELPWIN_H_
12#define _WX_HELPWIN_H_
13
14#include "wx/wx.h"
15
16#if wxUSE_HELP
17
18#include "wx/helpbase.h"
19
20class WXDLLIMPEXP_CORE wxWinHelpController: public wxHelpControllerBase
21{
22 DECLARE_CLASS(wxWinHelpController)
23
24 public:
25 wxWinHelpController();
26 virtual ~wxWinHelpController();
27
28 // Must call this to set the filename and server name
29 virtual bool Initialize(const wxString& file);
30
31 // If file is "", reloads file given in Initialize
32 virtual bool LoadFile(const wxString& file = wxEmptyString);
33 virtual bool DisplayContents();
34 virtual bool DisplaySection(int sectionNo);
35 virtual bool DisplayBlock(long blockNo);
36 virtual bool KeywordSearch(const wxString& k,
37 wxHelpSearchMode mode = wxHELP_SEARCH_ALL);
38
39 virtual bool Quit();
40 virtual void OnQuit();
41
42 inline wxString GetHelpFile() const { return m_helpFile; }
43
44protected:
45 wxString m_helpFile;
46private:
47 // virtual function hiding supression :: do not use
48 bool Initialize(const wxString& rFile, int WXUNUSED(nServer) ) { return(Initialize(rFile)); }
49 bool DisplaySection(const wxString& rSection) { return wxHelpControllerBase::DisplaySection(rSection); }
50};
51
52#endif //wxUSE_HELP
53
54#endif
55 // _WX_HELPWIN_H_