interface/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     @wxheader{tooltip.h}
  12
  13     This class holds information about a tooltip associated with a window (see
  14     wxWindow::SetToolTip()).
  15
  16     The four static methods, wxToolTip::Enable(), wxToolTip::SetDelay()
  17     wxToolTip::SetAutoPop() and wxToolTip::SetReshow() can be used to globally
  18     alter tooltips behaviour.
  19
  20     @library{wxcore}
  21     @category{help}
  22 */
  23 class wxToolTip : public wxObject
  24 {
  25 public:
  26     /**
  27         Constructor.
  28     */
  29     wxToolTip(const wxString& tip);
  30
  31     /**
  32         Enable or disable tooltips globally.
  33
  34         @note May not be supported on all platforms (eg. wxCocoa).
  35     */
  36     static void Enable(bool flag);
  37
  38     /**
  39         Get the tooltip text.
  40     */
  41     wxString GetTip() const;
  42
  43     /**
  44         Get the associated window.
  45     */
  46     wxWindow* GetWindow() const;
  47
  48     /**
  49         Set the delay after which the tooltip disappears or how long a tooltip
  50         remains visible.
  51
  52         @note May not be supported on all platforms (eg. wxCocoa, GTK, Palmos).
  53     */
  54     static void SetAutoPop(long msecs);
  55
  56     /**
  57         Set the delay after which the tooltip appears.
  58
  59         @note May not be supported on all platforms (eg. wxCocoa).
  60     */
  61     static void SetDelay(long msecs);
  62
  63     /**
  64         Set the delay between subsequent tooltips to appear.
  65
  66         @note 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 };
  75