// 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
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);
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)
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
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;
// 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();
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
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
protected:
wxHelpControllerBase* m_helpController;
+
+ DECLARE_NO_COPY_CLASS(wxHelpControllerHelpProvider)
};
// Convenience function for turning context id into wxString
-wxString wxContextId(int id);
+WXDLLEXPORT wxString wxContextId(int id);
+
+#endif // wxUSE_HELP
#endif // _WX_CSHELPH__