X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/219a5f10c0e5efc3aad7ff3d050a92e7fed88806..498a1eeb8d044ef64815352ecabe4c223adf8c6a:/include/wx/html/helpctrl.h?ds=inline diff --git a/include/wx/html/helpctrl.h b/include/wx/html/helpctrl.h index 14b004dd7a..bb7e1e2126 100644 --- a/include/wx/html/helpctrl.h +++ b/include/wx/html/helpctrl.h @@ -14,46 +14,37 @@ #include "wx/defs.h" -#ifdef __GNUG__ +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma interface "helpctrl.h" #endif -#if wxUSE_HTML +#if wxUSE_WXHTML_HELP -#include "wx/html/helpfrm.h" #include "wx/helpbase.h" +#include "wx/html/helpfrm.h" -class WXDLLEXPORT wxHtmlHelpController : public wxHelpControllerBase // wxEvtHandler +#define wxID_HTML_HELPFRAME (wxID_HIGHEST + 1) + +class WXDLLIMPEXP_HTML wxHtmlHelpController : public wxHelpControllerBase // wxEvtHandler { DECLARE_DYNAMIC_CLASS(wxHtmlHelpController) public: - wxHtmlHelpController(int style = wxHF_DEFAULTSTYLE); + wxHtmlHelpController(int style = wxHF_DEFAULT_STYLE); virtual ~wxHtmlHelpController(); 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 m_helpFrame->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); + wxHtmlHelpFrame* GetFrame() { return m_helpFrame; } void UseConfig(wxConfigBase *config, const wxString& rootpath = wxEmptyString); @@ -68,7 +59,7 @@ public: 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 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); } @@ -77,7 +68,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, @@ -88,10 +79,14 @@ 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(); + protected: virtual wxHtmlHelpFrame* CreateHelpFrame(wxHtmlHelpData *data); @@ -105,8 +100,10 @@ protected: wxString m_titleFormat; int m_FrameStyle; // DECLARE_EVENT_TABLE() + + DECLARE_NO_COPY_CLASS(wxHtmlHelpController) }; -#endif +#endif // wxUSE_WXHTML_HELP #endif // _WX_HELPCTRL_H_