Increase version to 2.9.5.

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

diff --git a/include/wx/msw/tooltip.h b/include/wx/msw/tooltip.h
index 8b7f805f1aa277a356605a0bf5ae6153854795c7..ae512d928b092f867b2efaa89e963b959f8034b7 100644 (file)
--- a/include/wx/msw/tooltip.h
+++ b/include/wx/msw/tooltip.h
@@ -1,21 +1,35 @@
 ///////////////////////////////////////////////////////////////////////////////
-// 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:     wxWindows license
+// Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
-class wxToolTip : public wxObject
+#ifndef _WX_MSW_TOOLTIP_H_
+#define _WX_MSW_TOOLTIP_H_
+
+#include "wx/object.h"
+#include "wx/gdicmn.h"
+
+class WXDLLIMPEXP_FWD_CORE wxWindow;
+class wxToolTipOtherWindows;
+
+class WXDLLIMPEXP_CORE wxToolTip : public wxObject
 {
 public:
     // ctor & dtor
     wxToolTip(const wxString &tip);
     virtual ~wxToolTip();
 
+    // ctor used by wxStatusBar to associate a tooltip to a portion of
+    // the status bar window:
+    wxToolTip(wxWindow* win, unsigned int id,
+              const wxString &tip, const wxRect& rc);
+
     // accessors
         // tip text
     void SetTip(const wxString& tip);
@@ -30,19 +44,66 @@ 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);
+        // set maximum width for the new tooltips: -1 disables wrapping
+        // entirely, 0 restores the default behaviour
+    static void SetMaxWidth(int width);
+
+    // implementation only from now on
+    // -------------------------------
+
+    // should be called in response to WM_MOUSEMOVE
+    static void RelayEvent(WXMSG *msg);
+
+    // add a window to the tooltip control
+    void AddOtherWindow(WXHWND hwnd);
+
+    // remove any tooltip from the window
+    static void Remove(WXHWND hwnd, unsigned int id, const wxRect& rc);
 
-    // implementation
-    void RelayEvent(WXMSG *msg);
+    // Set the rectangle we're associated with. This rectangle is only used for
+    // the main window, not any sub-windows added with Add() so in general it
+    // makes sense to use it for tooltips associated with a single window only.
+    void SetRect(const wxRect& rc);
 
 private:
-    // create the tooltip ctrl for our parent frame if it doesn't exist yet
-    // and return its window handle
-    WXHWND GetToolTipCtrl();
+    // Adds a window other than our main m_window to this tooltip.
+    void DoAddHWND(WXHWND hWnd);
+
+    // Perform the specified operation for the given window only.
+    void DoSetTip(WXHWND hWnd);
+    void DoRemove(WXHWND hWnd);
+
+    // Call the given function for all windows we're associated with.
+    void DoForAllWindows(void (wxToolTip::*func)(WXHWND));
+
+
+    // the one and only one tooltip control we use - never access it directly
+    // but use GetToolTipCtrl() which will create it when needed
+    static WXHWND ms_hwndTT;
+
+    // create the tooltip ctrl if it doesn't exist yet and return its HWND
+    static WXHWND GetToolTipCtrl();
+
+    // new tooltip maximum width, defaults to min(display width, 400)
+    static int ms_maxWidth;
 
     // remove this tooltip from the tooltip control
     void Remove();
 
     wxString  m_text;           // tooltip text
-    wxWindow *m_window;         // window we're associated with
+    wxWindow* m_window;         // main window we're associated with
+    wxToolTipOtherWindows *m_others; // other windows associated with it or NULL
+    wxRect    m_rect;           // the rect of the window for which this tooltip is shown
+                                // (or a rect with width/height == 0 to show it for the entire window)
+    unsigned int m_id;          // the id of this tooltip (ignored when m_rect width/height is 0)
+
+    DECLARE_ABSTRACT_CLASS(wxToolTip)
+    wxDECLARE_NO_COPY_CLASS(wxToolTip);
 };
 
+#endif // _WX_MSW_TOOLTIP_H_