docs/latex/wx/tooltip.tex

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