]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/msw/helpwin.h
Added some missing STL-like wxArray/wxArrayString constructors.
[wxWidgets.git] / include / wx / msw / helpwin.h
... / ...
CommitLineData
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$
8// Copyright: (c) Julian Smart
9// Licence: wxWindows licence
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_HELPWIN_H_
13#define _WX_HELPWIN_H_
14
15#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
16#pragma interface "helpwin.h"
17#endif
18
19#include "wx/wx.h"
20
21#if wxUSE_HELP
22
23#include "wx/helpbase.h"
24
25class WXDLLEXPORT wxWinHelpController: public wxHelpControllerBase
26{
27 DECLARE_CLASS(wxWinHelpController)
28
29public:
30 wxWinHelpController() {};
31 ~wxWinHelpController() {};
32
33 // Must call this to set the filename
34 virtual bool Initialize(const wxString& file);
35 virtual bool Initialize(const wxString& file, int WXUNUSED(server) ) { return Initialize( file ); }
36
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);
41 virtual bool DisplaySection(const wxString& section) { return KeywordSearch(section); }
42 virtual bool DisplayBlock(long blockNo);
43 virtual bool DisplayContextPopup(int contextId);
44 virtual bool KeywordSearch(const wxString& k,
45 wxHelpSearchMode mode = wxHELP_SEARCH_ALL);
46 virtual bool Quit();
47
48 inline wxString GetHelpFile() const { return m_helpFile; }
49
50protected:
51 // Append extension if necessary.
52 wxString GetValidFilename(const wxString& file) const;
53
54private:
55 wxString m_helpFile;
56};
57
58#endif // wxUSE_HELP
59#endif
60// _WX_HELPWIN_H_