]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/menu.cpp
Ensure that validators work even in presence of pushed event handlers.
[wxWidgets.git] / src / msw / menu.cpp
index 4c929adce5048108012faf09d6199a550420c959..648e0a187473392e95a5a0701d3410a2f7642716 100644 (file)
     #include "wx/utils.h"
     #include "wx/intl.h"
     #include "wx/log.h"
+    #include "wx/image.h"
 #endif
 
 #if wxUSE_OWNER_DRAWN
     #include "wx/ownerdrw.h"
 #endif
 
+#include "wx/scopedarray.h"
+
 #include "wx/msw/private.h"
 #include "wx/msw/wrapcctl.h" // include <commctrl.h> "properly"
 
 // other standard headers
 #include <string.h>
 
-//VC6 needs these defining, though they are in winuser.h
-#ifndef MIIM_BITMAP
-#define MIIM_STRING      0x00000040
-#define MIIM_BITMAP      0x00000080
-#define MIIM_FTYPE       0x00000100
-#define HBMMENU_CALLBACK            ((HBITMAP) -1)
-typedef struct tagMENUINFO
-{
-    DWORD   cbSize;
-    DWORD   fMask;
-    DWORD   dwStyle;
-    UINT    cyMax;
-    HBRUSH  hbrBack;
-    DWORD   dwContextHelpID;
-    DWORD   dwMenuData;
-}   MENUINFO, FAR *LPMENUINFO;
-#endif
-
 #if wxUSE_OWNER_DRAWN
     #include "wx/dynlib.h"
 #endif
@@ -97,15 +82,18 @@ typedef struct tagMENUINFO
 // ----------------------------------------------------------------------------
 
 // the (popup) menu title has this special id
-static const UINT idMenuTitle = (UINT)-3;
+static const int idMenuTitle = wxID_NONE;
 
 // ----------------------------------------------------------------------------
 // private functions
 // ----------------------------------------------------------------------------
 
+namespace
+{
+
 // make the given menu item default
-static void SetDefaultMenuItem(HMENU WXUNUSED_IN_WINCE(hmenu),
-                               UINT WXUNUSED_IN_WINCE(id))
+void SetDefaultMenuItem(HMENU WXUNUSED_IN_WINCE(hmenu),
+                        UINT WXUNUSED_IN_WINCE(id))
 {
 #ifndef __WXWINCE__
     MENUITEMINFO mii;
@@ -118,7 +106,31 @@ static void SetDefaultMenuItem(HMENU WXUNUSED_IN_WINCE(hmenu),
     {
         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),
+                           BOOL WXUNUSED_IN_WINCE(byPositon = FALSE))
+{
+#ifndef __WXWINCE__
+    MENUITEMINFO mii;
+    wxZeroMemory(mii);
+    mii.cbSize = sizeof(MENUITEMINFO);
+    mii.fMask = MIIM_FTYPE | MIIM_DATA;
+    mii.fType = MFT_OWNERDRAW;
+    mii.dwItemData = data;
+
+    if ( reinterpret_cast<wxMenuItem*>(data)->IsSeparator() )
+        mii.fType |= MFT_SEPARATOR;
+
+    if ( !::SetMenuItemInfo(hmenu, id, byPositon, &mii) )
+    {
+        wxLogLastError(wxT("SetMenuItemInfo"));
+    }
+#endif // !__WXWINCE__
 }
 
 #ifdef __WXWINCE__
@@ -130,10 +142,20 @@ UINT GetMenuState(HMENU hMenu, UINT id, UINT flags)
     info.fMask = MIIM_STATE;
     // MF_BYCOMMAND is zero so test MF_BYPOSITION
     if ( !::GetMenuItemInfo(hMenu, id, flags & MF_BYPOSITION ? TRUE : FALSE , & info) )
+    {
         wxLogLastError(wxT("GetMenuItemInfo"));
+    }
     return info.fState;
 }
-#endif
+#endif // __WXWINCE__
+
+inline bool IsGreaterThanStdSize(const wxBitmap& bmp)
+{
+    return bmp.GetWidth() > ::GetSystemMetrics(SM_CXMENUCHECK) ||
+            bmp.GetHeight() > ::GetSystemMetrics(SM_CYMENUCHECK);
+}
+
+} // anonymous namespace
 
 // ============================================================================
 // implementation
