Help text for regions

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@39698 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn 2006-06-13 19:08:21 +00:00
parent 9a45f8a323
commit a353270280
3 changed files with 27 additions and 0 deletions

View File

@ -256,6 +256,16 @@ help is associated with the window.", "");
applicable. Returns True if it was done, or False if no help was
available for this window.", "");
DocDeclStr(
virtual bool , ShowHelpAtPoint(wxWindowBase *window,
const wxPoint& pt,
wxHelpEvent::Origin origin),
"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.", "");
DocDeclStr(
void , AddHelp(wxWindow *window, const wxString& text),
"Associates the text with the given window.", "");

View File

@ -86,6 +86,13 @@ public:
// get the individual items tooltip; returns NULL if none
wxToolTip *GetItemToolTip(unsigned int item) const;
// set helptext for a particular item, pass an empty string to erase it
void SetItemHelpText(unsigned int n, const wxString& helpText);
// retrieve helptext for a particular item, empty string means no help text
wxString GetItemHelpText(unsigned int n) const;
virtual int GetItemFromPoint(const wxPoint& pt) const;
// bool IsValid(int n) const; ** not public

View File

@ -1775,6 +1775,16 @@ window. Note that the text is actually stored by the current
one.", "");
DocDeclStr(
virtual wxString , GetHelpTextAtPoint(const wxPoint& pt,
wxHelpEvent::Origin origin) const,
"Get the help string associated with the given position in this window.
Notice that pt may be invalid if event origin is keyboard or unknown
and this method should return the global window help text then
", "");
DocDeclStr(
wxString , GetHelpText() const,
"Gets the help text to be used as context-sensitive help for this