X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4e28924cdb58dfbba0ec6cd5d52ef1346d0cb569..8695c06a6a5a87b80dfe862a7757fc7e06168455:/docs/latex/wx/helpprov.tex diff --git a/docs/latex/wx/helpprov.tex b/docs/latex/wx/helpprov.tex index ba99934fa4..93f7d9c0e0 100644 --- a/docs/latex/wx/helpprov.tex +++ b/docs/latex/wx/helpprov.tex @@ -10,6 +10,10 @@ wxHelpProvider::Set(). No base class +\wxheading{Include files} + + + \wxheading{See also} \helpref{wxContextHelp}{wxcontexthelp}, \helpref{wxContextHelpButton}{wxcontexthelpbutton}, @@ -53,7 +57,7 @@ the window. Shows help for the given window. Uses \helpref{GetHelp}{wxhelpprovidergethelp} internally if applicable. -Returns TRUE if it was done, or FALSE if no help was available +Returns true if it was done, or false if no help was available for this window. \membersection{wxHelpProvider::AddHelp}\label{wxhelpprovideraddhelp} @@ -70,3 +74,11 @@ This version associates the given text with all windows with this id. May be used to set the same help string for all Cancel buttons in the application, for example. +\membersection{wxHelpProvider::RemoveHelp}\label{wxhelpproviderremovehelp} + +\func{void}{RemoveHelp}{\param{wxWindowBase* }{window}} + +Removes the association between the window pointer and the help text. This is +called by the wxWindow destructor. Without this, the table of help strings will fill up +and when window pointers are reused, the wrong help string will be found. +