include/wx/cocoa/tooltip.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        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 #include "wx/object.h"
  13
  14 class wxWindow;
  15
  16 class wxToolTip : public wxObject
  17 {
  18 public:
  19     // ctor & dtor
  20     wxToolTip(const wxString &tip);
  21     virtual ~wxToolTip();
  22
  23     // accessors
  24         // tip text
  25     void SetTip(const wxString& tip);
  26     const wxString& GetTip() const;
  27
  28         // the window we're associated with
  29     wxWindow *GetWindow() const;
  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 private:
  38     void SetWindow(wxWindow* window);
  39
  40     friend class wxWindow;
  41
  42     wxString  m_text;           // tooltip text
  43     wxWindow *m_window;         // window we're associated with
  44
  45     DECLARE_ABSTRACT_CLASS(wxToolTip)
  46 };