explain why do you need wxUSE_WXDIB

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

diff --git a/include/wx/cshelp.h b/include/wx/cshelp.h
index 836e76e195fcc4153d5137d167cceeabe9113360..7f85910dd7c1f9fcc088c5c3c9786af0b657e6b8 100644 (file)
--- a/include/wx/cshelp.h
+++ b/include/wx/cshelp.h
@@ -6,21 +6,22 @@
 // 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__
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_CSHELPH__
 #define _WX_CSHELPH__
 

-#ifdef __GNUG__
-    #pragma interface "cshelp.h"
-#endif
-

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

+#include "wx/help.h"
+
+#include "wx/hashmap.h"
+#if wxUSE_BMPBUTTON

 #include "wx/bmpbuttn.h"
 #include "wx/bmpbuttn.h"

+#endif

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


@@ -36,7 +37,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);


@@ -49,12 +50,13 @@ 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)
 };
 

+#if wxUSE_BMPBUTTON

 /*
  * wxContextHelpButton
  * You can add this to your dialogs (especially on non-Windows platforms)
 /*
  * wxContextHelpButton
  * You can add this to your dialogs (especially on non-Windows platforms)


@@ -73,17 +75,17 @@ 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()
 };
 

-#endif // wxUSE_HELP
+#endif

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

-// wxHelpProvider is an ABC used by the program implementing context help to
+// wxHelpProvider is an abstract class used by the program implementing context help to

 // show the help text (or whatever: it may be HTML page or anything else) for
 // the given window.
 //
 // show the help text (or whatever: it may be HTML page or anything else) for
 // the given window.
 //


@@ -111,7 +113,7 @@ public:
     virtual wxString GetHelp(const wxWindowBase *window) = 0;
 
     // do show help for the given window (uses GetHelp() internally if
     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;
 
     // for this window
     virtual bool ShowHelp(wxWindowBase *window) = 0;
 


@@ -125,6 +127,9 @@ public:
     // the application, for example)
     virtual void AddHelp(wxWindowID id, const wxString& text);
 
     // 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();
 
     // virtual dtor for any base class
     virtual ~wxHelpProvider();
 


@@ -132,6 +137,9 @@ private:
     static wxHelpProvider *ms_helpProvider;
 };
 
     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


@@ -143,13 +151,43 @@ public:
     virtual bool ShowHelp(wxWindowBase *window);
     virtual void AddHelp(wxWindowBase *window, const wxString& text);
     virtual void AddHelp(wxWindowID id, const wxString& text);
     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
 
 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
+// both context identifiers and plain text help strings. If the help text is an integer,
+// it is passed to wxHelpController::DisplayContextPopup. Otherwise, it shows the string
+// in a tooltip as per wxSimpleHelpProvider.
+class WXDLLEXPORT wxHelpControllerHelpProvider : public wxSimpleHelpProvider
+{
+public:
+    // Note that it doesn't own the help controller. The help controller
+    // should be deleted separately.
+    wxHelpControllerHelpProvider(wxHelpControllerBase* hc = (wxHelpControllerBase*) NULL);
+
+    // implement wxHelpProvider methods
+    virtual bool ShowHelp(wxWindowBase *window);
+
+    // Other accessors
+    void SetHelpController(wxHelpControllerBase* hc) { m_helpController = hc; }
+    wxHelpControllerBase* GetHelpController() const { return m_helpController; }
+
+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__
 
 #endif // _WX_CSHELPH__