fix the incoherence pointed out by ifacecheck between wx docs, that documents usage...

[wxWidgets.git] / include / wx / msw / tooltip.h

diff --git a/include/wx/msw/tooltip.h b/include/wx/msw/tooltip.h
index 6df2c919831b8c0f02f6efdfbd45c5c1ce2ad515..0e7bafe04ae7e758381fd08a25cca979f1078e9d 100644 (file)
--- a/include/wx/msw/tooltip.h
+++ b/include/wx/msw/tooltip.h
@@ -1,15 +1,22 @@
 ///////////////////////////////////////////////////////////////////////////////
-// Name:        msw/tooltip.h
+// Name:        wx/msw/tooltip.h
 // Purpose:     wxToolTip class - tooltip control
 // Author:      Vadim Zeitlin
 // Modified by:
 // Created:     31.01.99
 // RCS-ID:      $Id$
 // Copyright:   (c) 1999 Robert Roebling, Vadim Zeitlin
-// Licence:     wxWidgets licence
+// Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
-class WXDLLEXPORT wxToolTip : public wxObject
+#ifndef _WX_MSW_TOOLTIP_H_
+#define _WX_MSW_TOOLTIP_H_
+
+#include "wx/object.h"
+
+class WXDLLIMPEXP_FWD_CORE wxWindow;
+
+class WXDLLIMPEXP_CORE wxToolTip : public wxObject
 {
 public:
     // ctor & dtor
@@ -30,12 +37,22 @@ public:
     static void Enable(bool flag);
         // set the delay after which the tooltip appears
     static void SetDelay(long milliseconds);
+        // set the delay after which the tooltip disappears or how long the tooltip remains visible
+    static void SetAutoPop(long milliseconds);
+        // set the delay between subsequent tooltips to appear
+    static void SetReshow(long milliseconds);
 
     // implementation only from now on
     // -------------------------------
 
     // should be called in responde to WM_MOUSEMOVE
-    void RelayEvent(WXMSG *msg);
+    static void RelayEvent(WXMSG *msg);
+
+    // add a window to the tooltip control
+    void Add(WXHWND hwnd);
+
+    // remove any tooltip from the window
+    static void Remove(WXHWND hwnd);
 
 private:
     // the one and only one tooltip control we use - never access it directly
@@ -48,9 +65,6 @@ private:
     // remove this tooltip from the tooltip control
     void Remove();
 
-    // add a window to the tooltip control
-    void Add(WXHWND hwnd);
-
     wxString  m_text;           // tooltip text
     wxWindow *m_window;         // window we're associated with
 
@@ -58,3 +72,4 @@ private:
     DECLARE_NO_COPY_CLASS(wxToolTip)
 };
 
+#endif // _WX_MSW_TOOLTIP_H_