make sure all wxDefault* and all wxNull* global instances are documented

[wxWidgets.git] / src / msw / tooltip.cpp

diff --git a/src/msw/tooltip.cpp b/src/msw/tooltip.cpp
index 84f9a38084fd887667e2472d759976de7e33edbd..dd3fdd076b086d079ee41fa5d05f4ac46d3484b8 100644 (file)
--- a/src/msw/tooltip.cpp
+++ b/src/msw/tooltip.cpp
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        msw/tooltip.cpp
+// Name:        src/msw/tooltip.cpp

 // Purpose:     wxToolTip class implementation for MSW
 // Author:      Vadim Zeitlin
 // Modified by:
 // Purpose:     wxToolTip class implementation for MSW
 // Author:      Vadim Zeitlin
 // Modified by:


@@ -23,17 +23,26 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

-#ifndef WX_PRECOMP
-    #include "wx/wx.h"
-#endif
-

 #if wxUSE_TOOLTIPS
 
 #include "wx/tooltip.h"
 #if wxUSE_TOOLTIPS
 
 #include "wx/tooltip.h"

+
+#ifndef WX_PRECOMP
+    #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
+    #include "wx/app.h"
+    #include "wx/control.h"
+#endif
+
+#include "wx/tokenzr.h"

 #include "wx/msw/private.h"
 
 #include "wx/msw/private.h"
 

-// include <commctrl.h> "properly"
-#include "wx/msw/wrapcctl.h"
+#ifndef TTTOOLINFO_V1_SIZE
+    #define TTTOOLINFO_V1_SIZE 0x28
+#endif
+
+#ifndef TTF_TRANSPARENT
+    #define TTF_TRANSPARENT 0x0100
+#endif

 
 // VZ: normally, the trick with subclassing the tooltip control and processing
 //     TTM_WINDOWFROMPOINT should work but, somehow, it doesn't. I leave the
 
 // VZ: normally, the trick with subclassing the tooltip control and processing
 //     TTM_WINDOWFROMPOINT should work but, somehow, it doesn't. I leave the


@@ -77,21 +86,26 @@ public:
         ::ZeroMemory(this, sizeof(TOOLINFO));
 
         // the structure TOOLINFO has been extended with a 4 byte field in
         ::ZeroMemory(this, sizeof(TOOLINFO));
 
         // the structure TOOLINFO has been extended with a 4 byte field in

-        // version 4.70 of comctl32.dll and if we compile on a newer machine
-        // but run on one with the old version of comctl32, nothing will work
-        // because the library will detect that we rely on a more recent
-        // version of it. So we always use the old size - if we ever start
-        // using our lParam member, we'd have to check for comctl32 version
-        // during run-time
-#if _WIN32_IE >= 0x0300
-        cbSize = sizeof(TOOLINFO) - sizeof(LPARAM);
-#else // old headers
-        cbSize = sizeof(TOOLINFO);
-#endif // compile-time comctl32.dll version
+        // version 4.70 of comctl32.dll and another one in 5.01 but we don't
+        // use these extended fields so use the old struct size to ensure that
+        // the tooltips work on old (Windows 95) systems too
+        cbSize = TTTOOLINFO_V1_SIZE;

 
         hwnd = hwndOwner;
         uFlags = TTF_IDISHWND;
 
         hwnd = hwndOwner;
         uFlags = TTF_IDISHWND;

-        uId = (UINT)hwndOwner;
+
+        // we use TTF_TRANSPARENT to fix a problem which arises at least with
+        // the text controls but may presumably happen with other controls
+        // which display the tooltip at mouse position: it can start flashing
+        // then as the control gets "focus lost" events and dismisses the
+        // tooltip which then reappears because mouse remains hovering over the
+        // control, see SF patch 1821229
+        if ( wxApp::GetComCtl32Version() >= 470 )
+        {
+            uFlags |= TTF_TRANSPARENT;
+        }
+
+        uId = (UINT_PTR)hwndOwner;

     }
 };
 
     }
 };
 


@@ -189,23 +203,45 @@ void wxToolTip::SetDelay(long milliseconds)
                             TTDT_INITIAL, milliseconds);
 }
 
                             TTDT_INITIAL, milliseconds);
 }
 

