include/wx/gtk/tooltip.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        tooltip.h
   3 // Purpose:     wxToolTip class
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef __GTKTOOLTIPH__
  11 #define __GTKTOOLTIPH__
  12
  13 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  14     #pragma interface
  15 #endif
  16
  17 #include "wx/defs.h"
  18 #include "wx/string.h"
  19 #include "wx/object.h"
  20
  21 //-----------------------------------------------------------------------------
  22 // forward declarations
  23 //-----------------------------------------------------------------------------
  24
  25 class WXDLLIMPEXP_CORE wxToolTip;
  26 class WXDLLIMPEXP_CORE wxWindow;
  27
  28 //-----------------------------------------------------------------------------
  29 // wxToolTip
  30 //-----------------------------------------------------------------------------
  31
  32 class WXDLLIMPEXP_CORE wxToolTip : public wxObject
  33 {
  34 public:
  35     // globally change the tooltip parameters
  36     static void Enable( bool flag );
  37     static void SetDelay( long msecs );
  38
  39     wxToolTip( const wxString &tip );
  40
  41     // get/set the tooltip text
  42     void SetTip( const wxString &tip );
  43     wxString GetTip() const { return m_text; }
  44
  45     wxWindow *GetWindow() const { return m_window; }
  46     bool IsOk() const { return m_window != NULL; }
  47
  48     // implementation
  49     void Apply( wxWindow *win );
  50
  51 private:
  52     wxString     m_text;
  53     wxWindow    *m_window;
  54
  55     DECLARE_ABSTRACT_CLASS(wxToolTip)
  56 };
  57
  58 #endif // __GTKTOOLTIPH__