docs/latex/wx/helpprov.tex

   1 \section{\class{wxHelpProvider}}\label{wxhelpprovider}
   2
   3 wxHelpProvider is an abstract class used by a program implementing context-sensitive help to
   4 show the help text for the given window.
   5
   6 The current help provider must be explicitly set by the application using
   7 wxHelpProvider::Set().
   8
   9 \wxheading{Derived from}
  10
  11 No base class
  12
  13 \wxheading{Include files}
  14
  15 <wx/cshelp.h>
  16
  17 \wxheading{See also}
  18
  19 \helpref{wxContextHelp}{wxcontexthelp}, \helpref{wxContextHelpButton}{wxcontexthelpbutton},
  20 \helpref{wxSimpleHelpProvider}{wxsimplehelpprovider}, \helpref{wxHelpControllerHelpProvider}{wxhelpcontrollerhelpprovider},
  21 \helpref{wxWindow::SetHelpText}{wxwindowsethelptext}, \helpref{wxWindow::GetHelpText}{wxwindowgethelptext}
  22
  23 \latexignore{\rtfignore{\wxheading{Members}}}
  24
  25 \membersection{wxHelpProvider::\destruct{wxHelpProvider}}\label{wxhelpproviderdtor}
  26
  27 \func{}{\destruct{wxHelpProvider}}{\void}
  28
  29 Virtual destructor for any base class.
  30
  31 \membersection{wxHelpProvider::Set}\label{wxhelpproviderset}
  32
  33 \func{wxHelpProvider*}{Set}{\param{wxHelpProvider* }{helpProvider}}
  34
  35 Get/set the current, application-wide help provider. Returns
  36 the previous one.
  37
  38 \membersection{wxHelpProvider::Get}\label{wxhelpproviderget}
  39
  40 \func{wxHelpProvider*}{Get}{\void}
  41
  42 Unlike some other classes, the help provider is not created on demand.
  43 This must be explicitly done by the application.
  44
  45 \membersection{wxHelpProvider::GetHelp}\label{wxhelpprovidergethelp}
  46
  47 \func{wxString}{GetHelp}{\param{const wxWindowBase* }{window}}
  48
  49 Gets the help string for this window. Its interpretation is dependent on the help provider
  50 except that empty string always means that no help is associated with
  51 the window.
  52
  53 \membersection{wxHelpProvider::ShowHelp}\label{wxhelpprovidershowhelp}
  54
  55 \func{bool}{ShowHelp}{\param{wxWindowBase* }{window}}
  56
  57 Shows help for the given window. Uses \helpref{GetHelp}{wxhelpprovidergethelp} internally if
  58 applicable.
  59
  60 Returns true if it was done, or false if no help was available
  61 for this window.
  62
  63 \membersection{wxHelpProvider::AddHelp}\label{wxhelpprovideraddhelp}
  64
  65 \func{void}{AddHelp}{\param{wxWindowBase* }{window}, \param{const wxString\& }{text}}
  66
  67 Associates the text with the given window or id. Although all help
  68 providers have these functions to allow making \helpref{wxWindow::SetHelpText}{wxwindowsethelptext}
  69 work, not all of them implement the functions.
  70
  71 \func{void}{AddHelp}{\param{wxWindowID }{id}, \param{const wxString\& }{text}}
  72
  73 This version associates the given text with all windows with this id.
  74 May be used to set the same help string for all Cancel buttons in
  75 the application, for example.
  76
  77 \membersection{wxHelpProvider::RemoveHelp}\label{wxhelpproviderremovehelp}
  78
  79 \func{void}{RemoveHelp}{\param{wxWindowBase* }{window}}
  80
  81 Removes the association between the window pointer and the help text. This is
  82 called by the wxWindow destructor. Without this, the table of help strings will fill up
  83 and when window pointers are reused, the wrong help string will be found.
  84