X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/052e12db71e84fef1c7209daf931a056ad965918..21e052699d74ff3443002e515fb30f3a657b105c:/include/wx/html/helpctrl.h diff --git a/include/wx/html/helpctrl.h b/include/wx/html/helpctrl.h index 85511c8725..b1808aa4bd 100644 --- a/include/wx/html/helpctrl.h +++ b/include/wx/html/helpctrl.h @@ -21,8 +21,9 @@ #if wxUSE_HTML #include "wx/html/helpfrm.h" +#include "wx/helpbase.h" -class WXDLLEXPORT wxHtmlHelpController : public wxEvtHandler +class WXDLLEXPORT wxHtmlHelpController : public wxHelpControllerBase // wxEvtHandler { DECLARE_DYNAMIC_CLASS(wxHtmlHelpController) @@ -54,35 +55,51 @@ class WXDLLEXPORT wxHtmlHelpController : public wxEvtHandler CreateHelpWindow(); return m_helpFrame->KeywordSearch(keyword); } wxHtmlHelpFrame* GetFrame() { return m_helpFrame; } - void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString) - { - m_Config = config; - m_ConfigRoot = rootpath; - if (m_helpFrame) m_helpFrame -> UseConfig(config, rootpath); - ReadCustomization(config, rootpath); - } + 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); + //// 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 = ""); + 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); + virtual bool Quit() ; + virtual void OnQuit() {}; + + void OnCloseFrame(wxCloseEvent& evt); protected: + virtual wxHtmlHelpFrame* CreateHelpFrame(wxHtmlHelpData *data); + virtual void CreateHelpWindow(); - virtual void DestroyHelpWindow() - { - //if (m_Config) WriteCustomization(m_Config, m_ConfigRoot); - if (m_helpFrame) m_helpFrame->Destroy(); - } + virtual void DestroyHelpWindow(); - void OnCloseFrame(wxCloseEvent& evt) { m_helpFrame = NULL; evt.Skip(); } - wxHtmlHelpData m_helpData; - wxHtmlHelpFrame* m_helpFrame; - wxConfigBase *m_Config; - wxString m_ConfigRoot; - wxString m_titleFormat; - int m_FrameStyle; - DECLARE_EVENT_TABLE() + wxHtmlHelpData m_helpData; + wxHtmlHelpFrame* m_helpFrame; + wxConfigBase * m_Config; + wxString m_ConfigRoot; + wxString m_titleFormat; + int m_FrameStyle; + // DECLARE_EVENT_TABLE() }; #endif