changing to wxDC, so that wxGCDC can be used as well

[wxWidgets.git] / include / wx / cshelp.h

diff --git a/include/wx/cshelp.h b/include/wx/cshelp.h
index ecad164325f7dcaf82548f9c7afc8308b8354b31..e80c2d0ab48b1892682ae62883bd4a8d6c97f660 100644 (file)
--- a/include/wx/cshelp.h
+++ b/include/wx/cshelp.h
@@ -6,15 +6,11 @@
 // Created:     08/09/2000
 // RCS-ID:      $Id$
 // Copyright:   (c) 2000 Julian Smart, Vadim Zeitlin
 // 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__
-
-#if defined(__GNUG__) && !defined(__APPLE__)
-    #pragma interface "cshelp.h"
-#endif
+#ifndef _WX_CSHELP_H_
+#define _WX_CSHELP_H_

 
 #include "wx/defs.h"
 
 
 #include "wx/defs.h"
 


@@ -22,10 +18,13 @@
 
 #include "wx/help.h"
 
 
 #include "wx/help.h"
 

+#include "wx/hashmap.h"

 #if wxUSE_BMPBUTTON
 #include "wx/bmpbuttn.h"
 #endif
 
 #if wxUSE_BMPBUTTON
 #include "wx/bmpbuttn.h"
 #endif
 

+#include "wx/event.h"
+

 // ----------------------------------------------------------------------------
 // classes used to implement context help UI
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // classes used to implement context help UI
 // ----------------------------------------------------------------------------


@@ -40,7 +39,7 @@
 class WXDLLEXPORT wxContextHelp : public wxObject
 {
 public:
 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);
     virtual ~wxContextHelp();
 
     bool BeginContextHelp(wxWindow* win);


@@ -53,7 +52,7 @@ public:
 
 protected:
     bool    m_inHelp;
 
 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)
 
 private:
     DECLARE_DYNAMIC_CLASS(wxContextHelp)


@@ -78,7 +77,7 @@ public:
     void OnContextHelp(wxCommandEvent& event);
 
 private:
     void OnContextHelp(wxCommandEvent& event);
 
 private:

-    DECLARE_CLASS(wxContextHelpButton)
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxContextHelpButton)

     DECLARE_EVENT_TABLE()
 };
 
     DECLARE_EVENT_TABLE()
 };
 


@@ -94,6 +93,19 @@ private:
 //
 // The current help provider must be explicitly set by the application using
 // wxHelpProvider::Set().
 //
 // 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:
 class WXDLLEXPORT wxHelpProvider
 {
 public:


@@ -115,10 +127,23 @@ public:
     // the window) for this window
     virtual wxString GetHelp(const wxWindowBase *window) = 0;
 
     // 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()
 
     // associate the text with the given window or id: although all help
     // providers have these functions to allow making wxWindow::SetHelpText()


@@ -136,10 +161,30 @@ public:
     // virtual dtor for any base class
     virtual ~wxHelpProvider();
 
     // 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;
 };
 
 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
 // 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


@@ -148,7 +193,10 @@ class WXDLLEXPORT wxSimpleHelpProvider : public wxHelpProvider
 public:
     // implement wxHelpProvider methods
     virtual wxString GetHelp(const wxWindowBase *window);
 public:
     // implement wxHelpProvider methods
     virtual wxString GetHelp(const wxWindowBase *window);

+
+    // override ShowHelp() and not ShowHelpAtPoint() as explained above

     virtual bool ShowHelp(wxWindowBase *window);
     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);
     virtual void AddHelp(wxWindowBase *window, const wxString& text);
     virtual void AddHelp(wxWindowID id, const wxString& text);
     virtual void RemoveHelp(wxWindowBase* window);


@@ -156,8 +204,8 @@ public:
 protected:
     // we use 2 hashes for storing the help strings associated with windows
     // and the ids
 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
 };
 
 // wxHelpControllerHelpProvider is an implementation of wxHelpProvider which supports


@@ -172,6 +220,9 @@ public:
     wxHelpControllerHelpProvider(wxHelpControllerBase* hc = (wxHelpControllerBase*) NULL);
 
     // implement wxHelpProvider methods
     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
     virtual bool ShowHelp(wxWindowBase *window);
 
     // Other accessors


@@ -189,5 +240,5 @@ WXDLLEXPORT wxString wxContextId(int id);
 
 #endif // wxUSE_HELP
 
 
 #endif // wxUSE_HELP
 

-#endif // _WX_CSHELPH__
+#endif // _WX_CSHELP_H_