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
  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         May not be supported on all platforms (eg. wxCocoa).
  36     */
  37     static void Enable(bool flag);
  38
  39     /**
  40         Get the tooltip text.
  41     */
  42     wxString GetTip() const;
  43
  44     /**
  45         Get the associated window.
  46     */
  47     wxWindow* GetWindow() const;
  48
  49     /**
  50         Set the delay after which the tooltip disappears or how long a
  51         tooltip remains visible.
  52         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         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         May not be supported on all platforms (eg. wxCocoa, GTK, Palmos).
  65     */
  66     static void SetReshow(long msecs);
  67
  68     /**
  69         Set the tooltip text.
  70     */
  71     void SetTip(const wxString& tip);
  72 };
  73