added a few virtual keywords for consistency (no real changes) (patch 543922)

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

diff --git a/include/wx/cshelp.h b/include/wx/cshelp.h
index 836e76e195fcc4153d5137d167cceeabe9113360..e53d48efccbdfc31cd528711db66e193a85fc1f9 100644 (file)
--- a/include/wx/cshelp.h
+++ b/include/wx/cshelp.h
@@ -20,6 +20,7 @@
 
 #if wxUSE_HELP
 
 
 #if wxUSE_HELP
 

+#include "wx/help.h"

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


@@ -77,13 +78,11 @@ private:
     DECLARE_EVENT_TABLE()
 };
 
     DECLARE_EVENT_TABLE()
 };
 

-#endif // wxUSE_HELP
-

 // ----------------------------------------------------------------------------
 // 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.
 //


@@ -151,5 +150,32 @@ protected:
                      m_hashIds;
 };
 
                      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;
+};
+
+// Convenience function for turning context id into wxString
+WXDLLEXPORT wxString wxContextId(int id);
+
+#endif // wxUSE_HELP
+

 #endif // _WX_CSHELPH__
 
 #endif // _WX_CSHELPH__