include/wx/mac/carbon/tooltip.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        mac/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 class wxToolTip : public wxObject
  16 {
  17 public:
  18     // ctor & dtor
  19     wxToolTip(const wxString &tip);
  20     virtual ~wxToolTip();
  21
  22     // accessors
  23         // tip text
  24     void SetTip(const wxString& tip);
  25     const wxString& GetTip() const { return m_text; }
  26
  27         // the window we're associated with
  28     void SetWindow(wxWindow *win);
  29     wxWindow *GetWindow() const { return m_window; }
  30
  31     // controlling tooltip behaviour: globally change tooltip parameters
  32         // enable or disable the tooltips globally
  33     static void Enable(bool flag);
  34         // set the delay after which the tooltip appears
  35     static void SetDelay(long milliseconds);
  36     static void NotifyWindowDelete( WXHWND win ) ;
  37
  38     // implementation only from now on
  39     // -------------------------------
  40
  41     // should be called in response to mouse events
  42     static void RelayEvent(wxWindow *win , wxMouseEvent &event);
  43     static void RemoveToolTips();
  44
  45 private:
  46     wxString  m_text;           // tooltip text
  47     wxWindow *m_window;         // window we're associated with
  48     DECLARE_ABSTRACT_CLASS(wxToolTip)
  49 };
  50
  51 #endif // _WX_MAC_TOOLTIP_H_