include/wx/cocoa/tooltip.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/cocoa/tooltip.h
   3 // Purpose:     wxToolTip class - tooltip control
   4 // Author:      Ryan Norton
   5 // Modified by:
   6 // Created:     31.01.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Ryan Norton
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_COCOA_TOOLTIP_H_
  13 #define _WX_COCOA_TOOLTIP_H_
  14
  15 #include "wx/object.h"
  16
  17 class wxWindow;
  18
  19 class wxToolTip : public wxObject
  20 {
  21 public:
  22     // ctor & dtor
  23     wxToolTip(const wxString &tip);
  24     virtual ~wxToolTip();
  25
  26     // accessors
  27         // tip text
  28     void SetTip(const wxString& tip);
  29     const wxString& GetTip() const;
  30
  31         // the window we're associated with
  32     wxWindow *GetWindow() const;
  33
  34     // controlling tooltip behaviour: globally change tooltip parameters
  35         // enable or disable the tooltips globally
  36     static void Enable(bool flag);
  37         // set the delay after which the tooltip appears
  38     static void SetDelay(long milliseconds);
  39         // set the delay after which the tooltip disappears or how long the tooltip remains visible
  40     static void SetAutoPop(long milliseconds);
  41         // set the delay between subsequent tooltips to appear
  42     static void SetReshow(long milliseconds);
  43
  44 private:
  45     void SetWindow(wxWindow* window);
  46
  47     friend class wxWindow;
  48
  49     wxString  m_text;           // tooltip text
  50     wxWindow *m_window;         // window we're associated with
  51
  52     DECLARE_ABSTRACT_CLASS(wxToolTip)
  53 };
  54
  55 #endif // _WX_COCOA_TOOLTIP_H_