include/wx/mac/tooltip.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        mac/tooltip.h
   3 // Purpose:     wxToolTip class - tooltip control
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     31.01.99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) 1999 Robert Roebling, Vadim Zeitlin
   9 // Licence:     wxWindows license
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12
  13 //TO ADAPT...
  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
  37     // implementation
  38     //void RelayEvent(WXMSG *msg);
  39
  40 private:
  41     // create the tooltip ctrl for our parent frame if it doesn't exist yet
  42     // and return its window handle
  43     WXHWND GetToolTipCtrl();
  44
  45     // remove this tooltip from the tooltip control
  46     void Remove();
  47
  48     wxString  m_text;           // tooltip text
  49     wxWindow *m_window;         // window we're associated with
  50 };
  51