docs/latex/wx/tooltip.tex

   1 \section{\class{wxToolTip}}\label{wxtooltip}
   2
   3 This class holds information about a tooltip associated with a window
   4 (see \helpref{wxWindow::SetToolTip}{wxwindowsettooltip}).
   5
   6 The two static methods, \helpref{wxToolTip::Enable}{wxtooltipenable} and
   7 \helpref{wxToolTip::SetDelay}{wxtooltipsetdelay} can be used to globally
   8 alter tooltips behaviour.
   9
  10 \wxheading{Derived from}
  11
  12 \helpref{wxObject}{wxobject}
  13
  14 \wxheading{Include files}
  15
  16 <wx/tooltip.h>
  17
  18 \wxheading{Library}
  19
  20 \helpref{wxCore}{librarieslist}
  21
  22 \latexignore{\rtfignore{\wxheading{Members}}}
  23
  24
  25 \membersection{wxToolTip::Enable}\label{wxtooltipenable}
  26
  27 \func{static void}{Enable}{\param{bool }{flag}}
  28
  29 Enable or disable tooltips globally.
  30
  31 May not be supported on all platforms (eg. wxCocoa).
  32
  33
  34 \membersection{wxToolTip::SetDelay}\label{wxtooltipsetdelay}
  35
  36 \func{static void}{SetDelay}{\param{long }{msecs}}
  37
  38 Set the delay after which the tooltip appears.
  39
  40 May not be supported on all platforms (eg. wxCocoa).
  41
  42 \membersection{wxToolTip::wxToolTip}\label{wxtooltipwxtooltip}
  43
  44 \func{}{wxToolTip}{\param{const wxString\& }{tip}}
  45
  46 Constructor.
  47
  48 \membersection{wxToolTip::SetTip}\label{wxtooltipsettip}
  49
  50 \func{void}{SetTip}{\param{const wxString\& }{tip}}
  51
  52 Set the tooltip text.
  53
  54
  55 \membersection{wxToolTip::GetTip}\label{wxtooltipgettip}
  56
  57 \constfunc{wxString}{GetTip}{\void}
  58
  59 Get the tooltip text.
  60
  61 \membersection{wxToolTip::GetWindow}\label{wxtooltipgetwindow}
  62
  63 \constfunc{wxWindow*}{GetWindow}{\void}
  64
  65 Get the associated window.
  66