include/wx/os2/tooltip.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        msw/tooltip.h
   3 // Purpose:     wxToolTip class - tooltip control
   4 // Author:      David Webster
   5 // Modified by:
   6 // Created:     10/17/99
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) David Webster
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 class wxToolTip : public wxObject
  13 {
  14 public:
  15     // ctor & dtor
  16     wxToolTip(const wxString &rsTip);
  17     virtual ~wxToolTip();
  18
  19     //
  20     // Accessors
  21     //
  22     inline const wxString& GetTip(void) const { return m_sText; }
  23     inline wxWindow*       GetWindow(void) const { return m_pWindow; }
  24
  25            void            SetTip(const wxString& rsTip);
  26     inline void            SetWindow(wxWindow* pWin) { m_pWindow = pWin; }
  27
  28     // controlling tooltip behaviour: globally change tooltip parameters
  29         // enable or disable the tooltips globally
  30     static void Enable(bool WXUNUSED(flag)) {}
  31         // set the delay after which the tooltip appears
  32     static void SetDelay(long WXUNUSED(milliseconds)) {}
  33
  34     //
  35     // Implementation
  36     //
  37     void DisplayToolTipWindow(const wxPoint& rPos);
  38     void HideToolTipWindow(void);
  39
  40 private:
  41     void Create(const wxString &rsTip);
  42
  43     HWND                            m_hWnd;
  44     wxString                        m_sText;           // tooltip text
  45     wxWindow*                       m_pWindow;         // window we're associated with
  46 }; // end of CLASS wxToolTip