X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4e28924cdb58dfbba0ec6cd5d52ef1346d0cb569..0e05227246cc99b2f8133ae639f38c508351afa0:/include/wx/cshelp.h diff --git a/include/wx/cshelp.h b/include/wx/cshelp.h index 7f2e61b62b..7f85910dd7 100644 --- a/include/wx/cshelp.h +++ b/include/wx/cshelp.h @@ -6,22 +6,22 @@ // Created: 08/09/2000 // RCS-ID: $Id$ // Copyright: (c) 2000 Julian Smart, Vadim Zeitlin -// Licence: wxWindows licence +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_CSHELPH__ #define _WX_CSHELPH__ -#ifdef __GNUG__ - #pragma interface "cshelp.h" -#endif - #include "wx/defs.h" -#include "wx/help.h" #if wxUSE_HELP +#include "wx/help.h" + +#include "wx/hashmap.h" +#if wxUSE_BMPBUTTON #include "wx/bmpbuttn.h" +#endif // ---------------------------------------------------------------------------- // classes used to implement context help UI @@ -37,7 +37,7 @@ class WXDLLEXPORT wxContextHelp : public wxObject { public: - wxContextHelp(wxWindow* win = NULL, bool beginHelp = TRUE); + wxContextHelp(wxWindow* win = NULL, bool beginHelp = true); virtual ~wxContextHelp(); bool BeginContextHelp(wxWindow* win); @@ -50,12 +50,13 @@ public: protected: bool m_inHelp; - bool m_status; // TRUE if the user left-clicked + bool m_status; // true if the user left-clicked private: DECLARE_DYNAMIC_CLASS(wxContextHelp) }; +#if wxUSE_BMPBUTTON /* * wxContextHelpButton * You can add this to your dialogs (especially on non-Windows platforms) @@ -74,11 +75,11 @@ public: void OnContextHelp(wxCommandEvent& event); private: - DECLARE_CLASS(wxContextHelpButton) + DECLARE_DYNAMIC_CLASS_NO_COPY(wxContextHelpButton) DECLARE_EVENT_TABLE() }; -#endif // wxUSE_HELP +#endif // ---------------------------------------------------------------------------- // classes used to implement context help support @@ -112,7 +113,7 @@ public: 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 + // applicable), return true if it was done or false if no help available // for this window virtual bool ShowHelp(wxWindowBase *window) = 0; @@ -126,6 +127,9 @@ public: // the application, for example) virtual void AddHelp(wxWindowID id, const wxString& text); + // removes the association + virtual void RemoveHelp(wxWindowBase* window); + // virtual dtor for any base class virtual ~wxHelpProvider(); @@ -133,6 +137,9 @@ private: static wxHelpProvider *ms_helpProvider; }; +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 // control (if any) in a tooltip @@ -144,12 +151,13 @@ public: 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); protected: // we use 2 hashes for storing the help strings associated with windows // and the ids - wxStringHashTable m_hashWindows, - m_hashIds; + wxSimpleHelpProviderHashMap m_hashWindows, + m_hashIds; }; // wxHelpControllerHelpProvider is an implementation of wxHelpProvider which supports @@ -172,10 +180,14 @@ public: protected: wxHelpControllerBase* m_helpController; + + DECLARE_NO_COPY_CLASS(wxHelpControllerHelpProvider) }; // Convenience function for turning context id into wxString WXDLLEXPORT wxString wxContextId(int id); +#endif // wxUSE_HELP + #endif // _WX_CSHELPH__