X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/68379eaf0ae64d105f8244b1db83e793f7dd83b0..c3e54dee9173954a7f18a88632fbc263695938f6:/include/wx/cshelp.h diff --git a/include/wx/cshelp.h b/include/wx/cshelp.h index 9780189ffe..e80c2d0ab4 100644 --- a/include/wx/cshelp.h +++ b/include/wx/cshelp.h @@ -9,12 +9,8 @@ // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -#ifndef _WX_CSHELPH__ -#define _WX_CSHELPH__ - -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) - #pragma interface "cshelp.h" -#endif +#ifndef _WX_CSHELP_H_ +#define _WX_CSHELP_H_ #include "wx/defs.h" @@ -27,6 +23,8 @@ #include "wx/bmpbuttn.h" #endif +#include "wx/event.h" + // ---------------------------------------------------------------------------- // classes used to implement context help UI // ---------------------------------------------------------------------------- @@ -95,6 +93,19 @@ private: // // The current help provider must be explicitly set by the application using // wxHelpProvider::Set(). +// +// Special note about ShowHelpAtPoint() and ShowHelp(): we want to be able to +// override ShowHelpAtPoint() when we need to use different help messages for +// different parts of the window, but it should also be possible to override +// just ShowHelp() both for backwards compatibility and just because most +// often the help does not, in fact, depend on the position and so +// implementing just ShowHelp() is simpler and more natural, so by default +// ShowHelpAtPoint() forwards to ShowHelp(). But this means that +// wxSimpleHelpProvider has to override ShowHelp() and not ShowHelpAtPoint() +// for backwards compatibility as otherwise the existing code deriving from it +// and overriding ShowHelp() but calling the base class version wouldn't work +// any more, which forces us to use a rather ugly hack and pass the extra +// parameters of ShowHelpAtPoint() to ShowHelp() via member variables. class WXDLLEXPORT wxHelpProvider { public: @@ -116,10 +127,23 @@ public: // the window) for this window virtual wxString GetHelp(const wxWindowBase *window) = 0; - // do show help for the given window (uses GetHelp() internally if - // applicable), return true if it was done or false if no help available - // for this window - virtual bool ShowHelp(wxWindowBase *window) = 0; + // do show help for the given window (uses window->GetHelpAtPoint() + // internally if applicable), return true if it was done or false + // if no help available for this window + virtual bool ShowHelpAtPoint(wxWindowBase *window, + const wxPoint& pt, + wxHelpEvent::Origin origin) + { + wxCHECK_MSG( window, false, _T("window must not be NULL") ); + + m_helptextAtPoint = pt; + m_helptextOrigin = origin; + + return ShowHelp(window); + } + + // show help for the given window, see ShowHelpAtPoint() above + virtual bool ShowHelp(wxWindowBase * WXUNUSED(window)) { return false; } // associate the text with the given window or id: although all help // providers have these functions to allow making wxWindow::SetHelpText() @@ -137,12 +161,29 @@ public: // virtual dtor for any base class virtual ~wxHelpProvider(); +protected: + wxHelpProvider() + : m_helptextAtPoint(wxDefaultPosition), + m_helptextOrigin(wxHelpEvent::Origin_Unknown) + { + } + + // helper method used by ShowHelp(): returns the help string to use by + // using m_helptextAtPoint/m_helptextOrigin if they're set or just GetHelp + // otherwise + wxString GetHelpTextMaybeAtPoint(wxWindowBase *window); + + + // parameters of the last ShowHelpAtPoint() call, used by ShowHelp() + wxPoint m_helptextAtPoint; + wxHelpEvent::Origin m_helptextOrigin; + private: static wxHelpProvider *ms_helpProvider; }; -WX_DECLARE_EXPORTED_HASH_MAP( long, wxString, wxIntegerHash, wxIntegerEqual, - wxLongToStringHashMap ); +WX_DECLARE_EXPORTED_HASH_MAP( wxUIntPtr, wxString, wxIntegerHash, + wxIntegerEqual, wxSimpleHelpProviderHashMap ); // wxSimpleHelpProvider is an implementation of wxHelpProvider which supports // only plain text help strings and shows the string associated with the @@ -152,7 +193,10 @@ class WXDLLEXPORT wxSimpleHelpProvider : public wxHelpProvider public: // implement wxHelpProvider methods virtual wxString GetHelp(const wxWindowBase *window); + + // override ShowHelp() and not ShowHelpAtPoint() as explained above virtual bool ShowHelp(wxWindowBase *window); + virtual void AddHelp(wxWindowBase *window, const wxString& text); virtual void AddHelp(wxWindowID id, const wxString& text); virtual void RemoveHelp(wxWindowBase* window); @@ -160,8 +204,8 @@ public: protected: // we use 2 hashes for storing the help strings associated with windows // and the ids - wxLongToStringHashMap m_hashWindows, - m_hashIds; + wxSimpleHelpProviderHashMap m_hashWindows, + m_hashIds; }; // wxHelpControllerHelpProvider is an implementation of wxHelpProvider which supports @@ -176,6 +220,9 @@ public: wxHelpControllerHelpProvider(wxHelpControllerBase* hc = (wxHelpControllerBase*) NULL); // implement wxHelpProvider methods + + // again (see above): this should be ShowHelpAtPoint() but we need to + // override ShowHelp() to avoid breaking existing code virtual bool ShowHelp(wxWindowBase *window); // Other accessors @@ -193,5 +240,5 @@ WXDLLEXPORT wxString wxContextId(int id); #endif // wxUSE_HELP -#endif // _WX_CSHELPH__ +#endif // _WX_CSHELP_H_