+void wxToolTip::SetAutoPop(long milliseconds)
+{
+    SendTooltipMessageToAll(ms_hwndTT, TTM_SETDELAYTIME,
+                            TTDT_AUTOPOP, milliseconds);
+}
+
+void wxToolTip::SetReshow(long milliseconds)
+{
+    SendTooltipMessageToAll(ms_hwndTT, TTM_SETDELAYTIME,
+                            TTDT_RESHOW, milliseconds);
+}
+

 // ---------------------------------------------------------------------------
 // implementation helpers
 // ---------------------------------------------------------------------------
 
 // create the tooltip ctrl for our parent frame if it doesn't exist yet
 // ---------------------------------------------------------------------------
 // implementation helpers
 // ---------------------------------------------------------------------------
 
 // create the tooltip ctrl for our parent frame if it doesn't exist yet

+/* static */

 WXHWND wxToolTip::GetToolTipCtrl()
 {
     if ( !ms_hwndTT )
     {
 WXHWND wxToolTip::GetToolTipCtrl()
 {
     if ( !ms_hwndTT )
     {

-        ms_hwndTT = (WXHWND)::CreateWindow(TOOLTIPS_CLASS,
-                                           (LPCTSTR)NULL,
-                                           TTS_ALWAYSTIP,
-                                           CW_USEDEFAULT, CW_USEDEFAULT,
-                                           CW_USEDEFAULT, CW_USEDEFAULT,
-                                           NULL, (HMENU)NULL,
-                                           wxGetInstance(),
-                                           NULL);
+        WXDWORD exflags = 0;
+        if ( wxTheApp->GetLayoutDirection() == wxLayout_RightToLeft )
+        {
+            exflags |= WS_EX_LAYOUTRTL;
+        }
+
+        // we want to show the tooltips always (even when the window is not
+        // active) and we don't want to strip "&"s from them
+        ms_hwndTT = (WXHWND)::CreateWindowEx(exflags,
+                                             TOOLTIPS_CLASS,
+                                             (LPCTSTR)NULL,
+                                             TTS_ALWAYSTIP | TTS_NOPREFIX,
+                                             CW_USEDEFAULT, CW_USEDEFAULT,
+                                             CW_USEDEFAULT, CW_USEDEFAULT,
+                                             NULL, (HMENU)NULL,
+                                             wxGetInstance(),
+                                             NULL);

        if ( ms_hwndTT )
        {
            HWND hwnd = (HWND)ms_hwndTT;
        if ( ms_hwndTT )
        {
            HWND hwnd = (HWND)ms_hwndTT;


@@ -222,6 +258,7 @@ WXHWND wxToolTip::GetToolTipCtrl()
     return ms_hwndTT;
 }
 
     return ms_hwndTT;
 }
 

+/* static */

 void wxToolTip::RelayEvent(WXMSG *msg)
 {
     (void)SendTooltipMessage(GetToolTipCtrl(), TTM_RELAYEVENT, msg);
 void wxToolTip::RelayEvent(WXMSG *msg)
 {
     (void)SendTooltipMessage(GetToolTipCtrl(), TTM_RELAYEVENT, msg);


@@ -242,8 +279,8 @@ wxToolTip::wxToolTip(const wxString &tip)
 wxToolTip::~wxToolTip()
 {
     // the tooltip has to be removed before deleting. Otherwise, if it is visible
 wxToolTip::~wxToolTip()
 {
     // the tooltip has to be removed before deleting. Otherwise, if it is visible

-       // while being deleted, there will be a delay before it goes away.
-       Remove();
+    // while being deleted, there will be a delay before it goes away.
+    Remove();

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -278,7 +315,7 @@ void wxToolTip::Add(WXHWND hWnd)
     // NMTTDISPINFO struct -- and setting the tooltip here we can have tooltips
     // of any length
     ti.hwnd = hwnd;
     // NMTTDISPINFO struct -- and setting the tooltip here we can have tooltips
     // of any length
     ti.hwnd = hwnd;

-    ti.lpszText = (wxChar *)m_text.c_str(); // const_cast
+    ti.lpszText = (wxChar *)m_text.wx_str(); // const_cast

 
     if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, &ti) )
     {
 
     if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, &ti) )
     {


@@ -319,14 +356,30 @@ void wxToolTip::Add(WXHWND hWnd)
                     wxLogLastError(wxT("SelectObject(hfont)"));
                 }
 
                     wxLogLastError(wxT("SelectObject(hfont)"));
                 }
 

-                SIZE sz;
-                if ( !::GetTextExtentPoint32(hdc, m_text, index, &sz) )
+                // find the width of the widest line
+                int max = 0;
+                wxStringTokenizer tokenizer(m_text, _T("\n"));
+                wxString token = tokenizer.GetNextToken();
+                while (token.length())

                 {
                 {

-                    wxLogLastError(wxT("GetTextExtentPoint32"));
+                    SIZE sz;
+                    if ( !::GetTextExtentPoint32(hdc, token.wx_str(), token.length(), &sz) )
+                    {
+                        wxLogLastError(wxT("GetTextExtentPoint32"));
+                    }
+                    if ( sz.cx > max )
+                        max = sz.cx;
+
+                    token = tokenizer.GetNextToken();

                 }
 
                 }
 

-                SendTooltipMessage(GetToolTipCtrl(), TTM_SETMAXTIPWIDTH,
-                                        (void *)sz.cx);
+                // only set a new width if it is bigger than the current setting
+                if ( max > SendTooltipMessage(GetToolTipCtrl(),
+                                              TTM_GETMAXTIPWIDTH, 0) )
+                {
+                    SendTooltipMessage(GetToolTipCtrl(), TTM_SETMAXTIPWIDTH,
+                                       wxUIntToPtr(max));
+                }

             }
             else
 #endif // comctl32.dll >= 4.70
             }
             else
 #endif // comctl32.dll >= 4.70


@@ -334,7 +387,7 @@ void wxToolTip::Add(WXHWND hWnd)
                 // replace the '\n's with spaces because otherwise they appear as
                 // unprintable characters in the tooltip string
                 m_text.Replace(_T("\n"), _T(" "));
                 // replace the '\n's with spaces because otherwise they appear as
                 // unprintable characters in the tooltip string
                 m_text.Replace(_T("\n"), _T(" "));

-                ti.lpszText = (wxChar *)m_text.c_str(); // const_cast
+                ti.lpszText = (wxChar *)m_text.wx_str(); // const_cast

 
                 if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, &ti) )
                 {
 
                 if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, &ti) )
                 {


@@ -357,7 +410,7 @@ void wxToolTip::SetWindow(wxWindow *win)
         Add(m_window->GetHWND());
     }
 #if !defined(__WXUNIVERSAL__)
         Add(m_window->GetHWND());
     }
 #if !defined(__WXUNIVERSAL__)

