added functions to read/write several elements at once (patch 754986)

[wxWidgets.git] / docs / latex / wx / helpprov.tex

diff --git a/docs/latex/wx/helpprov.tex b/docs/latex/wx/helpprov.tex
index 448c58839f57231c9f00fabf9b938c0cc9fdffe2..93f7d9c0e07a5928041c8a01b6334e35e761d9ad 100644 (file)
--- a/docs/latex/wx/helpprov.tex
+++ b/docs/latex/wx/helpprov.tex
@@ -10,9 +10,13 @@ wxHelpProvider::Set().
 
 No base class
 
+\wxheading{Include files}
+
+<wx/cshelp.h>
+
 \wxheading{See also}
 
-\helpref{wxHelpContext}{wxhelpcontext}, \helpref{wxHelpContextButton}{wxhelpcontextbutton}, 
+\helpref{wxContextHelp}{wxcontexthelp}, \helpref{wxContextHelpButton}{wxcontexthelpbutton}, 
 \helpref{wxSimpleHelpProvider}{wxsimplehelpprovider}, \helpref{wxHelpControllerHelpProvider}{wxhelpcontrollerhelpprovider}, 
 \helpref{wxWindow::SetHelpText}{wxwindowsethelptext}, \helpref{wxWindow::GetHelpText}{wxwindowgethelptext}
 
@@ -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}
@@ -64,11 +68,17 @@ Associates the text with the given window or id. Although all help
 providers have these functions to allow making \helpref{wxWindow::SetHelpText}{wxwindowsethelptext} 
 work, not all of them implement the functions.
 
-\membersection{wxHelpProvider::AddHelp}\label{wxhelpprovideraddhelp}
-
 \func{void}{AddHelp}{\param{wxWindowID }{id}, \param{const wxString\& }{text}}
 
 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.
+