docs/latex/wx/cshelp.tex

   1 \section{\class{wxContextHelp}}\label{wxcontexthelp}
   2
   3 This class changes the cursor to a query and puts the application into a 'context-sensitive help mode'.
   4 When the user left-clicks on a window within the specified window, a wxEVT\_HELP event is
   5 sent to that control, and the application may respond to it by popping up some help.
   6
   7 For example:
   8
   9 \begin{verbatim}
  10   wxContextHelp contextHelp(myWindow);
  11 \end{verbatim}
  12
  13 \wxheading{Derived from}
  14
  15 \helpref{wxObject}{wxobject}
  16
  17 \wxheading{Include files}
  18
  19 <wx/cshelp.h>
  20
  21 \wxheading{See also}
  22
  23 \helpref{wxHelpEvent}{wxhelpevent},\rtfsp
  24 \helpref{wxHelpController}{wxhelpcontroller}
  25
  26 \latexignore{\rtfignore{\wxheading{Members}}}
  27
  28 \membersection{wxContextHelp::wxContextHelp}
  29
  30 \func{}{wxContextHelp}{\param{wxWindow*}{ window = NULL}, \param{bool}{ doNow = TRUE}}
  31
  32 Constructs a context help object, calling \helpref{BeginContextHelp}{wxcontexthelpbegincontexthelp} if\rtfsp
  33 {\it doNow} is TRUE (the default).
  34
  35 If {\it window} is NULL, the top window is used.
  36
  37 \membersection{wxContextHelp::\destruct{wxContextHelp}}
  38
  39 \func{}{\destruct{wxContextHelp}}{\void}
  40
  41 Destroys the context help object.
  42
  43 \membersection{wxContextHelp::BeginContextHelp}\label{wxcontexthelpbegincontexthelp}
  44
  45 \func{bool}{BeginContextHelp}{\param{wxWindow*}{ window = NULL}}
  46
  47 Puts the application into context-sensitive help mode. {\it window} is the window
  48 which will be used to catch events; if NULL, the top window will be used.
  49
  50 Returns TRUE if the application was successfully put into context-sensitive help mode.
  51 This function only returns when the event loop has finished.
  52
  53 \membersection{wxContextHelp::EndContextHelp}\label{wxcontexthelpendcontexthelp}
  54
  55 \func{bool}{EndContextHelp}{\void}
  56
  57 Ends context-sensitive help mode. Not normally called by the application.
  58