include/wx/osx/carbon/tooltip.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/mac/carbon/tooltip.h
   3 // Purpose:     wxToolTip class - tooltip control
   4 // Author:      Stefan Csomor
   5 // Modified by:
   6 // Created:     31.01.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1999 Robert Roebling, Vadim Zeitlin, Stefan Csomor
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_MAC_TOOLTIP_H_
  13 #define _WX_MAC_TOOLTIP_H_
  14
  15 #include "wx/string.h"
  16 #include "wx/event.h"
  17
  18 class WXDLLIMPEXP_CORE wxToolTip : public wxObject
  19 {
  20 public:
  21     // ctor & dtor
  22     wxToolTip(const wxString &tip);
  23     virtual ~wxToolTip();
  24
  25     // accessors
  26         // tip text
  27     void SetTip(const wxString& tip);
  28     const wxString& GetTip() const { return m_text; }
  29
  30         // the window we're associated with
  31     void SetWindow(wxWindow *win);
  32     wxWindow *GetWindow() const { return m_window; }
  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     static void NotifyWindowDelete( WXHWND win ) ;
  44
  45     // implementation only from now on
  46     // -------------------------------
  47
  48     // should be called in response to mouse events
  49     static void RelayEvent(wxWindow *win , wxMouseEvent &event);
  50     static void RemoveToolTips();
  51
  52 private:
  53     wxString  m_text;           // tooltip text
  54     wxWindow *m_window;         // window we're associated with
  55     DECLARE_ABSTRACT_CLASS(wxToolTip)
  56 };
  57
  58 #endif // _WX_MAC_TOOLTIP_H_