interface/tooltip.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        tooltip.h
   3 // Purpose:     documentation for wxToolTip class
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxToolTip
  11     @wxheader{tooltip.h}
  12
  13     This class holds information about a tooltip associated with a window
  14     (see wxWindow::SetToolTip).
  15
  16     The four static methods, wxToolTip::Enable,
  17     wxToolTip::SetDelay
  18     wxToolTip::SetAutoPop and
  19     wxToolTip::SetReshow can be used to globally
  20     alter tooltips behaviour.
  21
  22     @library{wxcore}
  23     @category{help}
  24 */
  25 class wxToolTip : public wxObject
  26 {
  27 public:
  28     /**
  29         Constructor.
  30     */
  31     wxToolTip(const wxString& tip);
  32
  33     /**
  34         Enable or disable tooltips globally.
  35
  36         May not be supported on all platforms (eg. wxCocoa).
  37     */
  38     static void Enable(bool flag);
  39
  40     /**
  41         Get the tooltip text.
  42     */
  43     wxString GetTip();
  44
  45     /**
  46         Get the associated window.
  47     */
  48     wxWindow* GetWindow();
  49
  50     /**
  51         Set the delay after which the tooltip disappears or how long a
  52         tooltip remains visible.
  53         May not be supported on all platforms (eg. wxCocoa, GTK, Palmos).
  54     */
  55     static void SetAutoPop(long msecs);
  56
  57     /**
  58         Set the delay after which the tooltip appears.
  59
  60         May not be supported on all platforms (eg. wxCocoa).
  61     */
  62     static void SetDelay(long msecs);
  63
  64     /**
  65         Set the delay between subsequent tooltips to appear.
  66         May not be supported on all platforms (eg. wxCocoa, GTK, Palmos).
  67     */
  68     static void SetReshow(long msecs);
  69
  70     /**
  71         Set the tooltip text.
  72     */
  73     void SetTip(const wxString& tip);
  74 };