X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3723b7b1d8cbeebccef4f8ad7fe3884dfca9eca6..aac65598a1137a8a9d4d31155ba83833500aea4d:/include/wx/helpbase.h?ds=sidebyside diff --git a/include/wx/helpbase.h b/include/wx/helpbase.h index d6d7ff83b5..17443e79ac 100644 --- a/include/wx/helpbase.h +++ b/include/wx/helpbase.h @@ -47,9 +47,19 @@ public: // If file is "", reloads file given in Initialize virtual bool LoadFile(const wxString& file = "") = 0; + + // Displays the contents virtual bool DisplayContents(void) = 0; + + // Display the given section virtual bool DisplaySection(int sectionNo) = 0; + // Display the section using a context id + virtual bool DisplayContextPopup(int WXUNUSED(contextId)) { return FALSE; }; + + // Display the text in a popup, if possible + virtual bool DisplayTextPopup(const wxString& WXUNUSED(text), const wxPoint& WXUNUSED(pos)) { return FALSE; }; + // By default, uses KeywordSection to display a topic. Implementations // may override this for more specific behaviour. virtual bool DisplaySection(const wxString& section) { return KeywordSearch(section); }; @@ -76,34 +86,6 @@ public: virtual void OnQuit(void) {}; }; -/* - * wxContextHelp - * Invokes context-sensitive help. When the user - * clicks on a window, a wxEVT_HELP event will be sent to that - * window for the application to display help for. - */ - -class WXDLLEXPORT wxContextHelp: public wxObject -{ - DECLARE_DYNAMIC_CLASS(wxContextHelp) -public: - wxContextHelp(wxWindow* win = NULL, bool beginHelp = TRUE); - ~wxContextHelp(); - - bool BeginContextHelp(wxWindow* win); - bool EndContextHelp(); - - bool EventLoop(); - bool DispatchEvent(wxWindow* win, const wxPoint& pt); - - void SetStatus(bool status) { m_status = status; } - -protected: - - bool m_inHelp; - bool m_status; // TRUE if the user left-clicked -}; - #endif // wxUSE_HELP #endif // _WX_HELPBASEH__