]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/msw/helpchm.h
fixed outdated filenames
[wxWidgets.git] / include / wx / msw / helpchm.h
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////////
2// Name: helpchm.h
3// Purpose: Help system: MS HTML Help implementation
4// Author: Julian Smart
5// Modified by:
6// Created: 16/04/2000
7// RCS-ID: $Id$
8// Copyright: (c) Julian Smart
9// Licence: wxWindows licence
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_HELPCHM_H_
13#define _WX_HELPCHM_H_
14
15#ifdef __GNUG__
16#pragma interface "helpchm.h"
17#endif
18
19#if wxUSE_MS_HTML_HELP
20
21#include "wx/helpbase.h"
22
23class WXDLLEXPORT wxCHMHelpController : public wxHelpControllerBase
24{
25public:
26 wxCHMHelpController() { }
27 virtual ~wxCHMHelpController();
28
29 // Must call this to set the filename
30 virtual bool Initialize(const wxString& file);
31
32 // If file is "", reloads file given in Initialize
33 virtual bool LoadFile(const wxString& file = wxEmptyString);
34 virtual bool DisplayContents();
35 virtual bool DisplaySection(int sectionNo);
36 virtual bool DisplaySection(const wxString& section);
37 virtual bool DisplayBlock(long blockNo);
38 virtual bool DisplayContextPopup(int contextId);
39 virtual bool DisplayTextPopup(const wxString& text, const wxPoint& pos);
40 virtual bool KeywordSearch(const wxString& k);
41 virtual bool Quit();
42
43 wxString GetHelpFile() const { return m_helpFile; }
44
45protected:
46 // Append extension if necessary.
47 wxString GetValidFilename(const wxString& file) const;
48
49protected:
50 wxString m_helpFile;
51
52 DECLARE_CLASS(wxCHMHelpController)
53};
54
55#endif // wxUSE_MS_HTML_HELP
56
57#endif
58// _WX_HELPCHM_H_