]> git.saurik.com Git - wxWidgets.git/blame - include/wx/msw/helpwin.h
do #undef CreateDialog() under CE, what was the reason for not doing it?
[wxWidgets.git] / include / wx / msw / helpwin.h
CommitLineData
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
JS
8// Copyright: (c) Julian Smart
9// Licence: wxWindows licence
2bda0e17
KB
10/////////////////////////////////////////////////////////////////////////////
11
bbcdf8bc
JS
12#ifndef _WX_HELPWIN_H_
13#define _WX_HELPWIN_H_
2bda0e17 14
12028905 15#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
2bda0e17
KB
16#pragma interface "helpwin.h"
17#endif
18
19#include "wx/wx.h"
20
47d67540 21#if wxUSE_HELP
2bda0e17
KB
22
23#include "wx/helpbase.h"
24
25class WXDLLEXPORT wxWinHelpController: public wxHelpControllerBase
26{
f6bcfd97
BP
27 DECLARE_CLASS(wxWinHelpController)
28
29public:
30 wxWinHelpController() {};
31 ~wxWinHelpController() {};
2bda0e17 32
f6bcfd97
BP
33 // Must call this to set the filename
34 virtual bool Initialize(const wxString& file);
0e4acbd4 35 virtual bool Initialize(const wxString& file, int WXUNUSED(server) ) { return Initialize( file ); }
2bda0e17 36
f6bcfd97
BP
37 // If file is "", reloads file given in Initialize
38 virtual bool LoadFile(const wxString& file = wxEmptyString);
39 virtual bool DisplayContents();
40 virtual bool DisplaySection(int sectionNo);
0e4acbd4 41 virtual bool DisplaySection(const wxString& section) { return KeywordSearch(section); }
f6bcfd97 42 virtual bool DisplayBlock(long blockNo);
5100cabf 43 virtual bool DisplayContextPopup(int contextId);
69b5cec2
VS
44 virtual bool KeywordSearch(const wxString& k,
45 wxHelpSearchMode mode = wxHELP_SEARCH_ALL);
f6bcfd97 46 virtual bool Quit();
2bda0e17 47
f6bcfd97 48 inline wxString GetHelpFile() const { return m_helpFile; }
2bda0e17
KB
49
50protected:
f6bcfd97
BP
51 // Append extension if necessary.
52 wxString GetValidFilename(const wxString& file) const;
53
54private:
55 wxString m_helpFile;
2bda0e17
KB
56};
57
47d67540 58#endif // wxUSE_HELP
2bda0e17 59#endif
f6bcfd97 60// _WX_HELPWIN_H_