Removed comment

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

diff --git a/src/msw/tooltip.cpp b/src/msw/tooltip.cpp
index 8277cdfb67137eb63b31c944880edca8f1e4d3dd..f43fed3843e996d8ccc8339aa913b10169feb895 100644 (file)
--- a/src/msw/tooltip.cpp
+++ b/src/msw/tooltip.cpp
@@ -83,7 +83,7 @@ static WNDPROC gs_wndprocToolTip = (WNDPROC)NULL;
 class wxToolInfo : public TOOLINFO
 {
 public:
 class wxToolInfo : public TOOLINFO
 {
 public:

-    wxToolInfo(HWND hwndOwner)
+    wxToolInfo(HWND hwndOwner, unsigned int id, const wxRect& rc)

     {
         // initialize all members
         ::ZeroMemory(this, sizeof(TOOLINFO));
     {
         // initialize all members
         ::ZeroMemory(this, sizeof(TOOLINFO));


@@ -95,7 +95,27 @@ public:
         cbSize = TTTOOLINFO_V1_SIZE;
 
         hwnd = hwndOwner;
         cbSize = TTTOOLINFO_V1_SIZE;
 
         hwnd = hwndOwner;

-        uFlags = TTF_IDISHWND;
+
+        if (rc.IsEmpty())
+        {
+            uFlags = TTF_IDISHWND;
+            uId = (UINT_PTR)hwndOwner;
+        }
+        else
+        {
+            // this tooltip must be shown only if the mouse hovers a specific rect
+            // of the hwnd parameter!
+            rect.left = rc.GetLeft();
+            rect.right = rc.GetRight();
+            rect.top = rc.GetTop();
+            rect.bottom = rc.GetBottom();
+
+            // note that not setting TTF_IDISHWND from the uFlags member means that the
+            // ti.uId field should not contain the HWND but rather as MSDN says an
+            // "Application-defined identifier of the tool"; this is used internally by
+            // Windows to distinguish the different tooltips attached to the same window
+            uId = id;
+        }

 
         // we use TTF_TRANSPARENT to fix a problem which arises at least with
         // the text controls but may presumably happen with other controls
 
         // we use TTF_TRANSPARENT to fix a problem which arises at least with
         // the text controls but may presumably happen with other controls


@@ -107,8 +127,6 @@ public:
         {
             uFlags |= TTF_TRANSPARENT;
         }
         {
             uFlags |= TTF_TRANSPARENT;
         }

-
-        uId = (UINT_PTR)hwndOwner;

     }
 };
 
     }
 };
 


