]> git.saurik.com Git - wxWidgets.git/blobdiff - src/msw/menu.cpp
Handle the case of NSNotFound result properly.
[wxWidgets.git] / src / msw / menu.cpp
index 4c929adce5048108012faf09d6199a550420c959..93984343d1f2d3a3c00b0218fee417ebe8d6a32d 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
@@ -103,9 +88,12 @@ static const UINT idMenuTitle = (UINT)-3;
 // 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;
@@ -130,10 +118,23 @@ 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__
+
+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
+    //        need to use here
+    return bmp.GetWidth() < ::GetSystemMetrics(SM_CXMENUCHECK) + 4 &&
+            bmp.GetHeight() < ::GetSystemMetrics(SM_CYMENUCHECK) + 4;
+}
+
+} // anonymous namespace
 
 // ============================================================================
 // implementation
@@ -365,6 +366,49 @@ void wxMenu::UpdateAccel(wxMenuItem *item)
 
 #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));
+        }
+    }
+#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,12 +465,14 @@ 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() )
+    // 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();
@@ -440,97 +486,102 @@ bool wxMenu::DoInsertOrAppend(wxMenuItem *pItem, size_t pos)
             node = node->GetNext();
         }
     }
-#endif
+#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+
+        // 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 )
+        {
             WinStruct<MENUITEMINFO> mii;
-            if ( wxGetWinVersion() >= wxWinVersion_98 )
+            mii.fMask = MIIM_STRING | MIIM_DATA;
+
+            if ( pItem->GetBitmap().IsOk() )
             {
-                mii.fMask = MIIM_STRING | MIIM_DATA | MIIM_BITMAP;
-                if ( pItem->IsCheckable() )
-                {
-                    // need to set checked/unchecked bitmaps as otherwise our
-                    // MSWOnDrawItem() item is not called
-                    mii.fMask |= MIIM_CHECKMARKS;
-                }
+                mii.fMask |= MIIM_BITMAP;
+                mii.hbmpItem = GetHBitmapForMenu(pItem);
+            }
 
-                mii.cch = itemText.length();
-                mii.dwTypeData = wx_const_cast(wxChar *, itemText.wx_str());
+            if ( pItem->IsCheckable() )
+            {
+                mii.fMask |= MIIM_CHECKMARKS;
+                mii.hbmpChecked = GetHBitmapForMenu(pItem, true);
+                mii.hbmpUnchecked = GetHBitmapForMenu(pItem, false);
+            }
 
-                if (flags & MF_POPUP)
-                {
-                    mii.fMask |= MIIM_SUBMENU;
-                    mii.hSubMenu = (HMENU)pItem->GetSubMenu()->GetHMenu();
-                }
-                else
-                {
-                    mii.fMask |= MIIM_ID;
-                    mii.wID = id;
-                }
+            mii.cch = itemText.length();
+            mii.dwTypeData = const_cast<wxChar *>(itemText.wx_str());
 
-                // 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;
+            if ( flags & MF_POPUP )
+            {
+                mii.fMask |= MIIM_SUBMENU;
+                mii.hSubMenu = GetHmenuOf(pItem->GetSubMenu());
+            }
+            else
+            {
+                mii.fMask |= MIIM_ID;
+                mii.wID = id;
+            }
 
-                ok = ::InsertMenuItem(GetHmenu(), pos, TRUE /* by pos */, &mii);
-                if ( !ok )
-                {
-                    wxLogLastError(wxT("InsertMenuItem()"));
-                }
-                else // InsertMenuItem() ok
+            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 )
                 {
-                    // 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(_T("user32"));
-                    wxDYNLIB_FUNCTION(SetMenuInfo_t, SetMenuInfo, dllUser);
-                    if ( pfnSetMenuInfo )
+                    mi.fMask = MIM_STYLE;
+                    mi.dwStyle = MNS_CHECKORBMP;
+                    if ( !(*pfnSetMenuInfo)(GetHmenu(), &mi) )
                     {
-                        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();
                 }
+
+                // 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();
             }
-#endif // __DMC__
         }
+#endif // __DMC__
 
         if ( !ok )
         {
@@ -588,7 +639,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 +671,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?") );
             }
         }
     }
@@ -714,6 +765,15 @@ 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
 
 // ---------------------------------------------------------------------------
@@ -760,7 +820,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"));
@@ -930,7 +990,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 +1140,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 +1450,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;
 }