@@ -243,6 +265,12 @@ void wxMenu::Init()
     m_doBreak = false;
     m_startRadioGroup = -1;
 
+#if wxUSE_OWNER_DRAWN
+    m_ownerDrawn = false;
+    m_maxBitmapWidth = 0;
+    m_maxAccelWidth = -1;
+#endif // wxUSE_OWNER_DRAWN
+
     // create the menu
     m_hMenu = (WXHMENU)CreatePopupMenu();
     if ( !m_hMenu )
@@ -253,8 +281,9 @@ void wxMenu::Init()
     // if we have a title, insert it in the beginning of the menu
     if ( !m_title.empty() )
     {
-        Append(idMenuTitle, m_title);
-        AppendSeparator();
+        const wxString title = m_title;
+        m_title.clear(); // so that SetTitle() knows there was no title before
+        SetTitle(title);
     }
 }
 
@@ -359,12 +388,60 @@ void wxMenu::UpdateAccel(wxMenuItem *item)
         {
             GetMenuBar()->RebuildAccelTable();
         }
+
+        ResetMaxAccelWidth();
     }
     //else: it is a separator, they can't have accels, nothing to do
 }
 
 #endif // wxUSE_ACCEL
 
+namespace
+{
+
+// helper of DoInsertOrAppend(): returns the HBITMAP to use in MENUITEMINFO
+HBITMAP GetHBitmapForMenu(wxMenuItem *pItem, bool checked = true)
+{
+    // Under versions of Windows older than Vista we can't pass HBITMAP
+    // directly as hbmpItem for 2 reasons:
+    //  1. We can't draw it with transparency then (this is not
+    //     very important now but would be with themed menu bg)
+    //  2. Worse, Windows inverts the bitmap for the selected
+    //     item and this looks downright ugly
+    //
+    // So we prefer to instead draw it ourselves in MSWOnDrawItem().by using
+    // HBMMENU_CALLBACK when inserting it
+    //
+    // However under Vista using HBMMENU_CALLBACK causes the entire menu to be
+    // drawn using the classic theme instead of the current one and it does
+    // handle transparency just fine so do use the real bitmap there
+#if wxUSE_IMAGE
+    if ( wxGetWinVersion() >= wxWinVersion_Vista )
+    {
+        wxBitmap bmp = pItem->GetBitmap(checked);
+        if ( bmp.IsOk() )
+        {
+            // we must use PARGB DIB for the menu bitmaps so ensure that we do
+            wxImage img(bmp.ConvertToImage());
+            if ( !img.HasAlpha() )
+            {
+                img.InitAlpha();
+                pItem->SetBitmap(img, checked);
+            }
+
+            return GetHbitmapOf(pItem->GetBitmap(checked));
+        }
+        //else: bitmap is not set
+
+        return NULL;
+    }
+#endif // wxUSE_IMAGE
+
+    return HBMMENU_CALLBACK;
+}
+
+} // anonymous namespace
+
 // append a new item or submenu to the menu
 bool wxMenu::DoInsertOrAppend(wxMenuItem *pItem, size_t pos)
 {
@@ -421,60 +498,70 @@ bool wxMenu::DoInsertOrAppend(wxMenuItem *pItem, size_t pos)
     BOOL ok = false;
 
 #if wxUSE_OWNER_DRAWN
-    // Currently, mixing owner-drawn and non-owner-drawn items results in
-    // inconsistent margins, so we force this 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.
-    if ( !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();
-        }
-    }
-#endif
+    // 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.
+    if ( m_ownerDrawn )
+        pItem->SetOwnerDrawn(true);
+#endif // wxUSE_OWNER_DRAWN
 
     // check if we have something more than a simple text item
 #if wxUSE_OWNER_DRAWN
     if ( pItem->IsOwnerDrawn() )
     {
-        // is the item owner-drawn just because of the [checked] bitmap?
-        if ( (pItem->GetBitmap(false).Ok() || pItem->GetBitmap(true).Ok()) &&
-                !pItem->GetTextColour().Ok() &&
-                    !pItem->GetBackgroundColour().Ok() &&
-                        !pItem->GetFont().Ok() )
-        {
-            // try to use InsertMenuItem() as it's guaranteed to look correct
-            // while our owner-drawn code is not
 #ifndef __DMC__
-            // DMC at march 2007 doesn't have HBITMAP hbmpItem tagMENUITEMINFOA /W
-            // MIIM_BITMAP only works under WinME/2000+
-            WinStruct<MENUITEMINFO> mii;
-            if ( wxGetWinVersion() >= wxWinVersion_98 )
+
+        if ( !m_ownerDrawn && !pItem->IsSeparator() )
+        {
+            // 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 )
+            {
+                const wxBitmap& bmpUnchecked = pItem->GetBitmap(false),
+                                bmpChecked   = pItem->GetBitmap(true);
+
+                if ( (bmpUnchecked.Ok() && IsGreaterThanStdSize(bmpUnchecked)) ||
+                     (bmpChecked.Ok()   && IsGreaterThanStdSize(bmpChecked)) )
+                {
+                    mustUseOwnerDrawn = true;
+                }
+            }
+
+            // use InsertMenuItem() if possible as it's guaranteed to look
+            // correct while our owner-drawn code is not
+            if ( !mustUseOwnerDrawn )
             {
-                mii.fMask = MIIM_STRING | MIIM_DATA | MIIM_BITMAP;
+                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() )
                 {
-                    // need to set checked/unchecked bitmaps as otherwise our
-                    // MSWOnDrawItem() item is not called
                     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 = wx_const_cast(wxChar *, itemText.wx_str());
+                mii.dwTypeData = const_cast<wxChar *>(itemText.wx_str());
 
-                if (flags & MF_POPUP)
+                if ( flags & MF_POPUP )
                 {
                     mii.fMask |= MIIM_SUBMENU;
-                    mii.hSubMenu = (HMENU)pItem->GetSubMenu()->GetHMenu();
+                    mii.hSubMenu = GetHmenuOf(pItem->GetSubMenu());
                 }
                 else
                 {
@@ -482,20 +569,7 @@ bool wxMenu::DoInsertOrAppend(wxMenuItem *pItem, size_t pos)
                     mii.wID = id;
                 }
 
-                // we can't pass HBITMAP directly as hbmpItem for 2 reasons:
-                //  1. we can't draw it with transparency then (this is not
-                //     very important now but would be with themed menu bg)
-                //  2. worse, Windows inverts the bitmap for the selected
-                //     item and this looks downright ugly
-                //
-                // so instead draw it ourselves in MSWOnDrawItem()
-                mii.dwItemData = wx_reinterpret_cast(ULONG_PTR, pItem);
-                if ( pItem->IsCheckable() )
-                {
-                    mii.hbmpChecked =
-                    mii.hbmpUnchecked = HBMMENU_CALLBACK;
-                }
-                mii.hbmpItem = HBMMENU_CALLBACK;
+                mii.dwItemData = reinterpret_cast<ULONG_PTR>(pItem);
 
                 ok = ::InsertMenuItem(GetHmenu(), pos, TRUE /* by pos */, &mii);
                 if ( !ok )
@@ -514,29 +588,85 @@ bool wxMenu::DoInsertOrAppend(wxMenuItem *pItem, size_t pos)
                     // the app from starting up under Windows 95/NT 4
                     typedef BOOL (WINAPI *SetMenuInfo_t)(HMENU, MENUINFO *);
 
-                    wxDynamicLibrary dllUser(_T("user32"));
+                    wxDynamicLibrary dllUser(wxT("user32"));
                     wxDYNLIB_FUNCTION(SetMenuInfo_t, SetMenuInfo, dllUser);
                     if ( pfnSetMenuInfo )
                     {
                         mi.fMask = MIM_STYLE;
                         mi.dwStyle = MNS_CHECKORBMP;
                         if ( !(*pfnSetMenuInfo)(GetHmenu(), &mi) )
-                            wxLogLastError(_T("SetMenuInfo(MNS_NOCHECK)"));
+                        {
+                            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->ResetOwnerDrawn();
+                    pItem->SetOwnerDrawn(false);
                 }
             }
-#endif // __DMC__
         }
+#endif // __DMC__
 
         if ( !ok )
         {
             // 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 )
+            {
+                // we must use position in SetOwnerDrawnMenuItem because
+                // all separators have the same id
+                int pos = 0;
+                wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst();
+                while (node)
+                {
+                    wxMenuItem* item = node->GetData();
+
+                    if ( !item->IsOwnerDrawn())
+                    {
+                        item->SetOwnerDrawn(true);
+                        SetOwnerDrawnMenuItem(GetHmenu(), pos,
+                                              reinterpret_cast<ULONG_PTR>(item), TRUE);
+                    }
+
+                    item->SetMarginWidth(m_maxBitmapWidth);
+
+                    node = node->GetNext();
+                    pos++;
+                }
+
+                // set menu as ownerdrawn
+                m_ownerDrawn = true;
+
+                ResetMaxAccelWidth();
+            }
+            // only update our margin for equals alignment to other item
+            else if ( !updateAllMargins )
+            {
+                pItem->SetMarginWidth(m_maxBitmapWidth);
+            }
         }
     }
     else
@@ -565,7 +695,7 @@ bool wxMenu::DoInsertOrAppend(wxMenuItem *pItem, size_t pos)
 
 
     // if we just appended the title, highlight it
-    if ( id == idMenuTitle )
+    if ( id == (UINT_PTR)idMenuTitle )
     {
         // visually select the menu title
         SetDefaultMenuItem(GetHmenu(), id);
@@ -588,7 +718,7 @@ void wxMenu::EndRadioGroup()
 
 wxMenuItem* wxMenu::DoAppend(wxMenuItem *item)
 {
-    wxCHECK_MSG( item, NULL, _T("NULL item in wxMenu::DoAppend") );
+    wxCHECK_MSG( item, NULL, wxT("NULL item in wxMenu::DoAppend") );
 
     bool check = false;
 
@@ -620,7 +750,7 @@ wxMenuItem* wxMenu::DoAppend(wxMenuItem *item)
             }
             else
             {
-                wxFAIL_MSG( _T("where is the radio group start item?") );
+                wxFAIL_MSG( wxT("where is the radio group start item?") );
             }
         }
     }
@@ -675,6 +805,8 @@ wxMenuItem *wxMenu::DoRemove(wxMenuItem *item)
         delete m_accels[n];
 
         m_accels.RemoveAt(n);
+
+        ResetMaxAccelWidth();
     }
     //else: this item doesn't have an accel, nothing to do
 #endif // wxUSE_ACCEL
