docs/latex/wx/hprovcnt.tex

   1 \section{\class{wxHelpControllerHelpProvider}}\label{wxhelpcontrollerhelpprovider}
   2
   3 wxHelpControllerHelpProvider is an implementation of wxHelpProvider which supports
   4 both context identifiers and plain text help strings. If the help text is an integer,
   5 it is passed to wxHelpController::DisplayContextPopup. Otherwise, it shows the string
   6 in a tooltip as per wxSimpleHelpProvider. If you use this with a wxCHMHelpController instance
   7 on windows, it will use the native style of tip window instead of \helpref{wxTipWindow}{wxtipwindow}.
   8
   9 You can use the convenience function {\bf wxContextId} to convert an integer context
  10 id to a string for passing to \helpref{wxWindow::SetHelpText}{wxwindowsethelptext}.
  11
  12 \wxheading{Derived from}
  13
  14 \helpref{wxSimpleHelpProvider}{wxsimplehelpprovider}\\
  15 \helpref{wxHelpProvider}{wxhelpprovider}
  16
  17 \wxheading{Include files}
  18
  19 <wx/cshelp.h>
  20
  21 \wxheading{See also}
  22
  23 \helpref{wxHelpProvider}{wxhelpprovider}, \helpref{wxSimpleHelpProvider}{wxsimplehelpprovider},
  24 \helpref{wxContextHelp}{wxcontexthelp}, \helpref{wxWindow::SetHelpText}{wxwindowsethelptext},
  25 \helpref{wxWindow::GetHelpTextAtPoint}{wxwindowgethelptextatpoint}
  26
  27 \latexignore{\rtfignore{\wxheading{Members}}}
  28
  29 \membersection{wxHelpControllerHelpProvider::wxHelpControllerHelpProvider}\label{wxhelpcontrollerhelpproviderwxhelpcontrollerhelpprovider}
  30
  31 \func{}{wxHelpControllerHelpProvider}{\param{wxHelpControllerBase* }{hc = NULL}}
  32
  33 Note that the instance doesn't own the help controller. The help controller
  34 should be deleted separately.
  35
  36 \membersection{wxHelpControllerHelpProvider::SetHelpController}\label{wxhelpcontrollerhelpprovidersethelpcontroller}
  37
  38 \func{void}{SetHelpController}{\param{wxHelpControllerBase* }{hc}}
  39
  40 Sets the help controller associated with this help provider.
  41
  42 \membersection{wxHelpControllerHelpProvider::GetHelpController}\label{wxhelpcontrollerhelpprovidergethelpcontroller}
  43
  44 \constfunc{wxHelpControllerBase*}{GetHelpController}{\void}
  45
  46 Returns the help controller associated with this help provider.
  47