]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/gtk/tooltip.h
use memcpy() instead of wxTmemcpy() as the latter is defined in wx/wxcrt.h which...
[wxWidgets.git] / include / wx / gtk / tooltip.h
index 299f0945b22ddc60d2b389292726f769e109a208..de97789e55d6df709f4b790015e7b3a6f5e178c0 100644 (file)
@@ -1,53 +1,66 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        tooltip.h
-// Purpose:
+// Purpose:     wxToolTip class
 // Author:      Robert Roebling
 // Id:          $Id$
-// Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
-// Licence:    wxWindows licence
+// Copyright:   (c) 1998 Robert Roebling
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __GTKTOOLTIPH__
 #define __GTKTOOLTIPH__
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
 #include "wx/defs.h"
+#include "wx/string.h"
 #include "wx/object.h"
-#include "wx/window.h"
 
 //-----------------------------------------------------------------------------
-// classes
+// forward declarations
 //-----------------------------------------------------------------------------
 
-class wxToolTip;
+class WXDLLIMPEXP_FWD_CORE wxToolTip;
+class WXDLLIMPEXP_FWD_CORE wxWindow;
 
 //-----------------------------------------------------------------------------
 // wxToolTip
 //-----------------------------------------------------------------------------
 
-class wxToolTip: public wxObject
+class WXDLLIMPEXP_CORE wxToolTip : public wxObject
 {
 public:
-  
     wxToolTip( const wxString &tip );
-    
-    void SetTip( const wxString &tip );
-    wxString GetTip() const;
-    wxWindow *GetWindow() const;
-    bool Ok() const;
-    
+
+    // globally change the tooltip parameters
     static void Enable( bool flag );
     static void SetDelay( long msecs );
+        // set the delay after which the tooltip disappears or how long the tooltip remains visible
+    static void SetAutoPop(long msecs);
+        // set the delay between subsequent tooltips to appear
+    static void SetReshow(long msecs);
+
+    // get/set the tooltip text
+    void SetTip( const wxString &tip );
+    wxString GetTip() const { return m_text; }
+
+    wxWindow *GetWindow() const { return m_window; }
+    bool IsOk() const { return m_window != NULL; }
+
 
-  // implementation
-    
+    // wxGTK-only from now on
+
+    // this forwards back to wxWindow::ApplyToolTip()
+    void Apply( wxWindow *win );
+
+    // this just sets the given tooltip for the specified widget
+    //
+    // tip must be already UTF-8 encoded
+    static void Apply(GtkWidget *w, const gchar *tip);
+
+private:
     wxString     m_text;
     wxWindow    *m_window;
-    
-    void Apply( wxWindow *win );
+
+    DECLARE_ABSTRACT_CLASS(wxToolTip)
 };
 
 #endif // __GTKTOOLTIPH__