X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/655719367ac5e131d9642e5783f3ecf64d1a3385..058f225a44d83d42ba9d773efc705badbf0e5e3c:/include/wx/html/helpctrl.h diff --git a/include/wx/html/helpctrl.h b/include/wx/html/helpctrl.h index 06e6bdc7ee..15328a0ad1 100644 --- a/include/wx/html/helpctrl.h +++ b/include/wx/html/helpctrl.h @@ -14,10 +14,6 @@ #include "wx/defs.h" -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) -#pragma interface "helpctrl.h" -#endif - #if wxUSE_WXHTML_HELP #include "wx/helpbase.h" @@ -25,18 +21,37 @@ #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(int style = wxHF_DEFAULT_STYLE); + wxHtmlHelpController(int style = wxHF_DEFAULT_STYLE, wxWindow* parentWindow = NULL); virtual ~wxHtmlHelpController(); void SetTitleFormat(const wxString& format); void SetTempDir(const wxString& path) { m_helpData.SetTempDir(path); } - bool AddBook(const wxString& book_url, bool show_wait_msg = FALSE); - bool AddBook(const wxFileName& book_file, bool show_wait_msg = FALSE); + 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); @@ -45,7 +60,12 @@ public: bool KeywordSearch(const wxString& keyword, wxHelpSearchMode mode = wxHELP_SEARCH_ALL); + wxHtmlHelpWindow* GetHelpWindow() { return m_helpWindow; } + void SetHelpWindow(wxHtmlHelpWindow* helpWindow); + wxHtmlHelpFrame* GetFrame() { return m_helpFrame; } + wxHtmlHelpDialog* GetDialog() { return m_helpDialog; } + void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString); // Assigns config object to the Ctrl. This config is then @@ -68,7 +88,7 @@ public: virtual void SetFrameParameters(const wxString& title, const wxSize& size, const wxPoint& pos = wxDefaultPosition, - bool newFrameEachTime = FALSE); + bool newFrameEachTime = false); /// Obtains the latest settings used by the help frame and the help /// frame. virtual wxFrame *GetFrameParameters(wxSize *size = NULL, @@ -79,31 +99,55 @@ public: wxHtmlHelpData *GetHelpData() { return &m_helpData; } virtual bool Quit() ; - virtual void OnQuit() {}; + virtual void OnQuit() {} void OnCloseFrame(wxCloseEvent& evt); // Make the help controller's frame 'modal' if // needed - void AddGrabIfNeeded(); + void MakeModalIfNeeded(); + + // Find the top-most parent window + wxWindow* FindTopLevelWindow(); protected: + virtual wxWindow* CreateHelpWindow(); virtual wxHtmlHelpFrame* CreateHelpFrame(wxHtmlHelpData *data); - - virtual void CreateHelpWindow(); + virtual wxHtmlHelpDialog* CreateHelpDialog(wxHtmlHelpData *data); virtual void DestroyHelpWindow(); wxHtmlHelpData m_helpData; - wxHtmlHelpFrame* m_helpFrame; + wxHtmlHelpWindow* m_helpWindow; wxConfigBase * m_Config; wxString m_ConfigRoot; wxString m_titleFormat; int m_FrameStyle; - // DECLARE_EVENT_TABLE() + wxHtmlHelpFrame* m_helpFrame; + wxHtmlHelpDialog* m_helpDialog; DECLARE_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 // wxUSE_WXHTML_HELP #endif // _WX_HELPCTRL_H_