fixed corrupted file, checked in as text file now

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

diff --git a/docs/latex/wx/helpprov.tex b/docs/latex/wx/helpprov.tex
index 448c58839f57231c9f00fabf9b938c0cc9fdffe2..d7ccdf33ef11a97d17f2a79a3a62f85f2cedcdcf 100644 (file)
--- a/docs/latex/wx/helpprov.tex
+++ b/docs/latex/wx/helpprov.tex
@@ -10,9 +10,13 @@ wxHelpProvider::Set().
 
 No base class
 
 
 No base class
 

+\wxheading{Include files}
+
+<wx/cshelp.h>
+

 \wxheading{See also}
 
 \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}
 
 \helpref{wxSimpleHelpProvider}{wxsimplehelpprovider}, \helpref{wxHelpControllerHelpProvider}{wxhelpcontrollerhelpprovider}, 
 \helpref{wxWindow::SetHelpText}{wxwindowsethelptext}, \helpref{wxWindow::GetHelpText}{wxwindowgethelptext}
 


@@ -24,12 +28,13 @@ No base class
 
 Virtual destructor for any base class.
 
 
 Virtual destructor for any base class.
 

-\membersection{wxHelpProvider::Set}\label{wxhelpproviderset}
+\membersection{wxHelpProvider::AddHelp}\label{wxhelpprovideraddhelp}

 
 

-\func{wxHelpProvider*}{Set}{\param{wxHelpProvider* }{helpProvider}}
+\func{void}{AddHelp}{\param{wxWindowBase* }{window}, \param{const wxString\& }{text}}

 
 

-Get/set the current, application-wide help provider. Returns
-the previous one.
+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::Get}\label{wxhelpproviderget}
 
 
 \membersection{wxHelpProvider::Get}\label{wxhelpproviderget}
 


@@ -46,29 +51,34 @@ Gets the help string for this window. Its interpretation is dependent on the hel
 except that empty string always means that no help is associated with
 the window.
 
 except that empty string always means that no help is associated with
 the window.
 

-\membersection{wxHelpProvider::ShowHelp}\label{wxhelpprovidershowhelp}
+\func{void}{AddHelp}{\param{wxWindowID }{id}, \param{const wxString\& }{text}}

 
 

-\func{bool}{ShowHelp}{\param{wxWindowBase* }{window}}
+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.

 
 

-Shows help for the given window. Uses \helpref{GetHelp}{wxhelpprovidergethelp} internally if
-applicable.
+\membersection{wxHelpProvider::RemoveHelp}\label{wxhelpproviderremovehelp}

 
 

-Returns TRUE if it was done, or FALSE if no help was available
-for this window.
+\func{void}{RemoveHelp}{\param{wxWindowBase* }{window}}

 
 

-\membersection{wxHelpProvider::AddHelp}\label{wxhelpprovideraddhelp}
+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.

 
 

-\func{void}{AddHelp}{\param{wxWindowBase* }{window}, \param{const wxString\& }{text}}
+\membersection{wxHelpProvider::Set}\label{wxhelpproviderset}

 
 

-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.
+\func{wxHelpProvider*}{Set}{\param{wxHelpProvider* }{helpProvider}}

 
 

-\membersection{wxHelpProvider::AddHelp}\label{wxhelpprovideraddhelp}
+Get/set the current, application-wide help provider. Returns
+the previous one.

 
 

-\func{void}{AddHelp}{\param{wxWindowID }{id}, \param{const wxString\& }{text}}
+\membersection{wxHelpProvider::ShowHelp}\label{wxhelpprovidershowhelp}

 
 

-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.
+\func{bool}{ShowHelp}{\param{wxWindowBase* }{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
+for this window.