@@ -197,11 +215,17 @@ LRESULT APIENTRY wxToolTipWndProc(HWND hwndTT,
 
 void wxToolTip::Enable(bool flag)
 {
 
 void wxToolTip::Enable(bool flag)
 {

+    // Make sure the tooltip has been created
+    (void) GetToolTipCtrl();
+

     SendTooltipMessageToAll(ms_hwndTT, TTM_ACTIVATE, flag, 0);
 }
 
 void wxToolTip::SetDelay(long milliseconds)
 {
     SendTooltipMessageToAll(ms_hwndTT, TTM_ACTIVATE, flag, 0);
 }
 
 void wxToolTip::SetDelay(long milliseconds)
 {

+    // Make sure the tooltip has been created
+    (void) GetToolTipCtrl();
+

     SendTooltipMessageToAll(ms_hwndTT, TTM_SETDELAYTIME,
                             TTDT_INITIAL, milliseconds);
 }
     SendTooltipMessageToAll(ms_hwndTT, TTM_SETDELAYTIME,
                             TTDT_INITIAL, milliseconds);
 }


@@ -220,7 +244,7 @@ void wxToolTip::SetReshow(long milliseconds)
 
 void wxToolTip::SetMaxWidth(int width)
 {
 
 void wxToolTip::SetMaxWidth(int width)
 {

-    wxASSERT_MSG( width == -1 || width >= 0, _T("invalid width value") );
+    wxASSERT_MSG( width == -1 || width >= 0, wxT("invalid width value") );

 
     ms_maxWidth = width;
 }
 
     ms_maxWidth = width;
 }


@@ -284,6 +308,21 @@ wxToolTip::wxToolTip(const wxString &tip)
          : m_text(tip)
 {
     m_window = NULL;
          : m_text(tip)
 {
     m_window = NULL;

+
+    // make sure m_rect.IsEmpty() == true
+    m_rect.SetWidth(0);
+    m_rect.SetHeight(0);
+
+    // since m_rect is not valid, m_id is ignored by wxToolInfo ctor...
+    m_id = 0;
+}
+
+wxToolTip::wxToolTip(wxWindow* win, unsigned int id, const wxString &tip, const wxRect& rc)
+         : m_text(tip), m_rect(rc), m_id(id)
+{
+    m_window = NULL;
+
+    SetWindow(win);

 }
 
 wxToolTip::~wxToolTip()
 }
 
 wxToolTip::~wxToolTip()


@@ -297,9 +336,11 @@ wxToolTip::~wxToolTip()
 // others
 // ----------------------------------------------------------------------------
 
 // others
 // ----------------------------------------------------------------------------
 

-void wxToolTip::Remove(WXHWND hWnd)
+/* static */
+void wxToolTip::Remove(WXHWND hWnd, unsigned int id, const wxRect& rc)

 {
 {

-    wxToolInfo ti((HWND)hWnd);
+    wxToolInfo ti((HWND)hWnd, id, rc);
+

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


@@ -308,7 +349,7 @@ void wxToolTip::Remove()
     // remove this tool from the tooltip control
     if ( m_window )
     {
     // remove this tool from the tooltip control
     if ( m_window )
     {

-        Remove(m_window->GetHWND());
+        Remove(m_window->GetHWND(), m_id, m_rect);

     }
 }
 
     }
 }
 


@@ -316,7 +357,7 @@ void wxToolTip::Add(WXHWND hWnd)
 {
     HWND hwnd = (HWND)hWnd;
 
 {
     HWND hwnd = (HWND)hWnd;
 

-    wxToolInfo ti(hwnd);
+    wxToolInfo ti(hwnd, m_id, m_rect);

 
     // another possibility would be to specify LPSTR_TEXTCALLBACK here as we
     // store the tooltip text ourselves anyhow, and provide it in response to
 
     // another possibility would be to specify LPSTR_TEXTCALLBACK here as we
     // store the tooltip text ourselves anyhow, and provide it in response to


@@ -325,91 +366,98 @@ 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.wx_str(); // const_cast
+    ti.lpszText = const_cast<wxChar *>(m_text.wx_str());

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

-        wxLogDebug(_T("Failed to create the tooltip '%s'"), m_text.c_str());
+        wxLogDebug(wxT("Failed to create the tooltip '%s'"), m_text.c_str());
+
+        return;

     }
     }

-    else
-    {
+

 #ifdef TTM_SETMAXTIPWIDTH
 #ifdef TTM_SETMAXTIPWIDTH

-        if ( wxApp::GetComCtl32Version() >= 470 )
-        {
-            // use TTM_SETMAXTIPWIDTH to make tooltip multiline using the
-            // extent of its first line as max value
-            HFONT hfont = (HFONT)
-                SendTooltipMessage(GetToolTipCtrl(), WM_GETFONT, 0);
+    if ( wxApp::GetComCtl32Version() >= 470 )
+    {
+        // use TTM_SETMAXTIPWIDTH to make tooltip multiline using the
+        // extent of its first line as max value
+        HFONT hfont = (HFONT)
+            SendTooltipMessage(GetToolTipCtrl(), WM_GETFONT, 0);

 
 

+        if ( !hfont )
+        {
+            hfont = (HFONT)GetStockObject(DEFAULT_GUI_FONT);

             if ( !hfont )
             {
             if ( !hfont )
             {

-                hfont = (HFONT)GetStockObject(DEFAULT_GUI_FONT);
-                if ( !hfont )
-                {
-                    wxLogLastError(wxT("GetStockObject(DEFAULT_GUI_FONT)"));
-                }
-            }
-
-            MemoryHDC hdc;
-            if ( !hdc )
-            {
-                wxLogLastError(wxT("CreateCompatibleDC(NULL)"));
+                wxLogLastError(wxT("GetStockObject(DEFAULT_GUI_FONT)"));

             }
             }

+        }

 
 

-            if ( !SelectObject(hdc, hfont) )
-            {
-                wxLogLastError(wxT("SelectObject(hfont)"));
-            }
+        MemoryHDC hdc;
+        if ( !hdc )
+        {
+            wxLogLastError(wxT("CreateCompatibleDC(NULL)"));
+        }

 
 

-            // find the width of the widest line
-            int maxWidth = 0;
-            wxStringTokenizer tokenizer(m_text, _T("\n"));
-            while ( tokenizer.HasMoreTokens() )
-            {
-                const wxString token = tokenizer.GetNextToken();
+        if ( !SelectObject(hdc, hfont) )
+        {
+            wxLogLastError(wxT("SelectObject(hfont)"));
+        }

 
 

-                SIZE sz;
-                if ( !::GetTextExtentPoint32(hdc, token.wx_str(),
-                                             token.length(), &sz) )
-                {
-                    wxLogLastError(wxT("GetTextExtentPoint32"));
-                }
+        // find the width of the widest line
+        int maxWidth = 0;
+        wxStringTokenizer tokenizer(m_text, wxT("\n"));
+        while ( tokenizer.HasMoreTokens() )
+        {
+            const wxString token = tokenizer.GetNextToken();

 
 

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

             }
 
             }
 

-            // limit size to ms_maxWidth, if set
-            if ( ms_maxWidth == 0 )
-            {
-                // this is more or less arbitrary but seems to work well
-                static const int DEFAULT_MAX_WIDTH = 400;
+            if ( sz.cx > maxWidth )
+                maxWidth = sz.cx;
+        }

 
 

-                ms_maxWidth = wxGetClientDisplayRect().width / 2;
+        // limit size to ms_maxWidth, if set
+        if ( ms_maxWidth == 0 )
+        {
+            // this is more or less arbitrary but seems to work well
+            static const int DEFAULT_MAX_WIDTH = 400;

 
 

-                if ( ms_maxWidth > DEFAULT_MAX_WIDTH )
-                    ms_maxWidth = DEFAULT_MAX_WIDTH;
-            }
+            ms_maxWidth = wxGetClientDisplayRect().width / 2;

 
 

-            if ( ms_maxWidth != -1 && maxWidth > ms_maxWidth )
-                maxWidth = ms_maxWidth;
+            if ( ms_maxWidth > DEFAULT_MAX_WIDTH )
+                ms_maxWidth = DEFAULT_MAX_WIDTH;
+        }
+
+        if ( ms_maxWidth != -1 && maxWidth > ms_maxWidth )
+            maxWidth = ms_maxWidth;

 
 

-            // only set a new width if it is bigger than the current setting
+        // only set a new width if it is bigger than the current setting:
+        // otherwise adding a tooltip with shorter line(s) than a previous
+        // one would result in breaking the longer lines unnecessarily as
+        // all our tooltips share the same maximal width
+        if ( maxWidth > SendTooltipMessage(GetToolTipCtrl(),
+                                           TTM_GETMAXTIPWIDTH, 0) )
+        {

             SendTooltipMessage(GetToolTipCtrl(), TTM_SETMAXTIPWIDTH,
                                wxUIntToPtr(maxWidth));
         }
             SendTooltipMessage(GetToolTipCtrl(), TTM_SETMAXTIPWIDTH,
                                wxUIntToPtr(maxWidth));
         }

-        else
+    }
+    else

 #endif // TTM_SETMAXTIPWIDTH
 #endif // TTM_SETMAXTIPWIDTH

-        {
-            // 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.wx_str(); // const_cast
+    {
+        // replace the '\n's with spaces because otherwise they appear as
+        // unprintable characters in the tooltip string
+        m_text.Replace(wxT("\n"), wxT(" "));
+        ti.lpszText = const_cast<wxChar *>(m_text.wx_str());

 
 

-            if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, &ti) )
-            {
-                wxLogDebug(_T("Failed to create the tooltip '%s'"), m_text.c_str());
-            }
+        if ( !SendTooltipMessage(GetToolTipCtrl(), TTM_ADDTOOL, &ti) )
+        {
+            wxLogDebug(wxT("Failed to create the tooltip '%s'"), m_text.c_str());

         }
     }
 }
         }
     }
 }


