X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3d52bdd8c6ff039f57fa4374520b78e6a77e3f45..6178debcd342963974dbdce6ac2ddb2fbe89e42a:/src/osx/carbon/menu.cpp?ds=sidebyside diff --git a/src/osx/carbon/menu.cpp b/src/osx/carbon/menu.cpp index 8d1277c7f7..ab442f635f 100644 --- a/src/osx/carbon/menu.cpp +++ b/src/osx/carbon/menu.cpp @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: src/mac/carbon/menu.cpp +// Name: src/osx/carbon/menu.cpp // Purpose: wxMenu, wxMenuBar, wxMenuItem // Author: Stefan Csomor // Modified by: @@ -28,1158 +28,393 @@ #include "wx/menuitem.h" #endif -#include "wx/osx/uma.h" +#include "wx/osx/private.h" +#include "wx/stockitem.h" // other standard headers // ---------------------- #include -IMPLEMENT_DYNAMIC_CLASS(wxMenu, wxEvtHandler) -IMPLEMENT_DYNAMIC_CLASS(wxMenuBar, wxEvtHandler) +// under carbon there's no such thing as a MenuItemRef, everything is done +// on the 'parent' menu via index APIs (first line having index 1 !) +// so to make things still work, we store the wxMenuItemImpl instance as a +// RefCon at the respective menu line -// the (popup) menu title has this special id -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") ); - - wxWinMacMenuList[inMenuRef] = menu; -} - -void wxRemoveMacMenuAssociation(wxMenu *menu) ; -void wxRemoveMacMenuAssociation(wxMenu *menu) +class wxMenuItemCarbonImpl : public wxMenuItemImpl { - // iterate over all the elements in the class - MacMenuMap::iterator it; - for ( it = wxWinMacMenuList.begin(); it != wxWinMacMenuList.end(); ++it ) +public : + wxMenuItemCarbonImpl( wxMenuItem* peer ) : wxMenuItemImpl(peer) { - if ( it->second == menu ) - { - wxWinMacMenuList.erase(it); - break; - } + // the parent menu ref is only set, once the item has been attached + m_parentMenuRef = NULL; } -} -void wxInsertMenuItemsInMenu(wxMenu* menu, MenuRef wm, MenuItemIndex insertAfter) -{ - wxMenuItemList::compatibility_iterator node; - wxMenuItem *item; - wxMenu *subMenu = NULL ; - bool newItems = false; + ~wxMenuItemCarbonImpl(); - for (node = menu->GetMenuItems().GetFirst(); node; node = node->GetNext()) + void SetBitmap( const wxBitmap& bitmap ) { - item = (wxMenuItem *)node->GetData(); - subMenu = item->GetSubMenu() ; - if (subMenu) - { - wxInsertMenuItemsInMenu(subMenu, (MenuRef)subMenu->GetHMenu(), 0); - } - if ( item->IsSeparator() ) + MenuItemIndex i = FindMenuItemIndex() ; + if ( i > 0 ) { - if ( wm && newItems) - InsertMenuItemTextWithCFString( wm, - CFSTR(""), insertAfter, kMenuItemAttrSeparator, 0); - - newItems = false; - } - else - { - wxAcceleratorEntry* - entry = wxAcceleratorEntry::Create( item->GetItemLabel() ) ; - - MenuItemIndex winListPos = (MenuItemIndex)-1; - OSStatus err = GetIndMenuItemWithCommandID(wm, - wxIdToMacCommand ( item->GetId() ), 1, NULL, &winListPos); - - if ( wm && err == menuItemNotFoundErr ) + if ( bitmap.Ok() ) { - // 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->GetItemLabel()) , wxFont::GetDefaultEncoding(), insertAfter, entry); - SetMenuItemCommandID( wm , insertAfter+1 , wxIdToMacCommand ( item->GetId() ) ) ; - SetMenuItemRefCon( wm , insertAfter+1 , (URefCon) item ) ; +#if wxUSE_BMPBUTTON + ControlButtonContentInfo info ; + wxMacCreateBitmapButton( &info , bitmap ) ; + if ( info.contentType != kControlNoContent ) + { + if ( info.contentType == kControlContentIconRef ) + SetMenuItemIconHandle( m_parentMenuRef, i , + kMenuIconRefType , (Handle) info.u.iconRef ) ; + else if ( info.contentType == kControlContentCGImageRef ) + SetMenuItemIconHandle( m_parentMenuRef, i , + kMenuCGImageRefType , (Handle) info.u.imageRef ) ; + } + wxMacReleaseBitmapButton( &info ) ; +#endif } - - delete entry ; } } -} - -// ============================================================================ -// implementation -// ============================================================================ -static void wxMenubarUnsetInvokingWindow( wxMenu *menu ) ; -static void wxMenubarSetInvokingWindow( wxMenu *menu, wxWindow *win ); - -// Menus - -// Construct a menu with optional title (then use append) - -#ifdef __DARWIN__ -short wxMenu::s_macNextMenuId = 3 ; -#else -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_startRadioGroup = -1; - - // create the menu - m_macMenuId = s_macNextMenuId++; - m_hMenu = UMANewMenu(m_macMenuId, m_title, wxFont::GetDefaultEncoding() ); - - if ( !m_hMenu ) - { - 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.empty() ) - { - Append(idMenuTitle, m_title) ; - AppendSeparator() ; - } -} - -wxMenu::~wxMenu() -{ - wxRemoveMacMenuAssociation( this ) ; - if (MAC_WXHMENU(m_hMenu)) - ::DisposeMenu(MAC_WXHMENU(m_hMenu)); -} - -void wxMenu::Break() -{ - // not available on the mac platform -} -void wxMenu::Attach(wxMenuBarBase *menubar) -{ - wxMenuBase::Attach(menubar); - - EndRadioGroup(); -} - -// function appends a new item or submenu to the menu -// append a new item or submenu to the menu -bool wxMenu::DoInsertOrAppend(wxMenuItem *pItem, size_t pos) -{ - wxASSERT_MSG( pItem != NULL, wxT("can't append NULL item to the menu") ); - - if ( pItem->IsSeparator() ) + void Enable( bool enable ) { - if ( pos == (size_t)-1 ) - AppendMenuItemTextWithCFString( MAC_WXHMENU(m_hMenu), - CFSTR(""), kMenuItemAttrSeparator, 0,NULL); - else - InsertMenuItemTextWithCFString( MAC_WXHMENU(m_hMenu), - CFSTR(""), pos, kMenuItemAttrSeparator, 0); - } - else - { - wxMenu *pSubMenu = pItem->GetSubMenu() ; - if ( pSubMenu != NULL ) + MenuItemIndex i = FindMenuItemIndex() ; + if ( i > 0 ) { - wxASSERT_MSG( pSubMenu->m_hMenu != NULL , wxT("invalid submenu added")); - pSubMenu->m_menuParent = this ; - - // We need the !GetMenuBar() check to make sure we run MacBeforeDisplay() - // for popup menus and other menus which may not be part of the main - // menu bar. - if (!GetMenuBar() || wxMenuBar::MacGetInstalledMenuBar() == GetMenuBar()) - pSubMenu->MacBeforeDisplay( true ) ; - - if ( pos == (size_t)-1 ) - UMAAppendSubMenuItem(MAC_WXHMENU(m_hMenu), wxStripMenuCodes(pItem->GetItemLabel()), wxFont::GetDefaultEncoding(), pSubMenu->m_macMenuId); - else - UMAInsertSubMenuItem(MAC_WXHMENU(m_hMenu), wxStripMenuCodes(pItem->GetItemLabel()), wxFont::GetDefaultEncoding(), pos, pSubMenu->m_macMenuId); - pItem->UpdateItemBitmap() ; - pItem->UpdateItemStatus() ; - } - else - { - if ( pos == (size_t)-1 ) + if ( GetWXPeer()->GetId() == wxApp::s_macPreferencesMenuItemId) { - UMAAppendMenuItem(MAC_WXHMENU(m_hMenu), wxT("a") , wxFont::GetDefaultEncoding() ); - pos = CountMenuItems(MAC_WXHMENU(m_hMenu)) ; + if ( enable ) + EnableMenuCommand( NULL , kHICommandPreferences ) ; + else + DisableMenuCommand( NULL , kHICommandPreferences ) ; } - else + else if ( GetWXPeer()->GetId() == wxApp::s_macExitMenuItemId) { - // 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 ; + if ( enable ) + EnableMenuCommand( NULL , kHICommandQuit ) ; + else + DisableMenuCommand( NULL , kHICommandQuit ) ; } - SetMenuItemCommandID( MAC_WXHMENU(m_hMenu) , pos , wxIdToMacCommand ( pItem->GetId() ) ) ; - SetMenuItemRefCon( MAC_WXHMENU(m_hMenu) , pos , (URefCon) pItem ) ; - pItem->UpdateItemText() ; - pItem->UpdateItemBitmap() ; - pItem->UpdateItemStatus() ; + if ( enable ) + EnableMenuItem(m_parentMenuRef , i); + else + DisableMenuItem(m_parentMenuRef , i); - if ( pItem->GetId() == idMenuTitle ) - UMAEnableMenuItem(MAC_WXHMENU(m_hMenu) , pos , false ) ; + if ( GetWXPeer()->IsSubMenu() ) + { + UMAEnableMenuItem( GetWXPeer()->GetSubMenu()->GetHMenu() , 0 , enable ) ; + } } } - // if we're already attached to the menubar, we must update it - if ( IsAttached() && GetMenuBar()->IsAttached() ) - GetMenuBar()->Refresh(); - - return true ; -} - -void wxMenu::EndRadioGroup() -{ - // we're not inside a radio group any longer - m_startRadioGroup = -1; -} - -wxMenuItem* wxMenu::DoAppend(wxMenuItem *item) -{ - wxCHECK_MSG( item, NULL, _T("NULL item in wxMenu::DoAppend") ); - - bool check = false; - - if ( item->GetKind() == wxITEM_RADIO ) + void Check( bool check ) { - int count = GetMenuItemCount(); - - if ( m_startRadioGroup == -1 ) - { - // start a new radio group - m_startRadioGroup = count; - - // for now it has just one element - item->SetAsRadioGroupStart(); - item->SetRadioGroupEnd(m_startRadioGroup); - - // ensure that we have a checked item in the radio group - check = true; - } - else // extend the current radio group + MenuItemIndex i = FindMenuItemIndex() ; + if ( i > 0 ) { - // we need to update its end item - item->SetRadioGroupStart(m_startRadioGroup); - wxMenuItemList::compatibility_iterator node = GetMenuItems().Item(m_startRadioGroup); - - if ( node ) - { - node->GetData()->SetRadioGroupEnd(count); - } + if ( check ) + ::SetItemMark( m_parentMenuRef, i, 0x12 ) ; // checkmark else - { - wxFAIL_MSG( _T("where is the radio group start item?") ); - } + ::SetItemMark( m_parentMenuRef, i, 0 ) ; // no mark } } - else // not a radio item - { - EndRadioGroup(); - } - - if ( !wxMenuBase::DoAppend(item) || !DoInsertOrAppend(item) ) - return NULL; - - if ( check ) - // check the item initially - item->Check(true); - return item; -} - -wxMenuItem* wxMenu::DoInsert(size_t pos, wxMenuItem *item) -{ - 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::compatibility_iterator node = GetMenuItems().GetFirst(); - - for ( pos = 0; node; pos++ ) + void Hide( bool hide ) { - if ( node->GetData() == item ) - break; - - node = node->GetNext(); + MenuItemIndex i = FindMenuItemIndex() ; + if ( i > 0 ) + { + if ( hide ) + ChangeMenuItemAttributes( m_parentMenuRef, i, kMenuItemAttrHidden, 0 ); + else + ChangeMenuItemAttributes( m_parentMenuRef, i, 0 , kMenuItemAttrHidden ); + } } - // DoRemove() (unlike Remove) can only be called for existing item! - wxCHECK_MSG( node, NULL, wxT("bug in wxMenu::Remove logic") ); - - ::DeleteMenuItem(MAC_WXHMENU(m_hMenu) , pos + 1); - - if ( IsAttached() && GetMenuBar()->IsAttached() ) - // otherwise, the change won't be visible - GetMenuBar()->Refresh(); - - // and from internal data structures - return wxMenuBase::DoRemove(item); -} - -void wxMenu::SetTitle(const wxString& label) -{ - m_title = label ; - UMASetMenuTitle(MAC_WXHMENU(m_hMenu) , label , wxFont::GetDefaultEncoding() ) ; -} - -bool wxMenu::ProcessCommand(wxCommandEvent & event) -{ - bool processed = false; - - // Try the menu's event handler - if ( /* !processed && */ GetEventHandler()) - processed = GetEventHandler()->SafelyProcessEvent(event); - - // Try the window the menu was popped up from - // (and up through the hierarchy) - wxWindow *win = GetInvokingWindow(); - if ( !processed && win ) - processed = win->HandleWindowEvent(event); - - return processed; -} - -// --------------------------------------------------------------------------- -// other -// --------------------------------------------------------------------------- - -wxWindow *wxMenu::GetWindow() const -{ - if ( m_invokingWindow != NULL ) - return m_invokingWindow; - 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 -// mac-wise 1 - based, i.e. the first item has index 1 whereas on MSWin it has pos 0 - -int wxMenu::MacGetIndexFromId( int id ) -{ - size_t pos; - wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst(); - for ( pos = 0; node; pos++ ) + void SetLabel( const wxString& text, wxAcceleratorEntry *entry ) { - if ( node->GetData()->GetId() == id ) - break; - - node = node->GetNext(); + MenuItemIndex i = FindMenuItemIndex() ; + if ( i > 0 ) + { + SetMenuItemTextWithCFString( m_parentMenuRef, i, wxCFStringRef(text)); + UMASetMenuItemShortcut( m_parentMenuRef, i , entry ) ; + } } - if (!node) - return 0; + void * GetHMenuItem() { return NULL; } - return pos + 1 ; -} + // Carbon Only -int wxMenu::MacGetIndexFromItem( wxMenuItem *pItem ) -{ - size_t pos; - wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst(); - for ( pos = 0; node; pos++ ) + void AttachToParent( MenuRef parentMenuRef, MenuItemIndex index ) { - if ( node->GetData() == pItem ) - break; - - node = node->GetNext(); + m_parentMenuRef = parentMenuRef; + if ( m_parentMenuRef && index > 0 ) + SetMenuItemRefCon( m_parentMenuRef, index, (URefCon) m_peer ); } - if (!node) - return 0; - - return pos + 1 ; -} - -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 ) -{ - wxMenuItem* previousItem = NULL ; - size_t pos ; - wxMenuItemList::compatibility_iterator node; - wxMenuItem *item; - - for (pos = 0, node = GetMenuItems().GetFirst(); node; node = node->GetNext(), pos++) + MenuItemIndex FindMenuItemIndex() { - item = (wxMenuItem *)node->GetData(); - wxMenu* subMenu = item->GetSubMenu() ; - if (subMenu) - { - subMenu->MacBeforeDisplay( true ) ; - } - else // normal item + MenuItemIndex hit = 0 ; + if ( m_parentMenuRef ) { - // 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 || - item->GetId() == wxApp::s_macPreferencesMenuItemId || - item->GetId() == wxApp::s_macExitMenuItemId ) - + for ( MenuItemIndex i = 1 ; i <= CountMenuItems(m_parentMenuRef) ; ++i ) { - 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() ) - { - // 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 ) + URefCon storedRef = 0; + GetMenuItemRefCon(m_parentMenuRef, i, &storedRef ); + if ( storedRef == (URefCon) m_peer ) { - // hide the separator as well - ChangeMenuItemAttributes( MAC_WXHMENU( GetHMenu() ), - posSeptoHide, - kMenuItemAttrHidden, - 0 ); + hit = i; + break; } } } - - previousItem = item ; + return hit; } +protected : + MenuRef m_parentMenuRef; +} ; - if ( isSubMenu ) - ::InsertMenu(MAC_WXHMENU( GetHMenu()), -1); -} +// +// wxMenuImpl +// -// undo all changes from the MacBeforeDisplay call -void wxMenu::MacAfterDisplay( bool isSubMenu ) +class wxMenuCarbonImpl : public wxMenuImpl { - if ( isSubMenu ) - ::DeleteMenu(MacGetMenuId()); +public : + wxMenuCarbonImpl( wxMenu* peer , MenuRef menu) : wxMenuImpl(peer), m_osxMenu(menu) + { + } - wxMenuItemList::compatibility_iterator node; - wxMenuItem *item; + virtual ~wxMenuCarbonImpl(); - for (node = GetMenuItems().GetFirst(); node; node = node->GetNext()) + virtual void InsertOrAppend(wxMenuItem *pItem, size_t pos) { - item = (wxMenuItem *)node->GetData(); - wxMenu* subMenu = item->GetSubMenu() ; - if (subMenu) + // 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 + + MenuItemIndex index = pos; + if ( pos == (size_t) -1 ) + index = CountMenuItems(m_osxMenu); + + if ( pItem->IsSeparator() ) { - subMenu->MacAfterDisplay( true ) ; + InsertMenuItemTextWithCFString( m_osxMenu, CFSTR(""), index, kMenuItemAttrSeparator, 0); + // now switch to the Carbon 1 based counting + index += 1 ; } else { - // no need to undo hidings - } - } -} - -wxInt32 wxMenu::MacHandleCommandProcess( wxMenuItem* item, int id, wxWindow* targetWindow ) -{ - OSStatus result = eventNotHandledErr ; - if (item->IsCheckable()) - item->Check( !item->IsChecked() ) ; + InsertMenuItemTextWithCFString( m_osxMenu, CFSTR("placeholder"), index, 0, 0 ); - if ( SendEvent( id , item->IsCheckable() ? item->IsChecked() : -1 ) ) - result = noErr ; - else - { - if ( targetWindow != NULL ) - { - wxCommandEvent event(wxEVT_COMMAND_MENU_SELECTED , id); - event.SetEventObject(targetWindow); - event.SetInt(item->IsCheckable() ? item->IsChecked() : -1); - - if ( targetWindow->HandleWindowEvent(event) ) - result = noErr ; + // now switch to the Carbon 1 based counting + index += 1 ; + if ( pItem->IsSubMenu() ) + { + MenuRef submenu = pItem->GetSubMenu()->GetHMenu(); + SetMenuItemHierarchicalMenu(m_osxMenu, index, submenu); + // carbon is using the title of the submenu, eg in the menubar + SetMenuTitleWithCFString(submenu, wxCFStringRef(pItem->GetItemLabelText())); + } + else + { + SetMenuItemCommandID( m_osxMenu, index , wxIdToMacCommand(pItem->GetId()) ) ; + } } - } - return result; -} - -wxInt32 wxMenu::MacHandleCommandUpdateStatus(wxMenuItem* WXUNUSED(item), - int id, - wxWindow* targetWindow) -{ - OSStatus result = eventNotHandledErr ; - wxUpdateUIEvent event(id); - event.SetEventObject( this ); - - bool processed = false; - // Try the menu's event handler - { - wxEvtHandler *handler = GetEventHandler(); - if ( handler ) - processed = handler->ProcessEvent(event); + wxMenuItemCarbonImpl* impl = (wxMenuItemCarbonImpl*) pItem->GetPeer(); + impl->AttachToParent( m_osxMenu, index ); + // only now can all settings be updated correctly + pItem->UpdateItemText(); + pItem->UpdateItemStatus(); + pItem->UpdateItemBitmap(); } - // Try the window the menu was popped up from - // (and up through the hierarchy) - if ( !processed ) + virtual void Remove( wxMenuItem *pItem ) { - const wxMenuBase *menu = this; - while ( menu ) + wxMenuItemCarbonImpl* impl = (wxMenuItemCarbonImpl*) pItem->GetPeer(); + if ( impl ) { - wxWindow *win = menu->GetInvokingWindow(); - if ( win ) + MenuItemIndex i = impl->FindMenuItemIndex(); + if ( i > 0 ) { - processed = win->HandleWindowEvent(event); - break; + DeleteMenuItem(m_osxMenu , i); + impl->AttachToParent( NULL, 0 ); } - - menu = menu->GetParent(); } } - if ( !processed && targetWindow != NULL) - { - processed = targetWindow->HandleWindowEvent(event); - } - - if ( processed ) - { - // if anything changed, update the changed attribute - if (event.GetSetText()) - SetLabel(id, event.GetText()); - if (event.GetSetChecked()) - Check(id, event.GetChecked()); - if (event.GetSetEnabled()) - Enable(id, event.GetEnabled()); - - result = noErr ; - } - return result; -} - -// Menu Bar - -/* - -Mac Implementation note : - -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 -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 -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() -{ - m_eventHandler = this; - m_menuBarFrame = NULL; - m_invokingWindow = (wxWindow*) NULL; -} - -wxMenuBar::wxMenuBar() -{ - Init(); -} - -wxMenuBar::wxMenuBar( long WXUNUSED(style) ) -{ - Init(); -} - -wxMenuBar::wxMenuBar(size_t count, wxMenu *menus[], const wxString titles[], long WXUNUSED(style)) -{ - Init(); - - m_titles.Alloc(count); - - for ( size_t i = 0; i < count; i++ ) - { - m_menus.Append(menus[i]); - m_titles.Add(titles[i]); - - menus[i]->Attach(this); - } -} - -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)) -{ - wxCHECK_RET( IsAttached(), wxT("can't refresh unatteched menubar") ); - - DrawMenuBar(); -} - -void wxMenuBar::MacInstallMenuBar() -{ - if ( s_macInstalledMenuBar == this ) - return ; - - MenuBarHandle menubar = NULL ; - - menubar = NewHandleClear( 6 /* sizeof( MenuBarHeader ) */ ) ; - - ::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 - InsertMenuItemTextWithCFString( appleMenu, - CFSTR(""), 0, kMenuItemAttrSeparator, 0); - 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( helpMenuHandle ) ; i >= firstUserHelpMenuItem ; --i ) - DeleteMenuItem( helpMenuHandle , i ) ; - } - else + virtual void MakeRoot() { - helpMenuHandle = NULL ; + SetRootMenu( m_osxMenu ); } - if ( wxApp::s_macPreferencesMenuItemId) + virtual void SetTitle( const wxString& text ) { - wxMenuItem *item = FindItem( wxApp::s_macPreferencesMenuItemId , NULL ) ; - if ( item == NULL || !(item->IsEnabled()) ) - DisableMenuCommand( NULL , kHICommandPreferences ) ; - else - EnableMenuCommand( NULL , kHICommandPreferences ) ; + SetMenuTitleWithCFString(m_osxMenu, wxCFStringRef(text)); } - // 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 ( wxApp::s_macExitMenuItemId) - { - wxMenuItem *item = FindItem( wxApp::s_macExitMenuItemId , NULL ) ; - if ( item != NULL && !(item->IsEnabled()) ) - DisableMenuCommand( NULL , kHICommandQuit ) ; - else - EnableMenuCommand( NULL , kHICommandQuit ) ; - } + WXHMENU GetHMenu() { return m_osxMenu; } - 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()) + virtual void PopUp( wxWindow *WXUNUSED(win), int x, int y ) { - wxMenuItemList::compatibility_iterator node; - wxMenuItem *item; - wxMenu* menu = menuIter->GetData() , *subMenu = NULL ; - wxString strippedMenuTitle = wxStripMenuCodes(m_titles[i]); - - if ( strippedMenuTitle == wxT("?") || strippedMenuTitle == strippedHelpMenuTitle || strippedMenuTitle == strippedTranslatedHelpMenuTitle ) - { - for (node = menu->GetMenuItems().GetFirst(); node; node = node->GetNext()) - { - item = (wxMenuItem *)node->GetData(); - subMenu = item->GetSubMenu() ; - if (subMenu) - { - // we don't support hierarchical menus in the help menu yet - } - 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 ( helpMenuHandle ) - AppendMenuItemTextWithCFString( helpMenuHandle, - CFSTR(""), kMenuItemAttrSeparator, 0,NULL); - } - else - { - wxAcceleratorEntry* - entry = wxAcceleratorEntry::Create( item->GetItemLabel() ) ; - - if ( item->GetId() == wxApp::s_macAboutMenuItemId ) - { - // this will be taken care of below - } - else - { - if ( helpMenuHandle ) - { - UMAAppendMenuItem(helpMenuHandle, wxStripMenuCodes(item->GetItemLabel()) , 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() ) + long menuResult = ::PopUpMenuSelect(m_osxMenu, y, x, 0) ; + if ( HiWord(menuResult) != 0 ) { - if ( MacGetWindowMenuHMenu() == NULL ) + MenuCommand macid; + GetMenuItemCommandID( GetMenuHandle(HiWord(menuResult)) , LoWord(menuResult) , &macid ); + int id = wxMacCommandToId( macid ); + wxMenuItem* item = NULL ; + wxMenu* realmenu ; + item = m_peer->FindItem( id, &realmenu ) ; + if ( item ) { - CreateStandardWindowMenu( 0 , (MenuHandle*) &s_macWindowMenuHandle ) ; + m_peer->HandleCommandProcess(item, NULL ); } - - 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], GetFont().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->GetItemLabel() ) ; - UMASetMenuItemText( GetMenuHandle( kwxMacAppleMenuId ) , 1 , wxStripMenuCodes ( aboutMenuItem->GetItemLabel() ) , wxFont::GetDefaultEncoding() ); - UMAEnableMenuItem( GetMenuHandle( kwxMacAppleMenuId ) , 1 , true ); - SetMenuItemCommandID( GetMenuHandle( kwxMacAppleMenuId ) , 1 , kHICommandAbout ) ; - SetMenuItemRefCon(GetMenuHandle( kwxMacAppleMenuId ) , 1 , (URefCon)aboutMenuItem ) ; - UMASetMenuItemShortcut( GetMenuHandle( kwxMacAppleMenuId ) , 1 , entry ) ; - - delete entry; } } - if ( GetAutoWindowMenu() ) - { - if ( MacGetWindowMenuHMenu() == NULL ) - CreateStandardWindowMenu( 0 , (MenuHandle*) &s_macWindowMenuHandle ) ; - - InsertMenu( (MenuHandle) MacGetWindowMenuHMenu() , 0 ) ; - } - - ::DrawMenuBar() ; - s_macInstalledMenuBar = this; -} - -void wxMenuBar::EnableTop(size_t pos, bool enable) -{ - wxCHECK_RET( IsAttached(), wxT("doesn't work with unattached menubars") ); - - _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; -} + static wxMenuImpl* Create( wxMenu* peer, const wxString& title ); + static wxMenuImpl* CreateRootMenu( wxMenu* peer ); +protected : + wxCFRef m_osxMenu; +} ; -void wxMenuBar::SetMenuLabel(size_t pos, const wxString& label) -{ - wxCHECK_RET( pos < GetMenuCount(), wxT("invalid menu index") ); +// static const short kwxMacAppleMenuId = 1 ; - m_titles[pos] = label; - - if ( !IsAttached() ) - return; +// Find an item given the Macintosh Menu Reference - _wxMenuAt(m_menus, pos)->SetTitle( label ) ; +WX_DECLARE_HASH_MAP(WXHMENU, wxMenu*, wxPointerHash, wxPointerEqual, MacMenuMap); - if (wxMenuBar::s_macInstalledMenuBar == this) // are we currently installed ? - { - ::SetMenuBar( GetMenuBar() ) ; - ::InvalMenuBar() ; - } -} +static MacMenuMap wxWinMacMenuList; -wxString wxMenuBar::GetMenuLabel(size_t pos) const +wxMenu *wxFindMenuFromMacMenu(WXHMENU inMenuRef) { - wxCHECK_MSG( pos < GetMenuCount(), wxEmptyString, - wxT("invalid menu index in wxMenuBar::GetMenuLabel") ); + MacMenuMap::iterator node = wxWinMacMenuList.find(inMenuRef); - return m_titles[pos]; + return (node == wxWinMacMenuList.end()) ? NULL : node->second; } -int wxMenuBar::FindMenu(const wxString& title) +void wxAssociateMenuWithMacMenu(WXHMENU inMenuRef, wxMenu *menu) ; +void wxAssociateMenuWithMacMenu(WXHMENU inMenuRef, wxMenu *menu) { - wxString menuTitle = wxStripMenuCodes(title); - - size_t count = GetMenuCount(); - for ( size_t i = 0; i < count; i++ ) - { - wxString title = wxStripMenuCodes(m_titles[i]); - if ( menuTitle == title ) - return i; - } + // adding NULL MenuRef is (first) surely a result of an error and + // (secondly) breaks menu command processing + wxCHECK_RET( inMenuRef != (WXHMENU) NULL, wxT("attempt to add a NULL MenuRef to menu list") ); - return wxNOT_FOUND; + wxWinMacMenuList[inMenuRef] = menu; } -// --------------------------------------------------------------------------- -// wxMenuBar construction -// --------------------------------------------------------------------------- - -wxMenu *wxMenuBar::Replace(size_t pos, wxMenu *menu, const wxString& title) +void wxRemoveMacMenuAssociation(wxMenu *menu) ; +void wxRemoveMacMenuAssociation(wxMenu *menu) { - wxMenu *menuOld = wxMenuBarBase::Replace(pos, menu, title); - if ( !menuOld ) - return NULL; - - m_titles[pos] = title; - - if ( IsAttached() ) + // iterate over all the elements in the class + MacMenuMap::iterator it; + for ( it = wxWinMacMenuList.begin(); it != wxWinMacMenuList.end(); ++it ) { - if (s_macInstalledMenuBar == this) + if ( it->second == menu ) { - menuOld->MacAfterDisplay( false ) ; - ::DeleteMenu( menuOld->MacGetMenuId() /* m_menus[pos]->MacGetMenuId() */ ) ; - - menu->MacBeforeDisplay( false ) ; - UMASetMenuTitle( MAC_WXHMENU(menu->GetHMenu()) , title , GetFont().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() ) ; + wxWinMacMenuList.erase(it); + break; } - - Refresh(); } - - if (m_invokingWindow) - wxMenubarSetInvokingWindow( menu, m_invokingWindow ); - - return menuOld; } -bool wxMenuBar::Insert(size_t pos, wxMenu *menu, const wxString& title) +wxMenuCarbonImpl::~wxMenuCarbonImpl() { - if ( !wxMenuBarBase::Insert(pos, menu, title) ) - return false; - - m_titles.Insert(title, pos); - - UMASetMenuTitle( MAC_WXHMENU(menu->GetHMenu()) , title , GetFont().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()) , _wxMenuAt(m_menus, pos+1)->MacGetMenuId() ) ; - } - - Refresh(); - } - - if (m_invokingWindow) - wxMenubarSetInvokingWindow( menu, m_invokingWindow ); - - return true; + wxRemoveMacMenuAssociation( GetWXPeer() ); } -wxMenu *wxMenuBar::Remove(size_t pos) +wxMenuImpl* wxMenuImpl::Create( wxMenu* peer, const wxString& title ) { - wxMenu *menu = wxMenuBarBase::Remove(pos); + // create the menu + static SInt16 s_macNextMenuId = 3; + WXHMENU menu = NULL; + CreateNewMenu( s_macNextMenuId++ , 0 , &menu ) ; if ( !menu ) - return NULL; - - if ( IsAttached() ) { - if (s_macInstalledMenuBar == this) - ::DeleteMenu( menu->MacGetMenuId() /* m_menus[pos]->MacGetMenuId() */ ) ; - - Refresh(); + wxLogLastError(wxT("CreateNewMenu failed")); + return NULL; } - m_titles.RemoveAt(pos); - - return menu; + wxMenuImpl* c = new wxMenuCarbonImpl( peer, menu ); + c->SetTitle(title); + wxAssociateMenuWithMacMenu( menu , peer ) ; + return c; } -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") ); - - if ( !wxMenuBarBase::Append(menu, title) ) - return false; - - m_titles.Add(title); +// +// +// - UMASetMenuTitle( MAC_WXHMENU(menu->GetHMenu()) , title , GetFont().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 - // adding menu later on. - if (m_invokingWindow) - wxMenubarSetInvokingWindow( menu, m_invokingWindow ); - - return true; -} - -static void wxMenubarUnsetInvokingWindow( wxMenu *menu ) +wxMenuItemCarbonImpl::~wxMenuItemCarbonImpl() { - menu->SetInvokingWindow( (wxWindow*) NULL ); - wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst(); - - while (node) - { - wxMenuItem *menuitem = node->GetData(); - if (menuitem->IsSubMenu()) - wxMenubarUnsetInvokingWindow( menuitem->GetSubMenu() ); - - node = node->GetNext(); - } } -static void wxMenubarSetInvokingWindow( wxMenu *menu, wxWindow *win ) -{ - menu->SetInvokingWindow( win ); - wxMenuItem *menuitem; - wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst(); - while (node) - { - menuitem = node->GetData(); - if (menuitem->IsSubMenu()) - wxMenubarSetInvokingWindow( menuitem->GetSubMenu() , win ); - - node = node->GetNext(); - } -} - -void wxMenuBar::UnsetInvokingWindow() +wxMenuItemImpl* wxMenuItemImpl::Create( wxMenuItem* peer, + wxMenu * WXUNUSED(pParentMenu), + int WXUNUSED(id), + const wxString& WXUNUSED(text), + wxAcceleratorEntry *WXUNUSED(entry), + const wxString& WXUNUSED(strHelp), + wxItemKind WXUNUSED(kind), + wxMenu *WXUNUSED(pSubMenu) ) { - m_invokingWindow = (wxWindow*) NULL; - wxMenu *menu; - wxMenuList::compatibility_iterator node = m_menus.GetFirst(); - - while (node) - { - menu = node->GetData(); - wxMenubarUnsetInvokingWindow( menu ); + wxMenuItemImpl* c = NULL; - node = node->GetNext(); - } + c = new wxMenuItemCarbonImpl( peer ); + return c; } -void wxMenuBar::SetInvokingWindow(wxFrame *frame) +void wxInsertMenuItemsInMenu(wxMenu* menu, MenuRef wm, MenuItemIndex insertAfter) { - m_invokingWindow = frame; - wxMenu *menu; - wxMenuList::compatibility_iterator node = m_menus.GetFirst(); + wxMenuItemList::compatibility_iterator node; + wxMenuItem *item; + wxMenu *subMenu = NULL ; + bool newItems = false; - while (node) + for (node = menu->GetMenuItems().GetFirst(); node; node = node->GetNext()) { - menu = node->GetData(); - wxMenubarSetInvokingWindow( menu, frame ); - - 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); -void wxMenuBar::Detach() -{ - wxMenuBarBase::Detach() ; -} + newItems = false; + } + else + { + wxAcceleratorEntry* + entry = wxAcceleratorEntry::Create( item->GetItemLabel() ) ; -void wxMenuBar::Attach(wxFrame *frame) -{ - wxMenuBarBase::Attach( frame ) ; -} + MenuItemIndex winListPos = (MenuItemIndex)-1; + OSStatus err = GetIndMenuItemWithCommandID(wm, + wxIdToMacCommand ( item->GetId() ), 1, NULL, &winListPos); -// --------------------------------------------------------------------------- -// wxMenuBar searching for menu items -// --------------------------------------------------------------------------- + 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->GetItemLabel()) , wxFont::GetDefaultEncoding(), insertAfter, entry); + SetMenuItemCommandID( wm , insertAfter+1 , wxIdToMacCommand ( item->GetId() ) ) ; + SetMenuItemRefCon( wm , insertAfter+1 , (URefCon) item ) ; + } -// Find the itemString in menuString, and return the item id or wxNOT_FOUND -int wxMenuBar::FindMenuItem(const wxString& menuString, - const wxString& itemString) const -{ - wxString menuLabel = wxStripMenuCodes(menuString); - size_t count = GetMenuCount(); - for ( size_t i = 0; i < count; i++ ) - { - wxString title = wxStripMenuCodes(m_titles[i]); - if ( menuLabel == title ) - return _wxMenuAt(m_menus, i)->FindItem(itemString); + delete entry ; + } } - - return wxNOT_FOUND; } -wxMenuItem *wxMenuBar::FindItem(int id, wxMenu **itemMenu) const -{ - if ( itemMenu ) - *itemMenu = NULL; - - wxMenuItem *item = NULL; - size_t count = GetMenuCount(); - for ( size_t i = 0; !item && (i < count); i++ ) - item = _wxMenuAt(m_menus, i)->FindItem(id, itemMenu); - return item; -}