// Created: 04/01/98
// RCS-ID: $Id$
// Copyright: (c) Julian Smart
-// Licence: wxWindows licence
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_HELPWIN_H_
#define _WX_HELPWIN_H_
-#ifdef __GNUG__
-#pragma interface "helpwin.h"
-#endif
-
#include "wx/wx.h"
#if wxUSE_HELP
#include "wx/helpbase.h"
-class WXDLLEXPORT wxWinHelpController: public wxHelpControllerBase
+class WXDLLIMPEXP_CORE wxWinHelpController: public wxHelpControllerBase
{
- DECLARE_CLASS(wxWinHelpController)
+ DECLARE_CLASS(wxWinHelpController)
- public:
- wxWinHelpController(void);
- ~wxWinHelpController(void);
+public:
+ wxWinHelpController(wxWindow* parentWindow = NULL): wxHelpControllerBase(parentWindow) {}
+ virtual ~wxWinHelpController() {}
- // Must call this to set the filename and server name
- virtual bool Initialize(const wxString& file);
+ // Must call this to set the filename
+ virtual bool Initialize(const wxString& file);
+ virtual bool Initialize(const wxString& file, int WXUNUSED(server) ) { return Initialize( file ); }
- // If file is "", reloads file given in Initialize
- virtual bool LoadFile(const wxString& file = "");
- virtual bool DisplayContents(void);
- virtual bool DisplaySection(int sectionNo);
- virtual bool DisplayBlock(long blockNo);
- virtual bool KeywordSearch(const wxString& k);
+ // If file is "", reloads file given in Initialize
+ virtual bool LoadFile(const wxString& file = wxEmptyString);
+ virtual bool DisplayContents();
+ virtual bool DisplaySection(int sectionNo);
+ virtual bool DisplaySection(const wxString& section) { return KeywordSearch(section); }
+ virtual bool DisplayBlock(long blockNo);
+ virtual bool DisplayContextPopup(int contextId);
+ virtual bool KeywordSearch(const wxString& k,
+ wxHelpSearchMode mode = wxHELP_SEARCH_ALL);
+ virtual bool Quit();
- virtual bool Quit(void);
- virtual void OnQuit(void);
-
- inline wxString GetHelpFile(void) const { return m_helpFile; }
+ inline wxString GetHelpFile() const { return m_helpFile; }
protected:
- wxString m_helpFile;
+ // Append extension if necessary.
+ wxString GetValidFilename(const wxString& file) const;
+
+private:
+ wxString m_helpFile;
};
#endif // wxUSE_HELP
#endif
- // _WX_HELPWIN_H_
+// _WX_HELPWIN_H_