X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/427ff66291af2d8dd34ff5ee68c81436997144a1..0728199b911be9095406cf05059a5a180e707778:/src/mac/carbon/menu.cpp?ds=sidebyside diff --git a/src/mac/carbon/menu.cpp b/src/mac/carbon/menu.cpp index 417240fc09..b790e19ccf 100644 --- a/src/mac/carbon/menu.cpp +++ b/src/mac/carbon/menu.cpp @@ -1,33 +1,32 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: menu.cpp +// Name: src/mac/carbon/menu.cpp // Purpose: wxMenu, wxMenuBar, wxMenuItem // Author: Stefan Csomor // Modified by: // Created: 1998-01-01 // RCS-ID: $Id$ // Copyright: (c) Stefan Csomor -// Licence: wxWindows licence +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -#ifdef __GNUG__ -#pragma implementation "menu.h" -#pragma implementation "menuitem.h" -#endif - // ============================================================================ // headers & declarations // ============================================================================ -// wxWindows headers +// wxWidgets headers // ----------------- -#include "wx/app.h" +#include "wx/wxprec.h" + #include "wx/menu.h" -#include "wx/menuitem.h" -#include "wx/window.h" -#include "wx/log.h" -#include "wx/utils.h" -#include "wx/frame.h" + +#ifndef WX_PRECOMP + #include "wx/log.h" + #include "wx/app.h" + #include "wx/utils.h" + #include "wx/frame.h" + #include "wx/menuitem.h" +#endif #include "wx/mac/uma.h" @@ -35,17 +34,100 @@ // ---------------------- #include -#if !USE_SHARED_LIBRARY IMPLEMENT_DYNAMIC_CLASS(wxMenu, wxEvtHandler) IMPLEMENT_DYNAMIC_CLASS(wxMenuBar, wxEvtHandler) -#endif // the (popup) menu title has this special id -static const int idMenuTitle = -2; -static MenuItemIndex firstUserHelpMenuItem = 0 ; +static const int idMenuTitle = -3; + +static const short kwxMacAppleMenuId = 1 ; + + +// Find an item given the Macintosh Menu Reference + +WX_DECLARE_HASH_MAP(MenuRef, wxMenu*, wxPointerHash, wxPointerEqual, MacMenuMap); + +static MacMenuMap wxWinMacMenuList; + +wxMenu *wxFindMenuFromMacMenu(MenuRef inMenuRef) +{ + MacMenuMap::iterator node = wxWinMacMenuList.find(inMenuRef); + + return (node == wxWinMacMenuList.end()) ? NULL : node->second; +} + +void wxAssociateMenuWithMacMenu(MenuRef inMenuRef, wxMenu *menu) ; +void wxAssociateMenuWithMacMenu(MenuRef inMenuRef, wxMenu *menu) +{ + // adding NULL MenuRef is (first) surely a result of an error and + // (secondly) breaks menu command processing + wxCHECK_RET( inMenuRef != (MenuRef) NULL, wxT("attempt to add a NULL MenuRef to menu list") ); -const short kwxMacMenuBarResource = 1 ; -const short kwxMacAppleMenuId = 1 ; + wxWinMacMenuList[inMenuRef] = menu; +} + +void wxRemoveMacMenuAssociation(wxMenu *menu) ; +void wxRemoveMacMenuAssociation(wxMenu *menu) +{ + // iterate over all the elements in the class + MacMenuMap::iterator it; + for ( it = wxWinMacMenuList.begin(); it != wxWinMacMenuList.end(); ++it ) + { + if ( it->second == menu ) + { + wxWinMacMenuList.erase(it); + break; + } + } +} + +void wxInsertMenuItemsInMenu(wxMenu* menu, MenuRef wm, MenuItemIndex insertAfter) +{ + wxMenuItemList::compatibility_iterator node; + wxMenuItem *item; + wxMenu *subMenu = NULL ; + bool newItems = false; + + for (node = menu->GetMenuItems().GetFirst(); node; node = node->GetNext()) + { + item = (wxMenuItem *)node->GetData(); + subMenu = item->GetSubMenu() ; + if (subMenu) + { + wxInsertMenuItemsInMenu(subMenu, (MenuRef)subMenu->GetHMenu(), 0); + } + if ( item->IsSeparator() ) + { + if ( wm && newItems) + InsertMenuItemTextWithCFString( wm, + CFSTR(""), insertAfter, kMenuItemAttrSeparator, 0); + + newItems = false; + } + else + { + wxAcceleratorEntry* + entry = wxAcceleratorEntry::Create( item->GetText() ) ; + + MenuItemIndex winListPos = (MenuItemIndex)-1; + OSStatus err = GetIndMenuItemWithCommandID(wm, + wxIdToMacCommand ( item->GetId() ), 1, NULL, &winListPos); + + if ( wm && err == menuItemNotFoundErr ) + { + // NB: the only way to determine whether or not we should add + // a separator is to know if we've added menu items to the menu + // before the separator. + newItems = true; + UMAInsertMenuItem(wm, wxStripMenuCodes(item->GetText()) , wxFont::GetDefaultEncoding(), insertAfter, entry); + SetMenuItemCommandID( wm , insertAfter+1 , wxIdToMacCommand ( item->GetId() ) ) ; + SetMenuItemRefCon( wm , insertAfter+1 , (URefCon) item ) ; + } + + delete entry ; + } + } +} // ============================================================================ // implementation @@ -63,22 +145,36 @@ short wxMenu::s_macNextMenuId = 3 ; short wxMenu::s_macNextMenuId = 2 ; #endif +static +wxMenu * +_wxMenuAt(const wxMenuList &menuList, size_t pos) +{ + wxMenuList::compatibility_iterator menuIter = menuList.GetFirst(); + + while (pos-- > 0) + menuIter = menuIter->GetNext(); + + return menuIter->GetData() ; +} + void wxMenu::Init() { - m_doBreak = FALSE; + m_doBreak = false; m_startRadioGroup = -1; // create the menu - m_macMenuId = s_macNextMenuId++; - m_hMenu = UMANewMenu(m_macMenuId, m_title); + m_macMenuId = s_macNextMenuId++; + m_hMenu = UMANewMenu(m_macMenuId, m_title, wxFont::GetDefaultEncoding() ); if ( !m_hMenu ) { - wxLogLastError("UMANewMenu failed"); + wxLogLastError(wxT("UMANewMenu failed")); } + wxAssociateMenuWithMacMenu( (MenuRef)m_hMenu , this ) ; + // if we have a title, insert it in the beginning of the menu - if ( !!m_title ) + if ( !m_title.empty() ) { Append(idMenuTitle, m_title) ; AppendSeparator() ; @@ -87,6 +183,7 @@ void wxMenu::Init() wxMenu::~wxMenu() { + wxRemoveMacMenuAssociation( this ) ; if (MAC_WXHMENU(m_hMenu)) ::DisposeMenu(MAC_WXHMENU(m_hMenu)); } @@ -112,27 +209,28 @@ bool wxMenu::DoInsertOrAppend(wxMenuItem *pItem, size_t pos) if ( pItem->IsSeparator() ) { if ( pos == (size_t)-1 ) - MacAppendMenu(MAC_WXHMENU(m_hMenu), "\p-"); + AppendMenuItemTextWithCFString( MAC_WXHMENU(m_hMenu), + CFSTR(""), kMenuItemAttrSeparator, 0,NULL); else - MacInsertMenuItem(MAC_WXHMENU(m_hMenu), "\p-" , pos); + InsertMenuItemTextWithCFString( MAC_WXHMENU(m_hMenu), + CFSTR(""), pos, kMenuItemAttrSeparator, 0); } - else + else { wxMenu *pSubMenu = pItem->GetSubMenu() ; if ( pSubMenu != NULL ) { - wxASSERT_MSG( pSubMenu->m_hMenu != NULL , wxT("invalid submenu added")); + wxASSERT_MSG( pSubMenu->m_hMenu != NULL , wxT("invalid submenu added")); pSubMenu->m_menuParent = this ; - - if (wxMenuBar::MacGetInstalledMenuBar() == m_menuBar) - { + + if (wxMenuBar::MacGetInstalledMenuBar() == GetMenuBar()) pSubMenu->MacBeforeDisplay( true ) ; - } - + if ( pos == (size_t)-1 ) - UMAAppendSubMenuItem(MAC_WXHMENU(m_hMenu), pItem->GetText(), pSubMenu->m_macMenuId); + UMAAppendSubMenuItem(MAC_WXHMENU(m_hMenu), wxStripMenuCodes(pItem->GetText()), wxFont::GetDefaultEncoding(), pSubMenu->m_macMenuId); else - UMAInsertSubMenuItem(MAC_WXHMENU(m_hMenu), pItem->GetText() , pos, pSubMenu->m_macMenuId); + UMAInsertSubMenuItem(MAC_WXHMENU(m_hMenu), wxStripMenuCodes(pItem->GetText()), wxFont::GetDefaultEncoding(), pos, pSubMenu->m_macMenuId); + pItem->UpdateItemBitmap() ; pItem->UpdateItemStatus() ; } @@ -140,31 +238,34 @@ bool wxMenu::DoInsertOrAppend(wxMenuItem *pItem, size_t pos) { if ( pos == (size_t)-1 ) { - UMAAppendMenuItem(MAC_WXHMENU(m_hMenu), wxT("a") ); + UMAAppendMenuItem(MAC_WXHMENU(m_hMenu), wxT("a") , wxFont::GetDefaultEncoding() ); pos = CountMenuItems(MAC_WXHMENU(m_hMenu)) ; } else { - UMAInsertMenuItem(MAC_WXHMENU(m_hMenu), wxT("a") , pos); + // MacOS counts menu items from 1 and inserts after, therefore having the + // same effect as wx 0 based and inserting before, we must correct pos + // after however for updates to be correct + UMAInsertMenuItem(MAC_WXHMENU(m_hMenu), wxT("a"), wxFont::GetDefaultEncoding(), pos); + pos += 1 ; } - SetMenuItemCommandID( MAC_WXHMENU(m_hMenu) , pos , pItem->GetId() ) ; + SetMenuItemCommandID( MAC_WXHMENU(m_hMenu) , pos , wxIdToMacCommand ( pItem->GetId() ) ) ; + SetMenuItemRefCon( MAC_WXHMENU(m_hMenu) , pos , (URefCon) pItem ) ; pItem->UpdateItemText() ; pItem->UpdateItemBitmap() ; pItem->UpdateItemStatus() ; - if ( pItem->GetId() == idMenuTitle ) - { + if ( pItem->GetId() == idMenuTitle ) UMAEnableMenuItem(MAC_WXHMENU(m_hMenu) , pos , false ) ; - } } } + // if we're already attached to the menubar, we must update it - if ( IsAttached() ) - { - m_menuBar->Refresh(); - } - return TRUE ; + if ( IsAttached() && GetMenuBar()->IsAttached() ) + GetMenuBar()->Refresh(); + + return true ; } void wxMenu::EndRadioGroup() @@ -173,11 +274,11 @@ void wxMenu::EndRadioGroup() m_startRadioGroup = -1; } -bool wxMenu::DoAppend(wxMenuItem *item) +wxMenuItem* wxMenu::DoAppend(wxMenuItem *item) { - wxCHECK_MSG( item, FALSE, _T("NULL item in wxMenu::DoAppend") ); + wxCHECK_MSG( item, NULL, _T("NULL item in wxMenu::DoAppend") ); - bool check = FALSE; + bool check = false; if ( item->GetKind() == wxITEM_RADIO ) { @@ -193,13 +294,13 @@ bool wxMenu::DoAppend(wxMenuItem *item) item->SetRadioGroupEnd(m_startRadioGroup); // ensure that we have a checked item in the radio group - check = TRUE; + check = true; } else // extend the current radio group { // we need to update its end item item->SetRadioGroupStart(m_startRadioGroup); - wxMenuItemList::Node *node = GetMenuItems().Item(m_startRadioGroup); + wxMenuItemList::compatibility_iterator node = GetMenuItems().Item(m_startRadioGroup); if ( node ) { @@ -217,29 +318,29 @@ bool wxMenu::DoAppend(wxMenuItem *item) } if ( !wxMenuBase::DoAppend(item) || !DoInsertOrAppend(item) ) - { - return FALSE; - } + return NULL; if ( check ) - { // check the item initially - item->Check(TRUE); - } + item->Check(true); - return TRUE; + return item; } -bool wxMenu::DoInsert(size_t pos, wxMenuItem *item) +wxMenuItem* wxMenu::DoInsert(size_t pos, wxMenuItem *item) { - return wxMenuBase::DoInsert(pos, item) && DoInsertOrAppend(item, pos); + if (wxMenuBase::DoInsert(pos, item) && DoInsertOrAppend(item, pos)) + return item; + + return NULL; } wxMenuItem *wxMenu::DoRemove(wxMenuItem *item) { // we need to find the items position in the child list size_t pos; - wxMenuItemList::Node *node = GetMenuItems().GetFirst(); + wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst(); + for ( pos = 0; node; pos++ ) { if ( node->GetData() == item ) @@ -253,11 +354,9 @@ wxMenuItem *wxMenu::DoRemove(wxMenuItem *item) ::DeleteMenuItem(MAC_WXHMENU(m_hMenu) , pos + 1); - if ( IsAttached() ) - { + if ( IsAttached() && GetMenuBar()->IsAttached() ) // otherwise, the change won't be visible - m_menuBar->Refresh(); - } + GetMenuBar()->Refresh(); // and from internal data structures return wxMenuBase::DoRemove(item); @@ -265,30 +364,20 @@ wxMenuItem *wxMenu::DoRemove(wxMenuItem *item) void wxMenu::SetTitle(const wxString& label) { - m_title = label ; - UMASetMenuTitle(MAC_WXHMENU(m_hMenu) , label ) ; + m_title = label ; + UMASetMenuTitle(MAC_WXHMENU(m_hMenu) , label , wxFont::GetDefaultEncoding() ) ; } + bool wxMenu::ProcessCommand(wxCommandEvent & event) { - bool processed = FALSE; - -#if WXWIN_COMPATIBILITY - // Try a callback - if (m_callback) - { - (void)(*(m_callback))(*this, event); - processed = TRUE; - } -#endif WXWIN_COMPATIBILITY + bool processed = false; // Try the menu's event handler - if ( !processed && GetEventHandler()) - { + if ( /* !processed && */ GetEventHandler()) processed = GetEventHandler()->ProcessEvent(event); - } - // Try the window the menu was popped up from (and up through the - // hierarchy) + // Try the window the menu was popped up from + // (and up through the hierarchy) wxWindow *win = GetInvokingWindow(); if ( !processed && win ) processed = win->GetEventHandler()->ProcessEvent(event); @@ -296,7 +385,6 @@ bool wxMenu::ProcessCommand(wxCommandEvent & event) return processed; } - // --------------------------------------------------------------------------- // other // --------------------------------------------------------------------------- @@ -305,19 +393,19 @@ wxWindow *wxMenu::GetWindow() const { if ( m_invokingWindow != NULL ) return m_invokingWindow; - else if ( m_menuBar != NULL) - return (wxWindow *) m_menuBar->GetFrame(); + else if ( GetMenuBar() != NULL) + return (wxWindow *) GetMenuBar()->GetFrame(); return NULL; } -// helper functions returning the mac menu position for a certain item, note that this is +// helper functions returning the mac menu position for a certain item, note that this is // mac-wise 1 - based, i.e. the first item has index 1 whereas on MSWin it has pos 0 -int wxMenu::MacGetIndexFromId( int id ) +int wxMenu::MacGetIndexFromId( int id ) { size_t pos; - wxMenuItemList::Node *node = GetMenuItems().GetFirst(); + wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst(); for ( pos = 0; node; pos++ ) { if ( node->GetData()->GetId() == id ) @@ -325,17 +413,17 @@ int wxMenu::MacGetIndexFromId( int id ) node = node->GetNext(); } - + if (!node) return 0; - + return pos + 1 ; } -int wxMenu::MacGetIndexFromItem( wxMenuItem *pItem ) +int wxMenu::MacGetIndexFromItem( wxMenuItem *pItem ) { size_t pos; - wxMenuItemList::Node *node = GetMenuItems().GetFirst(); + wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst(); for ( pos = 0; node; pos++ ) { if ( node->GetData() == pItem ) @@ -346,72 +434,116 @@ int wxMenu::MacGetIndexFromItem( wxMenuItem *pItem ) if (!node) return 0; - + return pos + 1 ; } -void wxMenu::MacEnableMenu( bool bDoEnable ) +void wxMenu::MacEnableMenu( bool bDoEnable ) { UMAEnableMenuItem(MAC_WXHMENU(m_hMenu) , 0 , bDoEnable ) ; - + ::DrawMenuBar() ; } // MacOS needs to know about submenus somewhere within this menu -// before it can be displayed , also hide special menu items like preferences -// that are handled by the OS -void wxMenu::MacBeforeDisplay( bool isSubMenu ) +// before it can be displayed, also hide special menu items +// like preferences that are handled by the OS +void wxMenu::MacBeforeDisplay( bool isSubMenu ) { wxMenuItem* previousItem = NULL ; - int pos ; - wxMenuItemList::Node *node; + size_t pos ; + wxMenuItemList::compatibility_iterator node; wxMenuItem *item; - for (pos = 0, node = GetMenuItems().GetFirst(); node; node = node->GetNext(), pos++) + + for (pos = 0, node = GetMenuItems().GetFirst(); node; node = node->GetNext(), pos++) { item = (wxMenuItem *)node->GetData(); wxMenu* subMenu = item->GetSubMenu() ; - if (subMenu) + if (subMenu) { subMenu->MacBeforeDisplay( true ) ; } - else + else // normal item { - #if TARGET_CARBON - if ( UMAGetSystemVersion() >= 0x1000 ) +#if TARGET_CARBON + // what we do here is to hide the special items which are + // shown in the application menu anyhow -- it doesn't make + // sense to show them in their normal place as well + if ( item->GetId() == wxApp::s_macAboutMenuItemId || + ( UMAGetSystemVersion() >= 0x1000 && ( + item->GetId() == wxApp::s_macPreferencesMenuItemId || + item->GetId() == wxApp::s_macExitMenuItemId ) ) ) + { - if ( item->GetId() == wxApp::s_macPreferencesMenuItemId || item->GetId() == wxApp::s_macExitMenuItemId) + ChangeMenuItemAttributes( MAC_WXHMENU( GetHMenu() ), + pos + 1, kMenuItemAttrHidden, 0 ); + + // also check for a separator which was used just to + // separate this item from the others, so don't leave + // separator at the menu start or end nor 2 consecutive + // separators + wxMenuItemList::compatibility_iterator nextNode = node->GetNext(); + wxMenuItem *next = nextNode ? nextNode->GetData() : NULL; + + size_t posSeptoHide; + if ( !previousItem && next && next->IsSeparator() ) { - ChangeMenuItemAttributes( MAC_WXHMENU( GetHMenu() ) , pos + 1, kMenuItemAttrHidden, 0 ); - if ( GetMenuItems().GetCount() == pos + 1 && previousItem != NULL && previousItem->IsSeparator() ) - { - ChangeMenuItemAttributes( MAC_WXHMENU( GetHMenu() ) , pos , kMenuItemAttrHidden, 0 ); - } + // next (i.e. second as we must be first) item is + // the separator to hide + wxASSERT_MSG( pos == 0, _T("should be the menu start") ); + posSeptoHide = 2; + } + else if ( GetMenuItems().GetCount() == pos + 1 && + previousItem != NULL && + previousItem->IsSeparator() ) + { + // prev item is a trailing separator we want to hide + posSeptoHide = pos; + } + else if ( previousItem && previousItem->IsSeparator() && + next && next->IsSeparator() ) + { + // two consecutive separators, this is one too many + posSeptoHide = pos; + } + else // no separators to hide + { + posSeptoHide = 0; + } + + if ( posSeptoHide ) + { + // hide the separator as well + ChangeMenuItemAttributes( MAC_WXHMENU( GetHMenu() ), + posSeptoHide, + kMenuItemAttrHidden, + 0 ); } } - #endif +#endif // TARGET_CARBON } + previousItem = item ; } if ( isSubMenu ) ::InsertMenu(MAC_WXHMENU( GetHMenu()), -1); - } + // undo all changes from the MacBeforeDisplay call -void wxMenu::MacAfterDisplay( bool isSubMenu ) +void wxMenu::MacAfterDisplay( bool isSubMenu ) { if ( isSubMenu ) ::DeleteMenu(MacGetMenuId()); - wxMenuItem* previousItem = NULL ; - int pos ; - wxMenuItemList::Node *node; + wxMenuItemList::compatibility_iterator node; wxMenuItem *item; - for (pos = 0, node = GetMenuItems().GetFirst(); node; node = node->GetNext(), pos++) + + for (node = GetMenuItems().GetFirst(); node; node = node->GetNext()) { item = (wxMenuItem *)node->GetData(); wxMenu* subMenu = item->GetSubMenu() ; - if (subMenu) + if (subMenu) { subMenu->MacAfterDisplay( true ) ; } @@ -419,13 +551,12 @@ void wxMenu::MacAfterDisplay( bool isSubMenu ) { // no need to undo hidings } - previousItem = item ; } } // Menu Bar -/* +/* Mac Implementation note : @@ -433,16 +564,19 @@ The Mac has only one global menubar, so we attempt to install the currently active menubar from a frame, we currently don't take into account mdi-frames which would ask for menu-merging -Secondly there is no mac api for changing a menubar that is not the current +Secondly there is no mac api for changing a menubar that is not the current menubar, so we have to wait for preparing the actual menubar until the wxMenubar is to be used -We can in subsequent versions use MacInstallMenuBar to provide some sort of +We can in subsequent versions use MacInstallMenuBar to provide some sort of auto-merge for MDI in case this will be necessary */ wxMenuBar* wxMenuBar::s_macInstalledMenuBar = NULL ; +wxMenuBar* wxMenuBar::s_macCommonMenuBar = NULL ; +bool wxMenuBar::s_macAutoWindowMenu = true ; +WXHMENU wxMenuBar::s_macWindowMenuHandle = NULL ; void wxMenuBar::Init() { @@ -461,14 +595,13 @@ wxMenuBar::wxMenuBar( long WXUNUSED(style) ) Init(); } - -wxMenuBar::wxMenuBar(int count, wxMenu *menus[], const wxString titles[]) +wxMenuBar::wxMenuBar(size_t count, wxMenu *menus[], const wxString titles[], long WXUNUSED(style)) { Init(); m_titles.Alloc(count); - for ( int i = 0; i < count; i++ ) + for ( size_t i = 0; i < count; i++ ) { m_menus.Append(menus[i]); m_titles.Add(titles[i]); @@ -479,12 +612,14 @@ wxMenuBar::wxMenuBar(int count, wxMenu *menus[], const wxString titles[]) wxMenuBar::~wxMenuBar() { + if (s_macCommonMenuBar == this) + s_macCommonMenuBar = NULL; + if (s_macInstalledMenuBar == this) { ::ClearMenuBar(); s_macInstalledMenuBar = NULL; } - } void wxMenuBar::Refresh(bool WXUNUSED(eraseBackground), const wxRect *WXUNUSED(rect)) @@ -494,44 +629,52 @@ void wxMenuBar::Refresh(bool WXUNUSED(eraseBackground), const wxRect *WXUNUSED(r DrawMenuBar(); } -void wxMenuBar::MacInstallMenuBar() +void wxMenuBar::MacInstallMenuBar() { if ( s_macInstalledMenuBar == this ) return ; - - wxStAppResource resload ; - - Handle menubar = ::GetNewMBar( kwxMacMenuBarResource ) ; - wxString message ; - wxCHECK_RET( menubar != NULL, wxT("can't read MBAR resource") ); - ::SetMenuBar( menubar ) ; -#if TARGET_API_MAC_CARBON - ::DisposeMenuBar( menubar ) ; + + MenuBarHandle menubar = NULL ; + +#if TARGET_API_MAC_OSX + menubar = NewHandleClear( 6 /* sizeof( MenuBarHeader ) */ ) ; #else - ::DisposeHandle( menubar ) ; + menubar = NewHandleClear( 12 ) ; + (*menubar)[3] = 0x0a ; #endif -#if TARGET_API_MAC_OS8 - MenuHandle menu = ::GetMenuHandle( kwxMacAppleMenuId ) ; - if ( CountMenuItems( menu ) == 2 ) - { - ::AppendResMenu(menu, 'DRVR'); - } + ::SetMenuBar( menubar ) ; + DisposeMenuBar( menubar ) ; + MenuHandle appleMenu = NULL ; + + verify_noerr( CreateNewMenu( kwxMacAppleMenuId , 0 , &appleMenu ) ) ; + verify_noerr( SetMenuTitleWithCFString( appleMenu , CFSTR( "\x14" ) ) ); + + // Add About/Preferences separator only on OS X + // KH/RN: Separator is always present on 10.3 but not on 10.2 + // However, the change from 10.2 to 10.3 suggests it is preferred +#if TARGET_API_MAC_OSX + InsertMenuItemTextWithCFString( appleMenu, + CFSTR(""), 0, kMenuItemAttrSeparator, 0); #endif - - // clean-up the help menu before adding new items - MenuHandle mh = NULL ; - if ( UMAGetHelpMenu( &mh , &firstUserHelpMenuItem) == noErr ) + InsertMenuItemTextWithCFString( appleMenu, + CFSTR("About..."), 0, 0, 0); + MacInsertMenu( appleMenu , 0 ) ; + + // if we have a mac help menu, clean it up before adding new items + MenuHandle helpMenuHandle ; + MenuItemIndex firstUserHelpMenuItem ; + + if ( UMAGetHelpMenuDontCreate( &helpMenuHandle , &firstUserHelpMenuItem) == noErr ) { - for ( int i = CountMenuItems( mh ) ; i >= firstUserHelpMenuItem ; --i ) - { - DeleteMenuItem( mh , i ) ; - } + for ( int i = CountMenuItems( helpMenuHandle ) ; i >= firstUserHelpMenuItem ; --i ) + DeleteMenuItem( helpMenuHandle , i ) ; } else { - mh = NULL ; + helpMenuHandle = NULL ; } + #if TARGET_CARBON if ( UMAGetSystemVersion() >= 0x1000 && wxApp::s_macPreferencesMenuItemId) { @@ -541,69 +684,151 @@ void wxMenuBar::MacInstallMenuBar() else EnableMenuCommand( NULL , kHICommandPreferences ) ; } + + // Unlike preferences which may or may not exist, the Quit item should be always + // enabled unless it is added by the application and then disabled, otherwise + // a program would be required to add an item with wxID_EXIT in order to get the + // Quit menu item to be enabled, which seems a bit burdensome. + if ( UMAGetSystemVersion() >= 0x1000 && wxApp::s_macExitMenuItemId) + { + wxMenuItem *item = FindItem( wxApp::s_macExitMenuItemId , NULL ) ; + if ( item != NULL && !(item->IsEnabled()) ) + DisableMenuCommand( NULL , kHICommandQuit ) ; + else + EnableMenuCommand( NULL , kHICommandQuit ) ; + } #endif - for (size_t i = 0; i < m_menus.GetCount(); i++) - { - Str255 label; - wxMenuItemList::Node *node; + + wxString strippedHelpMenuTitle = wxStripMenuCodes( wxApp::s_macHelpMenuTitleName ) ; + wxString strippedTranslatedHelpMenuTitle = wxStripMenuCodes( wxString( _("&Help") ) ) ; + wxMenuList::compatibility_iterator menuIter = m_menus.GetFirst(); + for (size_t i = 0; i < m_menus.GetCount(); i++, menuIter = menuIter->GetNext()) + { + wxMenuItemList::compatibility_iterator node; wxMenuItem *item; - int pos ; - wxMenu* menu = m_menus[i] , *subMenu = NULL ; + wxMenu* menu = menuIter->GetData() , *subMenu = NULL ; + wxString strippedMenuTitle = wxStripMenuCodes(m_titles[i]); - if( m_titles[i] == wxT("?") || m_titles[i] == wxT("&?") || m_titles[i] == wxApp::s_macHelpMenuTitleName ) + if ( strippedMenuTitle == wxT("?") || strippedMenuTitle == strippedHelpMenuTitle || strippedMenuTitle == strippedTranslatedHelpMenuTitle ) { - if ( mh == NULL ) + for (node = menu->GetMenuItems().GetFirst(); node; node = node->GetNext()) { - continue ; - } - - for (pos = 0 , node = menu->GetMenuItems().GetFirst(); node; node = node->GetNext(), pos++) - { - item = (wxMenuItem *)node->GetData(); - subMenu = item->GetSubMenu() ; - if (subMenu) + item = (wxMenuItem *)node->GetData(); + subMenu = item->GetSubMenu() ; + if (subMenu) { // we don't support hierarchical menus in the help menu yet } - else + else { + if ( item->GetId() != wxApp::s_macAboutMenuItemId ) + { + // we have found a user help menu and an item other than the about item, + // so we can create the mac help menu now, if we haven't created it yet + if ( helpMenuHandle == NULL ) + { + if ( UMAGetHelpMenu( &helpMenuHandle , &firstUserHelpMenuItem) != noErr ) + { + helpMenuHandle = NULL ; + break ; + } + } + } + if ( item->IsSeparator() ) { - if ( mh ) - MacAppendMenu(mh, "\p-" ); + if ( helpMenuHandle ) + AppendMenuItemTextWithCFString( helpMenuHandle, + CFSTR(""), kMenuItemAttrSeparator, 0,NULL); } else { - wxAcceleratorEntry* entry = wxGetAccelFromString( item->GetText() ) ; + wxAcceleratorEntry* + entry = wxAcceleratorEntry::Create( item->GetText() ) ; if ( item->GetId() == wxApp::s_macAboutMenuItemId ) - { - UMASetMenuItemText( GetMenuHandle( kwxMacAppleMenuId ) , 1 , item->GetText() ); - UMAEnableMenuItem( GetMenuHandle( kwxMacAppleMenuId ) , 1 , true ); - SetMenuItemCommandID( GetMenuHandle( kwxMacAppleMenuId ) , 1 , item->GetId() ) ; - UMASetMenuItemShortcut( GetMenuHandle( kwxMacAppleMenuId ) , 1 , entry ) ; - } + { + // this will be taken care of below + } else { - if ( mh ) + if ( helpMenuHandle ) { - UMAAppendMenuItem(mh, item->GetText() , entry ); - SetMenuItemCommandID( mh , CountMenuItems(mh) , item->GetId() ) ; + UMAAppendMenuItem(helpMenuHandle, wxStripMenuCodes(item->GetText()) , wxFont::GetDefaultEncoding(), entry); + SetMenuItemCommandID( helpMenuHandle , CountMenuItems(helpMenuHandle) , wxIdToMacCommand ( item->GetId() ) ) ; + SetMenuItemRefCon( helpMenuHandle , CountMenuItems(helpMenuHandle) , (URefCon) item ) ; } } - + delete entry ; } } } } + + else if ( ( m_titles[i] == wxT("Window") || m_titles[i] == wxT("&Window") ) + && GetAutoWindowMenu() ) + { + if ( MacGetWindowMenuHMenu() == NULL ) + { + CreateStandardWindowMenu( 0 , (MenuHandle*) &s_macWindowMenuHandle ) ; + } + + MenuRef wm = (MenuRef)MacGetWindowMenuHMenu(); + if ( wm == NULL ) + break; + + // get the insertion point in the standard menu + MenuItemIndex winListStart; + GetIndMenuItemWithCommandID(wm, + kHICommandWindowListSeparator, 1, NULL, &winListStart); + + // add a separator so that the standard items and the custom items + // aren't mixed together, but only if this is the first run + OSStatus err = GetIndMenuItemWithCommandID(wm, + 'WXWM', 1, NULL, NULL); + + if ( err == menuItemNotFoundErr ) + { + InsertMenuItemTextWithCFString( wm, + CFSTR(""), winListStart-1, kMenuItemAttrSeparator, 'WXWM'); + } + + wxInsertMenuItemsInMenu(menu, wm, winListStart); + } else { - UMASetMenuTitle( MAC_WXHMENU(menu->GetHMenu()) , m_titles[i] ) ; - m_menus[i]->MacBeforeDisplay(false) ; - ::InsertMenu(MAC_WXHMENU(m_menus[i]->GetHMenu()), 0); + UMASetMenuTitle( MAC_WXHMENU(menu->GetHMenu()) , m_titles[i], m_font.GetEncoding() ) ; + menu->MacBeforeDisplay(false) ; + + ::InsertMenu(MAC_WXHMENU(_wxMenuAt(m_menus, i)->GetHMenu()), 0); } } + + // take care of the about menu item wherever it is + { + wxMenu* aboutMenu ; + wxMenuItem *aboutMenuItem = FindItem(wxApp::s_macAboutMenuItemId , &aboutMenu) ; + if ( aboutMenuItem ) + { + wxAcceleratorEntry* + entry = wxAcceleratorEntry::Create( aboutMenuItem->GetText() ) ; + UMASetMenuItemText( GetMenuHandle( kwxMacAppleMenuId ) , 1 , wxStripMenuCodes ( aboutMenuItem->GetText() ) , wxFont::GetDefaultEncoding() ); + UMAEnableMenuItem( GetMenuHandle( kwxMacAppleMenuId ) , 1 , true ); + SetMenuItemCommandID( GetMenuHandle( kwxMacAppleMenuId ) , 1 , kHICommandAbout ) ; + SetMenuItemRefCon(GetMenuHandle( kwxMacAppleMenuId ) , 1 , (URefCon)aboutMenuItem ) ; + UMASetMenuItemShortcut( GetMenuHandle( kwxMacAppleMenuId ) , 1 , entry ) ; + } + } + + if ( GetAutoWindowMenu() ) + { + if ( MacGetWindowMenuHMenu() == NULL ) + CreateStandardWindowMenu( 0 , (MenuHandle*) &s_macWindowMenuHandle ) ; + + InsertMenu( (MenuHandle) MacGetWindowMenuHMenu() , 0 ) ; + } + ::DrawMenuBar() ; s_macInstalledMenuBar = this; } @@ -611,10 +836,22 @@ void wxMenuBar::MacInstallMenuBar() void wxMenuBar::EnableTop(size_t pos, bool enable) { wxCHECK_RET( IsAttached(), wxT("doesn't work with unattached menubars") ); - m_menus[pos]->MacEnableMenu( enable ) ; + + _wxMenuAt(m_menus, pos)->MacEnableMenu( enable ) ; Refresh(); } +bool wxMenuBar::Enable(bool enable) +{ + wxCHECK_MSG( IsAttached(), false, wxT("doesn't work with unattached menubars") ); + + size_t i; + for (i = 0; i < GetMenuCount(); i++) + EnableTop(i, enable); + + return true; +} + void wxMenuBar::SetLabelTop(size_t pos, const wxString& label) { wxCHECK_RET( pos < GetMenuCount(), wxT("invalid menu index") ); @@ -622,11 +859,10 @@ void wxMenuBar::SetLabelTop(size_t pos, const wxString& label) m_titles[pos] = label; if ( !IsAttached() ) - { return; - } - m_menus[pos]->SetTitle( label ) ; + _wxMenuAt(m_menus, pos)->SetTitle( label ) ; + if (wxMenuBar::s_macInstalledMenuBar == this) // are we currently installed ? { ::SetMenuBar( GetMenuBar() ) ; @@ -651,18 +887,12 @@ int wxMenuBar::FindMenu(const wxString& title) { wxString title = wxStripMenuCodes(m_titles[i]); if ( menuTitle == title ) - return i; + return i; } return wxNOT_FOUND; - } - -// --------------------------------------------------------------------------- -// wxMenuBar construction -// --------------------------------------------------------------------------- - // --------------------------------------------------------------------------- // wxMenuBar construction // --------------------------------------------------------------------------- @@ -671,7 +901,8 @@ wxMenu *wxMenuBar::Replace(size_t pos, wxMenu *menu, const wxString& title) { wxMenu *menuOld = wxMenuBarBase::Replace(pos, menu, title); if ( !menuOld ) - return FALSE; + return NULL; + m_titles[pos] = title; if ( IsAttached() ) @@ -680,53 +911,52 @@ wxMenu *wxMenuBar::Replace(size_t pos, wxMenu *menu, const wxString& title) { menuOld->MacAfterDisplay( false ) ; ::DeleteMenu( menuOld->MacGetMenuId() /* m_menus[pos]->MacGetMenuId() */ ) ; - { - menu->MacBeforeDisplay( false ) ; - UMASetMenuTitle( MAC_WXHMENU(menu->GetHMenu()) , title ) ; - if ( pos == m_menus.GetCount() - 1) - { - ::InsertMenu( MAC_WXHMENU(menu->GetHMenu()) , 0 ) ; - } - else - { - ::InsertMenu( MAC_WXHMENU(menu->GetHMenu()) , m_menus[pos+1]->MacGetMenuId() ) ; - } - } + + menu->MacBeforeDisplay( false ) ; + UMASetMenuTitle( MAC_WXHMENU(menu->GetHMenu()) , title , m_font.GetEncoding() ) ; + if ( pos == m_menus.GetCount() - 1) + ::InsertMenu( MAC_WXHMENU(menu->GetHMenu()) , 0 ) ; + else + ::InsertMenu( MAC_WXHMENU(menu->GetHMenu()) , _wxMenuAt(m_menus, pos + 1)->MacGetMenuId() ) ; } Refresh(); } + if (m_invokingWindow) + wxMenubarSetInvokingWindow( menu, m_invokingWindow ); + return menuOld; } bool wxMenuBar::Insert(size_t pos, wxMenu *menu, const wxString& title) { if ( !wxMenuBarBase::Insert(pos, menu, title) ) - return FALSE; + return false; m_titles.Insert(title, pos); - UMASetMenuTitle( MAC_WXHMENU(menu->GetHMenu()) , title ) ; + UMASetMenuTitle( MAC_WXHMENU(menu->GetHMenu()) , title , m_font.GetEncoding() ) ; if ( IsAttached() && s_macInstalledMenuBar == this ) { if (s_macInstalledMenuBar == this) { menu->MacBeforeDisplay( false ) ; + if ( pos == (size_t) -1 || pos + 1 == m_menus.GetCount() ) - { ::InsertMenu( MAC_WXHMENU(menu->GetHMenu()) , 0 ) ; - } else - { - ::InsertMenu( MAC_WXHMENU(menu->GetHMenu()) , m_menus[pos+1]->MacGetMenuId() ) ; - } + ::InsertMenu( MAC_WXHMENU(menu->GetHMenu()) , _wxMenuAt(m_menus, pos+1)->MacGetMenuId() ) ; } + Refresh(); } - return TRUE; + if (m_invokingWindow) + wxMenubarSetInvokingWindow( menu, m_invokingWindow ); + + return true; } wxMenu *wxMenuBar::Remove(size_t pos) @@ -738,16 +968,12 @@ wxMenu *wxMenuBar::Remove(size_t pos) if ( IsAttached() ) { if (s_macInstalledMenuBar == this) - { ::DeleteMenu( menu->MacGetMenuId() /* m_menus[pos]->MacGetMenuId() */ ) ; - } - - menu->Detach(); Refresh(); } - m_titles.Remove(pos); + m_titles.RemoveAt(pos); return menu; } @@ -755,43 +981,45 @@ wxMenu *wxMenuBar::Remove(size_t pos) bool wxMenuBar::Append(wxMenu *menu, const wxString& title) { WXHMENU submenu = menu ? menu->GetHMenu() : 0; - wxCHECK_MSG( submenu, FALSE, wxT("can't append invalid menu to menubar") ); + wxCHECK_MSG( submenu, false, wxT("can't append invalid menu to menubar") ); if ( !wxMenuBarBase::Append(menu, title) ) - return FALSE; + return false; m_titles.Add(title); - - UMASetMenuTitle( MAC_WXHMENU(menu->GetHMenu()) , title ) ; + + UMASetMenuTitle( MAC_WXHMENU(menu->GetHMenu()) , title , m_font.GetEncoding() ) ; if ( IsAttached() ) { if (s_macInstalledMenuBar == this) { + menu->MacBeforeDisplay( false ) ; ::InsertMenu( MAC_WXHMENU(menu->GetHMenu()) , 0 ) ; } Refresh(); } - // m_invokingWindow is set after wxFrame::SetMenuBar(). This call enables + // m_invokingWindow is set after wxFrame::SetMenuBar(). This call enables // adding menu later on. if (m_invokingWindow) wxMenubarSetInvokingWindow( menu, m_invokingWindow ); - return TRUE; + return true; } static void wxMenubarUnsetInvokingWindow( wxMenu *menu ) { menu->SetInvokingWindow( (wxWindow*) NULL ); + wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst(); - wxMenuItemList::Node *node = menu->GetMenuItems().GetFirst(); while (node) { wxMenuItem *menuitem = node->GetData(); if (menuitem->IsSubMenu()) wxMenubarUnsetInvokingWindow( menuitem->GetSubMenu() ); + node = node->GetNext(); } } @@ -799,13 +1027,15 @@ static void wxMenubarUnsetInvokingWindow( wxMenu *menu ) static void wxMenubarSetInvokingWindow( wxMenu *menu, wxWindow *win ) { menu->SetInvokingWindow( win ); + wxMenuItem *menuitem; + wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst(); - wxMenuItemList::Node *node = menu->GetMenuItems().GetFirst(); while (node) { - wxMenuItem *menuitem = node->GetData(); + menuitem = node->GetData(); if (menuitem->IsSubMenu()) wxMenubarSetInvokingWindow( menuitem->GetSubMenu() , win ); + node = node->GetNext(); } } @@ -813,11 +1043,14 @@ static void wxMenubarSetInvokingWindow( wxMenu *menu, wxWindow *win ) void wxMenuBar::UnsetInvokingWindow() { m_invokingWindow = (wxWindow*) NULL; - wxMenuList::Node *node = m_menus.GetFirst(); + wxMenu *menu; + wxMenuList::compatibility_iterator node = m_menus.GetFirst(); + while (node) { - wxMenu *menu = node->GetData(); + menu = node->GetData(); wxMenubarUnsetInvokingWindow( menu ); + node = node->GetNext(); } } @@ -825,11 +1058,14 @@ void wxMenuBar::UnsetInvokingWindow() void wxMenuBar::SetInvokingWindow(wxFrame *frame) { m_invokingWindow = frame; - wxMenuList::Node *node = m_menus.GetFirst(); + wxMenu *menu; + wxMenuList::compatibility_iterator node = m_menus.GetFirst(); + while (node) { - wxMenu *menu = node->GetData(); + menu = node->GetData(); wxMenubarSetInvokingWindow( menu, frame ); + node = node->GetNext(); } } @@ -843,6 +1079,7 @@ void wxMenuBar::Attach(wxFrame *frame) { wxMenuBarBase::Attach( frame ) ; } + // --------------------------------------------------------------------------- // wxMenuBar searching for menu items // --------------------------------------------------------------------------- @@ -856,8 +1093,8 @@ int wxMenuBar::FindMenuItem(const wxString& menuString, for ( size_t i = 0; i < count; i++ ) { wxString title = wxStripMenuCodes(m_titles[i]); - if ( menuString == title ) - return m_menus[i]->FindItem(itemString); + if ( menuLabel == title ) + return _wxMenuAt(m_menus, i)->FindItem(itemString); } return wxNOT_FOUND; @@ -871,11 +1108,7 @@ wxMenuItem *wxMenuBar::FindItem(int id, wxMenu **itemMenu) const wxMenuItem *item = NULL; size_t count = GetMenuCount(); for ( size_t i = 0; !item && (i < count); i++ ) - { - item = m_menus[i]->FindItem(id, itemMenu); - } + item = _wxMenuAt(m_menus, i)->FindItem(id, itemMenu); return item; } - -