-    // and all of its subcontrols (e.g. radiobuttons in a radiobox) as well
+    // and all of its subcontrols (e.g. radio buttons in a radiobox) as well

     wxControl *control = wxDynamicCast(m_window, wxControl);
     if ( control )
     {
     wxControl *control = wxDynamicCast(m_window, wxControl);
     if ( control )
     {


@@ -381,22 +434,6 @@ void wxToolTip::SetWindow(wxWindow *win)
             Add((WXHWND)hwnd);
         }
     }
             Add((WXHWND)hwnd);
         }
     }

-
-    // VZ: it's ugly to do it here, but I don't want any major changes right
-    //     now, later we will probably want to have wxWindow::OnGotToolTip() or
-    //     something like this where the derived class can do such things
-    //     itself instead of wxToolTip "knowing" about them all
-    wxComboBox *combo = wxDynamicCast(control, wxComboBox);
-    if ( combo )
-    {
-        WXHWND hwndComboEdit = combo->GetWindowStyle() & wxCB_READONLY
-                                ? combo->GetHWND()
-                                : combo->GetEditHWND();
-        if ( hwndComboEdit )
-        {
-            Add(hwndComboEdit);
-        }
-    }

 #endif // !defined(__WXUNIVERSAL__)
 }
 
 #endif // !defined(__WXUNIVERSAL__)
 }
 


@@ -408,7 +445,7 @@ void wxToolTip::SetTip(const wxString& tip)
     {
         // update the tip text shown by the control
         wxToolInfo ti(GetHwndOf(m_window));
     {
         // update the tip text shown by the control
         wxToolInfo ti(GetHwndOf(m_window));

-        ti.lpszText = (wxChar *)m_text.c_str();
+        ti.lpszText = (wxChar *)m_text.wx_str();

 
         (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT, &ti);
     }
 
         (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT, &ti);
     }