@@ -714,8 +846,45 @@ size_t wxMenu::CopyAccels(wxAcceleratorEntry *accels) const
     return count;
 }
 
+wxAcceleratorTable *wxMenu::CreateAccelTable() const
+{
+    const size_t count = m_accels.size();
+    wxScopedArray<wxAcceleratorEntry> accels(new wxAcceleratorEntry[count]);
+    CopyAccels(accels.get());
+
+    return new wxAcceleratorTable(count, accels.get());
+}
+
 #endif // wxUSE_ACCEL
 
+// ---------------------------------------------------------------------------
+// ownerdrawn helpers
+// ---------------------------------------------------------------------------
+
+#if wxUSE_OWNER_DRAWN
+
+void wxMenu::CalculateMaxAccelWidth()
+{
+    wxASSERT_MSG( m_maxAccelWidth == -1, wxT("it's really needed?") );
+
+    wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst();
+    while (node)
+    {
+        wxMenuItem* item = node->GetData();
+
+        if ( item->IsOwnerDrawn() )
+        {
+            int width = item->MeasureAccelWidth();
+            if (width > m_maxAccelWidth )
+                m_maxAccelWidth = width;
+        }
+
+        node = node->GetNext();
+    }
+}
+
+#endif // wxUSE_OWNER_DRAWN
+
 // ---------------------------------------------------------------------------
 // set wxMenu title
 // ---------------------------------------------------------------------------
