Fix calculation of the margins for owner-drawn menu items.

Take into account the widths of the bitmaps properly.

Closes #11268.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@63222 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/include/wx/msw/menu.h b/include/wx/msw/menu.h
index 60f660ccc77f07c21d0dd65819dbe01ccfb9e360..0ce964a495684ea566b6a1bf2d254aac832c682a 100644 (file)
--- a/include/wx/msw/menu.h
+++ b/include/wx/msw/menu.h
@@ -120,6 +120,14 @@ private:
     wxAcceleratorArray m_accels;
 #endif // wxUSE_ACCEL
 
     wxAcceleratorArray m_accels;
 #endif // wxUSE_ACCEL
 

+#if wxUSE_OWNER_DRAWN
+    // true if the menu has any ownerdrawn items
+    bool m_ownerDrawn;
+
+    // the max width of menu items bitmaps
+    int m_maxBitmapWidth;
+#endif // wxUSE_OWNER_DRAWN
+

     DECLARE_DYNAMIC_CLASS_NO_COPY(wxMenu)
 };
 
     DECLARE_DYNAMIC_CLASS_NO_COPY(wxMenu)
 };
 

diff --git a/src/msw/menu.cpp b/src/msw/menu.cpp
index 07541b85545fcc7ea1249f671b03481f6d18407c..a549d8b8204d0e7bf3bfbdb67afa296e6790a08a 100644 (file)
--- a/src/msw/menu.cpp
+++ b/src/msw/menu.cpp
@@ -106,7 +106,27 @@ void SetDefaultMenuItem(HMENU WXUNUSED_IN_WINCE(hmenu),
     {
         wxLogLastError(wxT("SetMenuItemInfo"));
     }
     {
         wxLogLastError(wxT("SetMenuItemInfo"));
     }

-#endif
+#endif // !__WXWINCE__
+}
+
+// make the given menu item owner-drawn
+void SetOwnerDrawnMenuItem(HMENU WXUNUSED_IN_WINCE(hmenu),
+                           UINT WXUNUSED_IN_WINCE(id),
+                           ULONG_PTR WXUNUSED_IN_WINCE(data))
+{
+#ifndef __WXWINCE__
+    MENUITEMINFO mii;
+    wxZeroMemory(mii);
+    mii.cbSize = sizeof(MENUITEMINFO);
+    mii.fMask = MIIM_FTYPE | MIIM_DATA;
+    mii.fType = MFT_OWNERDRAW;
+    mii.dwItemData = data;
+
+    if ( !::SetMenuItemInfo(hmenu, id, FALSE, &mii) )
+    {
+        wxLogLastError(wxT("SetMenuItemInfo"));
+    }
+#endif // !__WXWINCE__

 }
 
 #ifdef __WXWINCE__
 }
 
 #ifdef __WXWINCE__


@@ -125,7 +145,7 @@ UINT GetMenuState(HMENU hMenu, UINT id, UINT flags)
 }
 #endif // __WXWINCE__
 
 }
 #endif // __WXWINCE__
 

