/////////////////////////////////////////////////////////////////////////////
-// Name: helpctrl.h
+// Name: wx/html/helpctrl.h
// Purpose: wxHtmlHelpController
// Notes: Based on htmlhelp.cpp, implementing a monolithic
// HTML Help controller class, by Vaclav Slavik
#include "wx/defs.h"
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#if wxUSE_HTML
+#if wxUSE_WXHTML_HELP
+#include "wx/helpbase.h"
#include "wx/html/helpfrm.h"
-class WXDLLEXPORT wxHtmlHelpController : public wxEvtHandler
+#define wxID_HTML_HELPFRAME (wxID_HIGHEST + 1)
+
+// This style indicates that the window is
+// embedded in the application and must not be
+// destroyed by the help controller.
+#define wxHF_EMBEDDED 0x00008000
+
+// Create a dialog for the help window.
+#define wxHF_DIALOG 0x00010000
+
+// Create a frame for the help window.
+#define wxHF_FRAME 0x00020000
+
+// Make the dialog modal when displaying help.
+#define wxHF_MODAL 0x00040000
+
+class WXDLLIMPEXP_FWD_HTML wxHtmlHelpDialog;
+class WXDLLIMPEXP_FWD_HTML wxHtmlHelpWindow;
+class WXDLLIMPEXP_FWD_HTML wxHtmlHelpFrame;
+class WXDLLIMPEXP_FWD_HTML wxHtmlHelpDialog;
+
+class WXDLLIMPEXP_HTML wxHtmlHelpController : public wxHelpControllerBase // wxEvtHandler
{
DECLARE_DYNAMIC_CLASS(wxHtmlHelpController)
public:
- wxHtmlHelpController();
+ wxHtmlHelpController(int style = wxHF_DEFAULT_STYLE, wxWindow* parentWindow = NULL);
+ wxHtmlHelpController(wxWindow* parentWindow, int style = wxHF_DEFAULT_STYLE);
+
virtual ~wxHtmlHelpController();
+ void SetShouldPreventAppExit(bool enable);
+
void SetTitleFormat(const wxString& format);
void SetTempDir(const wxString& path) { m_helpData.SetTempDir(path); }
- bool AddBook(const wxString& book, bool show_wait_msg = FALSE);
- bool Display(const wxString& x) {
- CreateHelpWindow(); return m_helpFrame->Display(x);
- }
- bool Display(int id) {
- CreateHelpWindow(); return m_helpFrame->Display(id);
- }
- bool DisplayContents() {
- CreateHelpWindow(); return m_helpFrame->DisplayContents();
- }
- bool DisplayIndex() {
- CreateHelpWindow(); return m_helpFrame->DisplayIndex();
- }
- bool KeywordSearch(const wxString& keyword) {
- CreateHelpWindow(); return KeywordSearch(keyword);
- }
+ bool AddBook(const wxString& book_url, bool show_wait_msg = false);
+ bool AddBook(const wxFileName& book_file, bool show_wait_msg = false);
+
+ bool Display(const wxString& x);
+ bool Display(int id);
+ bool DisplayContents();
+ bool DisplayIndex();
+ bool KeywordSearch(const wxString& keyword,
+ wxHelpSearchMode mode = wxHELP_SEARCH_ALL);
+
+ wxHtmlHelpWindow* GetHelpWindow() { return m_helpWindow; }
+ void SetHelpWindow(wxHtmlHelpWindow* helpWindow);
+
wxHtmlHelpFrame* GetFrame() { return m_helpFrame; }
- void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString) {
- m_Config = config; m_ConfigRoot = rootpath;
- ReadCustomization(config, rootpath);
- }
+ wxHtmlHelpDialog* GetDialog() { return m_helpDialog; }
+
+#if wxUSE_CONFIG
+ void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString);
+
// Assigns config object to the Ctrl. This config is then
// used in subsequent calls to Read/WriteCustomization of both help
// Ctrl and it's wxHtmlWindow
virtual void ReadCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString);
virtual void WriteCustomization(wxConfigBase *cfg, const wxString& path = wxEmptyString);
- virtual void CreateHelpWindow(bool show_progress = FALSE);
- virtual void DestroyHelpWindow() {
- //if (m_Config) WriteCustomization(m_Config, m_ConfigRoot);
- if (m_helpFrame) m_helpFrame->Destroy();
- }
+#endif // wxUSE_CONFIG
+
+ //// Backward compatibility with wxHelpController API
+
+ virtual bool Initialize(const wxString& file, int WXUNUSED(server) ) { return Initialize(file); }
+ virtual bool Initialize(const wxString& file);
+ virtual void SetViewer(const wxString& WXUNUSED(viewer), long WXUNUSED(flags) = 0) {}
+ virtual bool LoadFile(const wxString& file = wxT(""));
+ virtual bool DisplaySection(int sectionNo);
+ virtual bool DisplaySection(const wxString& section) { return Display(section); }
+ virtual bool DisplayBlock(long blockNo) { return DisplaySection(blockNo); }
+ virtual bool DisplayTextPopup(const wxString& text, const wxPoint& pos);
+
+ virtual void SetFrameParameters(const wxString& title,
+ const wxSize& size,
+ const wxPoint& pos = wxDefaultPosition,
+ bool newFrameEachTime = false);
+ /// Obtains the latest settings used by the help frame and the help
+ /// frame.
+ virtual wxFrame *GetFrameParameters(wxSize *size = NULL,
+ wxPoint *pos = NULL,
+ bool *newFrameEachTime = NULL);
+
+ // Get direct access to help data:
+ wxHtmlHelpData *GetHelpData() { return &m_helpData; }
+
+ virtual bool Quit() ;
+ virtual void OnQuit() {}
+
+ void OnCloseFrame(wxCloseEvent& evt);
+
+ // Make the help controller's frame 'modal' if
+ // needed
+ void MakeModalIfNeeded();
+
+ // Find the top-most parent window
+ wxWindow* FindTopLevelWindow();
+
protected:
- void OnCloseFrame(wxCloseEvent& evt) { m_helpFrame = NULL; evt.Skip(); }
- wxHtmlHelpData m_helpData;
- wxHtmlHelpFrame* m_helpFrame;
- wxConfigBase *m_Config;
- wxString m_ConfigRoot;
- wxString m_titleFormat;
- DECLARE_EVENT_TABLE()
+ void Init(int style);
+
+ virtual wxWindow* CreateHelpWindow();
+ virtual wxHtmlHelpFrame* CreateHelpFrame(wxHtmlHelpData *data);
+ virtual wxHtmlHelpDialog* CreateHelpDialog(wxHtmlHelpData *data);
+ virtual void DestroyHelpWindow();
+
+ wxHtmlHelpData m_helpData;
+ wxHtmlHelpWindow* m_helpWindow;
+#if wxUSE_CONFIG
+ wxConfigBase * m_Config;
+ wxString m_ConfigRoot;
+#endif // wxUSE_CONFIG
+ wxString m_titleFormat;
+ int m_FrameStyle;
+ wxHtmlHelpFrame* m_helpFrame;
+ wxHtmlHelpDialog* m_helpDialog;
+
+ bool m_shouldPreventAppExit;
+
+ wxDECLARE_NO_COPY_CLASS(wxHtmlHelpController);
+};
+
+/*
+ * wxHtmlModalHelp
+ * A convenience class particularly for use on wxMac,
+ * where you can only show modal dialogs from a modal
+ * dialog.
+ *
+ * Use like this:
+ *
+ * wxHtmlModalHelp help(parent, filename, topic);
+ *
+ * If topic is empty, the help contents is displayed.
+ */
+
+class WXDLLIMPEXP_HTML wxHtmlModalHelp
+{
+public:
+ wxHtmlModalHelp(wxWindow* parent, const wxString& helpFile, const wxString& topic = wxEmptyString,
+ int style = wxHF_DEFAULT_STYLE | wxHF_DIALOG | wxHF_MODAL);
};
-#endif
+#endif // wxUSE_WXHTML_HELP
#endif // _WX_HELPCTRL_H_
projects / wxWidgets.git / blobdiff