@@ -732,7 +901,7 @@ void wxMenu::SetTitle(const wxString& label)
         if ( !label.empty() )
         {
             if ( !::InsertMenu(hMenu, 0u, MF_BYPOSITION | MF_STRING,
-                               idMenuTitle, m_title.wx_str()) ||
+                               (UINT_PTR)idMenuTitle, m_title.wx_str()) ||
                  !::InsertMenu(hMenu, 1u, MF_BYPOSITION, (unsigned)-1, NULL) )
             {
                 wxLogLastError(wxT("InsertMenu"));
@@ -760,7 +929,7 @@ void wxMenu::SetTitle(const wxString& label)
             info.fMask = MIIM_TYPE;
             info.fType = MFT_STRING;
             info.cch = m_title.length();
-            info.dwTypeData = wx_const_cast(wxChar *, m_title.wx_str());
+            info.dwTypeData = const_cast<wxChar *>(m_title.wx_str());
             if ( !SetMenuItemInfo(hMenu, 0, TRUE, & info) )
             {
                 wxLogLastError(wxT("SetMenuItemInfo"));
@@ -768,7 +937,7 @@ void wxMenu::SetTitle(const wxString& label)
 #else
             if ( !ModifyMenu(hMenu, 0u,
                              MF_BYPOSITION | MF_STRING,
-                             idMenuTitle, m_title.wx_str()) )
+                             (UINT_PTR)idMenuTitle, m_title.wx_str()) )
             {
                 wxLogLastError(wxT("ModifyMenu"));
             }