@@ -445,7 +493,7 @@ void wxToolTip::SetWindow(wxWindow *win)
             }
 
             // must have it by now!
             }
 
             // must have it by now!

-            wxASSERT_MSG( hwnd, _T("no hwnd for subcontrol?") );
+            wxASSERT_MSG( hwnd, wxT("no hwnd for subcontrol?") );

 
             Add((WXHWND)hwnd);
         }
 
             Add((WXHWND)hwnd);
         }


@@ -453,6 +501,17 @@ void wxToolTip::SetWindow(wxWindow *win)
 #endif // !defined(__WXUNIVERSAL__)
 }
 
 #endif // !defined(__WXUNIVERSAL__)
 }
 

+void wxToolTip::SetRect(const wxRect& rc)
+{
+    m_rect = rc;
+
+    if ( m_window )
+    {
+        wxToolInfo ti(GetHwndOf(m_window), m_id, m_rect);
+        (void)SendTooltipMessage(GetToolTipCtrl(), TTM_NEWTOOLRECT, &ti);
+    }
+}
+

 void wxToolTip::SetTip(const wxString& tip)
 {
     m_text = tip;
 void wxToolTip::SetTip(const wxString& tip)
 {
     m_text = tip;


@@ -460,12 +519,12 @@ void wxToolTip::SetTip(const wxString& tip)
     if ( m_window )
     {
         // update the tip text shown by the control
     if ( m_window )
     {
         // update the tip text shown by the control

-        wxToolInfo ti(GetHwndOf(m_window));
+        wxToolInfo ti(GetHwndOf(m_window), m_id, m_rect);

 
         // for some reason, changing the tooltip text directly results in
         // repaint of the controls under it, see #10520 -- but this doesn't
         // happen if we reset it first
 
         // for some reason, changing the tooltip text directly results in
         // repaint of the controls under it, see #10520 -- but this doesn't
         // happen if we reset it first

-        ti.lpszText = const_cast<wxChar *>(_T(""));
+        ti.lpszText = const_cast<wxChar *>(wxT(""));

         (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT, &ti);
 
         ti.lpszText = const_cast<wxChar *>(m_text.wx_str());
         (void)SendTooltipMessage(GetToolTipCtrl(), TTM_UPDATETIPTEXT, &ti);
 
         ti.lpszText = const_cast<wxChar *>(m_text.wx_str());