-bool IsLessThanStdSize(const wxBitmap& bmp)
+inline bool IsLessThanStdSize(const wxBitmap& bmp)

 {
     // FIXME: these +4 are chosen so that 16*16 bitmaps pass this test with
     //        default SM_CXMENUCHECK value but I have no idea what do we really
 {
     // FIXME: these +4 are chosen so that 16*16 bitmaps pass this test with
     //        default SM_CXMENUCHECK value but I have no idea what do we really


@@ -244,6 +264,11 @@ void wxMenu::Init()
     m_doBreak = false;
     m_startRadioGroup = -1;
 
     m_doBreak = false;
     m_startRadioGroup = -1;
 

+#if wxUSE_OWNER_DRAWN
+    m_ownerDrawn = false;
+    m_maxBitmapWidth = 0;
+#endif // wxUSE_OWNER_DRAWN
+

     // create the menu
     m_hMenu = (WXHMENU)CreatePopupMenu();
     if ( !m_hMenu )
     // create the menu
     m_hMenu = (WXHMENU)CreatePopupMenu();
     if ( !m_hMenu )


@@ -470,25 +495,9 @@ bool wxMenu::DoInsertOrAppend(wxMenuItem *pItem, size_t pos)
 #if wxUSE_OWNER_DRAWN
     // Under older systems mixing owner-drawn and non-owner-drawn items results
     // in inconsistent margins, so we force this one to be owner-drawn if any
 #if wxUSE_OWNER_DRAWN
     // Under older systems mixing owner-drawn and non-owner-drawn items results
     // in inconsistent margins, so we force this one to be owner-drawn if any

-    // other items already are. Later we might want to use a boolean in the
-    // wxMenu to avoid search. Also we might make this fix unnecessary by
-    // getting the correct margin using NONCLIENTMETRICS.
-    static const wxWinVersion winver = wxGetWinVersion();
-    if ( winver < wxWinVersion_XP &&
-            !pItem->IsOwnerDrawn() && !pItem->IsSeparator() )
-    {
-        // Check if any other items are ownerdrawn, and make ownerdrawn if so
-        wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst();
-        while (node)
-        {
-            if (node->GetData()->IsOwnerDrawn())
-            {
-                pItem->SetOwnerDrawn(true);
-                break;
-            }
-            node = node->GetNext();
-        }
-    }
+    // other items already are.
+    if ( m_ownerDrawn && !pItem->IsSeparator() )
+        pItem->SetOwnerDrawn(true);

 #endif // wxUSE_OWNER_DRAWN
 
     // check if we have something more than a simple text item
 #endif // wxUSE_OWNER_DRAWN
 
     // check if we have something more than a simple text item


@@ -496,93 +505,100 @@ bool wxMenu::DoInsertOrAppend(wxMenuItem *pItem, size_t pos)
     if ( pItem->IsOwnerDrawn() )
     {
 #ifndef __DMC__
     if ( pItem->IsOwnerDrawn() )
     {
 #ifndef __DMC__

-        // MIIM_BITMAP only works under WinME/2000+ so we always use owner
-        // drawn item under the previous versions and we also have to use them
-        // in any case if the item has custom colours or font
-        bool mustUseOwnerDrawn = winver < wxWinVersion_98 ||
-                                 pItem->GetTextColour().Ok() ||
-                                 pItem->GetBackgroundColour().Ok() ||
-                                 pItem->GetFont().Ok();
-        if ( !mustUseOwnerDrawn )
-        {
-            const wxBitmap& bmpUnchecked = pItem->GetBitmap(false),
-                            bmpChecked = pItem->GetBitmap(true);
-            if ( (bmpUnchecked.Ok() && !IsLessThanStdSize(bmpUnchecked)) ||
-                    (bmpChecked.Ok() && !IsLessThanStdSize(bmpChecked)) )
-            {
-                mustUseOwnerDrawn = true;
-            }
-        }

 
 

-        // use InsertMenuItem() if possible as it's guaranteed to look correct
-        // while our owner-drawn code is not
-        if ( !mustUseOwnerDrawn )
+        if ( !m_ownerDrawn )

         {
         {

-            WinStruct<MENUITEMINFO> mii;
-            mii.fMask = MIIM_STRING | MIIM_DATA;
-
-            // don't set hbmpItem for the checkable items as it would
-            // be used for both checked and unchecked state
-            if ( pItem->IsCheckable() )
+            // MIIM_BITMAP only works under WinME/2000+ so we always use owner
+            // drawn item under the previous versions and we also have to use
+            // them in any case if the item has custom colours or font
+            static const wxWinVersion winver = wxGetWinVersion();
+            bool mustUseOwnerDrawn = winver < wxWinVersion_98 ||
+                                     pItem->GetTextColour().Ok() ||
+                                     pItem->GetBackgroundColour().Ok() ||
+                                     pItem->GetFont().Ok();
+
+            if ( !mustUseOwnerDrawn )

             {
             {

-                mii.fMask |= MIIM_CHECKMARKS;
-                mii.hbmpChecked = GetHBitmapForMenu(pItem, true);
-                mii.hbmpUnchecked = GetHBitmapForMenu(pItem, false);
+                const wxBitmap& bmpUnchecked = pItem->GetBitmap(false),
+                                bmpChecked   = pItem->GetBitmap(true);
+
+                if ( (bmpUnchecked.Ok() && !IsLessThanStdSize(bmpUnchecked)) ||
+                     (bmpChecked.Ok()   && !IsLessThanStdSize(bmpChecked)) )
+                {
+                    mustUseOwnerDrawn = true;
+                }

             }
             }

-            else if ( pItem->GetBitmap().IsOk() )
+
+            // use InsertMenuItem() if possible as it's guaranteed to look
+            // correct while our owner-drawn code is not
+            if ( !mustUseOwnerDrawn )

             {
             {

-                mii.fMask |= MIIM_BITMAP;
-                mii.hbmpItem = GetHBitmapForMenu(pItem);
-            }
+                WinStruct<MENUITEMINFO> mii;
+                mii.fMask = MIIM_STRING | MIIM_DATA;
+
+                // don't set hbmpItem for the checkable items as it would
+                // be used for both checked and unchecked state
+                if ( pItem->IsCheckable() )
+                {
+                    mii.fMask |= MIIM_CHECKMARKS;
+                    mii.hbmpChecked = GetHBitmapForMenu(pItem, true);
+                    mii.hbmpUnchecked = GetHBitmapForMenu(pItem, false);
+                }
+                else if ( pItem->GetBitmap().IsOk() )
+                {
+                    mii.fMask |= MIIM_BITMAP;
+                    mii.hbmpItem = GetHBitmapForMenu(pItem);
+                }

 
 

-            mii.cch = itemText.length();
-            mii.dwTypeData = const_cast<wxChar *>(itemText.wx_str());
+                mii.cch = itemText.length();
+                mii.dwTypeData = const_cast<wxChar *>(itemText.wx_str());

 
 

-            if ( flags & MF_POPUP )
-            {
-                mii.fMask |= MIIM_SUBMENU;
-                mii.hSubMenu = GetHmenuOf(pItem->GetSubMenu());
-            }
-            else
-            {
-                mii.fMask |= MIIM_ID;
-                mii.wID = id;
-            }
+                if ( flags & MF_POPUP )
+                {
+                    mii.fMask |= MIIM_SUBMENU;
+                    mii.hSubMenu = GetHmenuOf(pItem->GetSubMenu());
+                }
+                else
+                {
+                    mii.fMask |= MIIM_ID;
+                    mii.wID = id;
+                }

 
 

-            mii.dwItemData = reinterpret_cast<ULONG_PTR>(pItem);
+                mii.dwItemData = reinterpret_cast<ULONG_PTR>(pItem);

 
 

-            ok = ::InsertMenuItem(GetHmenu(), pos, TRUE /* by pos */, &mii);
-            if ( !ok )
-            {
-                wxLogLastError(wxT("InsertMenuItem()"));
-            }
-            else // InsertMenuItem() ok
-            {
-                // we need to remove the extra indent which is reserved for
-                // the checkboxes by default as it looks ugly unless check
-                // boxes are used together with bitmaps and this is not the
-                // case in wx API
-                WinStruct<MENUINFO> mi;
-
-                // don't call SetMenuInfo() directly, this would prevent
-                // the app from starting up under Windows 95/NT 4
-                typedef BOOL (WINAPI *SetMenuInfo_t)(HMENU, MENUINFO *);
-
-                wxDynamicLibrary dllUser(wxT("user32"));
-                wxDYNLIB_FUNCTION(SetMenuInfo_t, SetMenuInfo, dllUser);
-                if ( pfnSetMenuInfo )
+                ok = ::InsertMenuItem(GetHmenu(), pos, TRUE /* by pos */, &mii);
+                if ( !ok )
+                {
+                    wxLogLastError(wxT("InsertMenuItem()"));
+                }
+                else // InsertMenuItem() ok

                 {
                 {

-                    mi.fMask = MIM_STYLE;
-                    mi.dwStyle = MNS_CHECKORBMP;
-                    if ( !(*pfnSetMenuInfo)(GetHmenu(), &mi) )
+                    // we need to remove the extra indent which is reserved for
+                    // the checkboxes by default as it looks ugly unless check
+                    // boxes are used together with bitmaps and this is not the
+                    // case in wx API
+                    WinStruct<MENUINFO> mi;
+
+                    // don't call SetMenuInfo() directly, this would prevent
+                    // the app from starting up under Windows 95/NT 4
+                    typedef BOOL (WINAPI *SetMenuInfo_t)(HMENU, MENUINFO *);
+
+                    wxDynamicLibrary dllUser(wxT("user32"));
+                    wxDYNLIB_FUNCTION(SetMenuInfo_t, SetMenuInfo, dllUser);
+                    if ( pfnSetMenuInfo )

                     {
                     {

-                        wxLogLastError(wxT("SetMenuInfo(MNS_NOCHECK)"));
+                        mi.fMask = MIM_STYLE;
+                        mi.dwStyle = MNS_CHECKORBMP;
+                        if ( !(*pfnSetMenuInfo)(GetHmenu(), &mi) )
+                        {
+                            wxLogLastError(wxT("SetMenuInfo(MNS_NOCHECK)"));
+                        }

                     }
                     }

-                }

 
 

-                // tell the item that it's not really owner-drawn but only
-                // needs to draw its bitmap, the rest is done by Windows
-                pItem->SetOwnerDrawn(false);
+                    // tell the item that it's not really owner-drawn but only
+                    // needs to draw its bitmap, the rest is done by Windows
+                    pItem->SetOwnerDrawn(false);
+                }

             }
         }
 #endif // __DMC__
             }
         }
 #endif // __DMC__


@@ -592,6 +608,56 @@ bool wxMenu::DoInsertOrAppend(wxMenuItem *pItem, size_t pos)
             // item draws itself, pass pointer to it in data parameter
             flags |= MF_OWNERDRAW;
             pData = (LPCTSTR)pItem;
             // item draws itself, pass pointer to it in data parameter
             flags |= MF_OWNERDRAW;
             pData = (LPCTSTR)pItem;

+
+            bool updateAllMargins = false;
+
+            // get size of bitmap always return valid value (0 for invalid bitmap),
+            // so we don't needed check if bitmap is valid ;)
+            int uncheckedW = pItem->GetBitmap(false).GetWidth();
+            int checkedW   = pItem->GetBitmap(true).GetWidth();
+
+            if ( m_maxBitmapWidth < uncheckedW )
+            {
+                m_maxBitmapWidth = uncheckedW;
+                updateAllMargins = true;
+            }
+
+            if ( m_maxBitmapWidth < checkedW )
+            {
+                m_maxBitmapWidth = checkedW;
+                updateAllMargins = true;
+            }
+
+            // make other item ownerdrawn and update margin width for equals alignment
+            if ( !m_ownerDrawn || updateAllMargins )
+            {
+                wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst();
+                while (node)
+                {
+                    wxMenuItem* item = node->GetData();
+
+                    if ( !item->IsSeparator() )
+                    {
+                        if ( !item->IsOwnerDrawn() )
+                        {
+                            item->SetOwnerDrawn(true);
+                            SetOwnerDrawnMenuItem(GetHmenu(), item->GetMSWId(),
+                                                  reinterpret_cast<ULONG_PTR>(item));
+                        }
+                        item->SetMarginWidth(m_maxBitmapWidth);
+                    }
+
+                    node = node->GetNext();
+                }
+
+                // set menu as ownerdrawn
+                m_ownerDrawn = true;
+            }
+            // only update our margin for equals alignment to other item
+            else if ( !updateAllMargins )
+            {
+                pItem->SetMarginWidth(m_maxBitmapWidth);
+            }

         }
     }
     else
         }
     }
     else