@@ -780,7 +949,7 @@ void wxMenu::SetTitle(const wxString& label)
     // put the title string in bold face
     if ( !m_title.empty() )
     {
-        SetDefaultMenuItem(GetHmenu(), idMenuTitle);
+        SetDefaultMenuItem(GetHmenu(), (UINT_PTR)idMenuTitle);
     }
 #endif // Win32
 }
@@ -794,7 +963,7 @@ bool wxMenu::MSWCommand(WXUINT WXUNUSED(param), WXWORD id_)
     const int id = (signed short)id_;
 
     // ignore commands from the menu title
-    if ( id != (int)idMenuTitle )
+    if ( id != idMenuTitle )
     {
         // update the check item when it's clicked
         wxMenuItem * const item = FindItem(id);
@@ -810,20 +979,6 @@ bool wxMenu::MSWCommand(WXUINT WXUNUSED(param), WXWORD id_)
     return true;
 }
 
-// ---------------------------------------------------------------------------
-// other
-// ---------------------------------------------------------------------------
-
-wxWindow *wxMenu::GetWindow() const
-{
-    if ( m_invokingWindow != NULL )
-        return m_invokingWindow;
-    else if ( GetMenuBar() != NULL)
-        return GetMenuBar()->GetFrame();
-
-    return NULL;
-}
-
 // ---------------------------------------------------------------------------
 // Menu Bar
 // ---------------------------------------------------------------------------
@@ -930,7 +1085,7 @@ WXHMENU wxMenuBar::Create()
     if ( m_hMenu != 0 )
         return m_hMenu;
 
-    wxToolMenuBar * const bar = wx_static_cast(wxToolMenuBar *, GetToolBar());
+    wxToolMenuBar * const bar = static_cast<wxToolMenuBar *>(GetToolBar());
     if ( !bar )
         return NULL;
 
@@ -1080,7 +1235,7 @@ void wxMenuBar::SetMenuLabel(size_t pos, const wxString& label)
     info.fMask = MIIM_TYPE;
     info.fType = MFT_STRING;
     info.cch = label.length();
-    info.dwTypeData = wx_const_cast(wxChar *, label.wx_str());
+    info.dwTypeData = const_cast<wxChar *>(label.wx_str());
     if ( !SetMenuItemInfo(GetHmenu(), id, TRUE, &info) )
     {
         wxLogLastError(wxT("SetMenuItemInfo"));
@@ -1390,9 +1545,13 @@ bool wxMenuBar::AddAdornments(long style)
     if (style & wxCLOSE_BOX)
     {
         if (!CommandBar_AddAdornments((HWND) m_commandBar, 0, 0))
+        {
             wxLogLastError(wxT("CommandBar_AddAdornments"));
+        }
         else
+        {
             return true;
+        }
     }
     return false;
 }