include/wx/os2/tooltip.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/os2/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 #ifndef _WX_OS2_TOOLTIP_H_
  13 #define _WX_OS2_TOOLTIP_H_
  14
  15 class wxToolTip : public wxObject
  16 {
  17 public:
  18     // ctor & dtor
  19     wxToolTip(const wxString &rsTip);
  20     virtual ~wxToolTip();
  21
  22     //
  23     // Accessors
  24     //
  25     inline const wxString& GetTip(void) const { return m_sText; }
  26     inline wxWindow*       GetWindow(void) const { return m_pWindow; }
  27
  28            void            SetTip(const wxString& rsTip);
  29     inline void            SetWindow(wxWindow* pWin) { m_pWindow = pWin; }
  30
  31     // controlling tooltip behaviour: globally change tooltip parameters
  32         // enable or disable the tooltips globally
  33     static void Enable(bool WXUNUSED(flag)) {}
  34         // set the delay after which the tooltip appears
  35     static void SetDelay(long WXUNUSED(milliseconds)) {}
  36         // set the delay after which the tooltip disappears or how long the tooltip remains visible
  37     static void SetAutoPop(long WXUNUSED(milliseconds)) {}
  38         // set the delay between subsequent tooltips to appear
  39     static void SetReshow(long WXUNUSED(milliseconds)) {}
  40
  41     //
  42     // Implementation
  43     //
  44     void DisplayToolTipWindow(const wxPoint& rPos);
  45     void HideToolTipWindow(void);
  46
  47 private:
  48     void Create(const wxString &rsTip);
  49
  50     HWND                            m_hWnd;
  51     wxString                        m_sText;           // tooltip text
  52     wxWindow*                       m_pWindow;         // window we're associated with
  53 }; // end of CLASS wxToolTip
  54
  55 #endif // _WX_OS2_TOOLTIP_H_