interface/wx/tooltip.h

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