X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e9576ca53db96b462ed4c0b4bdf47d64c40203e4..a201463482dc4417592ee014ff1a9706e8971dd6:/src/mac/carbon/menu.cpp diff --git a/src/mac/carbon/menu.cpp b/src/mac/carbon/menu.cpp index 1fc7c4a229..b790e19ccf 100644 --- a/src/mac/carbon/menu.cpp +++ b/src/mac/carbon/menu.cpp @@ -1,571 +1,1114 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: menu.cpp +// Name: src/mac/carbon/menu.cpp // Purpose: wxMenu, wxMenuBar, wxMenuItem -// Author: AUTHOR +// Author: Stefan Csomor // Modified by: -// Created: ??/??/98 +// Created: 1998-01-01 // RCS-ID: $Id$ -// Copyright: (c) AUTHOR -// Licence: wxWindows licence +// Copyright: (c) Stefan Csomor +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// - // ============================================================================ // headers & declarations // ============================================================================ -// wxWindows headers +// wxWidgets headers // ----------------- -#ifdef __GNUG__ -#pragma implementation "menu.h" -#pragma implementation "menuitem.h" -#endif +#include "wx/wxprec.h" #include "wx/menu.h" -#include "wx/menuitem.h" -#include "wx/log.h" -#include "wx/utils.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" // other standard headers // ---------------------- #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 = -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) +{ + // 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 // ============================================================================ +static void wxMenubarUnsetInvokingWindow( wxMenu *menu ) ; +static void wxMenubarSetInvokingWindow( wxMenu *menu, wxWindow *win ); // Menus // Construct a menu with optional title (then use append) -wxMenu::wxMenu(const wxString& title, const wxFunction func) + +#ifdef __DARWIN__ +short wxMenu::s_macNextMenuId = 3 ; +#else +short wxMenu::s_macNextMenuId = 2 ; +#endif + +static +wxMenu * +_wxMenuAt(const wxMenuList &menuList, size_t pos) { - m_title = title; - m_parent = NULL; - m_eventHandler = this; - m_noItems = 0; - m_menuBar = NULL; - m_clientData = (void*) NULL; - if (m_title != "") - { - Append(-2, m_title) ; - AppendSeparator() ; - } + wxMenuList::compatibility_iterator menuIter = menuList.GetFirst(); - Callback(func); + while (pos-- > 0) + menuIter = menuIter->GetNext(); - // TODO create menu + return menuIter->GetData() ; } -// The wxWindow destructor will take care of deleting the submenus. -wxMenu::~wxMenu() +void wxMenu::Init() { - // TODO destroy menu and children + m_doBreak = false; + m_startRadioGroup = -1; - wxNode *node = m_menuItems.First(); - while (node) + // create the menu + m_macMenuId = s_macNextMenuId++; + m_hMenu = UMANewMenu(m_macMenuId, m_title, wxFont::GetDefaultEncoding() ); + + if ( !m_hMenu ) { - wxMenuItem *item = (wxMenuItem *)node->Data(); + wxLogLastError(wxT("UMANewMenu failed")); + } - // Delete child menus. - // Beware: they must not be appended to children list!!! - // (because order of delete is significant) - if (item->GetSubMenu()) - item->DeleteSubMenu(); + wxAssociateMenuWithMacMenu( (MenuRef)m_hMenu , this ) ; - wxNode *next = node->Next(); - delete item; - delete node; - node = next; + // 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() { - // TODO + // 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 -void wxMenu::Append(wxMenuItem *pItem) +// append a new item or submenu to the menu +bool wxMenu::DoInsertOrAppend(wxMenuItem *pItem, size_t pos) { - // TODO + wxASSERT_MSG( pItem != NULL, wxT("can't append NULL item to the menu") ); - wxCHECK_RET( pItem != NULL, "can't append NULL item to the menu" ); + if ( pItem->IsSeparator() ) + { + 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 ) + { + wxASSERT_MSG( pSubMenu->m_hMenu != NULL , wxT("invalid submenu added")); + pSubMenu->m_menuParent = this ; - m_menuItems.Append(pItem); + if (wxMenuBar::MacGetInstalledMenuBar() == GetMenuBar()) + pSubMenu->MacBeforeDisplay( true ) ; - m_noItems++; -} + if ( pos == (size_t)-1 ) + UMAAppendSubMenuItem(MAC_WXHMENU(m_hMenu), wxStripMenuCodes(pItem->GetText()), wxFont::GetDefaultEncoding(), pSubMenu->m_macMenuId); + else + UMAInsertSubMenuItem(MAC_WXHMENU(m_hMenu), wxStripMenuCodes(pItem->GetText()), wxFont::GetDefaultEncoding(), pos, pSubMenu->m_macMenuId); -void wxMenu::AppendSeparator() -{ - // TODO - Append(new wxMenuItem(this, ID_SEPARATOR)); -} + pItem->UpdateItemBitmap() ; + pItem->UpdateItemStatus() ; + } + else + { + if ( pos == (size_t)-1 ) + { + UMAAppendMenuItem(MAC_WXHMENU(m_hMenu), wxT("a") , wxFont::GetDefaultEncoding() ); + pos = CountMenuItems(MAC_WXHMENU(m_hMenu)) ; + } + else + { + // 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 , wxIdToMacCommand ( pItem->GetId() ) ) ; + SetMenuItemRefCon( MAC_WXHMENU(m_hMenu) , pos , (URefCon) pItem ) ; + pItem->UpdateItemText() ; + pItem->UpdateItemBitmap() ; + pItem->UpdateItemStatus() ; + + if ( pItem->GetId() == idMenuTitle ) + UMAEnableMenuItem(MAC_WXHMENU(m_hMenu) , pos , false ) ; + } + } -// Pullright item -void wxMenu::Append(int Id, const wxString& label, wxMenu *SubMenu, - const wxString& helpString) -{ - Append(new wxMenuItem(this, Id, label, helpString, FALSE, SubMenu)); + // if we're already attached to the menubar, we must update it + if ( IsAttached() && GetMenuBar()->IsAttached() ) + GetMenuBar()->Refresh(); + + return true ; } -// Ordinary menu item -void wxMenu::Append(int Id, const wxString& label, - const wxString& helpString, bool checkable) +void wxMenu::EndRadioGroup() { - // 'checkable' parameter is useless for Windows. - Append(new wxMenuItem(this, Id, label, helpString, checkable)); + // we're not inside a radio group any longer + m_startRadioGroup = -1; } -void wxMenu::Delete(int id) +wxMenuItem* wxMenu::DoAppend(wxMenuItem *item) { - wxNode *node; - wxMenuItem *item; - int pos; + wxCHECK_MSG( item, NULL, _T("NULL item in wxMenu::DoAppend") ); + + bool check = false; + + if ( item->GetKind() == wxITEM_RADIO ) + { + int count = GetMenuItemCount(); - for (pos = 0, node = m_menuItems.First(); node; node = node->Next(), pos++) { - item = (wxMenuItem *)node->Data(); - if (item->GetId() == id) - break; + 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 + { + // 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); + } + else + { + wxFAIL_MSG( _T("where is the radio group start item?") ); + } + } + } + else // not a radio item + { + EndRadioGroup(); } - if (!node) - return; + if ( !wxMenuBase::DoAppend(item) || !DoInsertOrAppend(item) ) + return NULL; - m_menuItems.DeleteNode(node); - delete item; + if ( check ) + // check the item initially + item->Check(true); - // TODO + return item; } -void wxMenu::Enable(int Id, bool Flag) +wxMenuItem* wxMenu::DoInsert(size_t pos, wxMenuItem *item) { - wxMenuItem *item = FindItemForId(Id); - wxCHECK_RET( item != NULL, "can't enable non-existing menu item" ); + if (wxMenuBase::DoInsert(pos, item) && DoInsertOrAppend(item, pos)) + return item; - item->Enable(Flag); + return NULL; } -bool wxMenu::Enabled(int Id) const +wxMenuItem *wxMenu::DoRemove(wxMenuItem *item) { - wxMenuItem *item = FindItemForId(Id); - wxCHECK( item != NULL, FALSE ); + // we need to find the items position in the child list + size_t pos; + wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst(); - return item->IsEnabled(); -} + for ( pos = 0; node; pos++ ) + { + if ( node->GetData() == item ) + break; -void wxMenu::Check(int Id, bool Flag) -{ - wxMenuItem *item = FindItemForId(Id); - wxCHECK_RET( item != NULL, "can't get status of non-existing menu item" ); + node = node->GetNext(); + } - item->Check(Flag); -} + // DoRemove() (unlike Remove) can only be called for existing item! + wxCHECK_MSG( node, NULL, wxT("bug in wxMenu::Remove logic") ); -bool wxMenu::Checked(int Id) const -{ - wxMenuItem *item = FindItemForId(Id); - wxCHECK( item != NULL, FALSE ); + ::DeleteMenuItem(MAC_WXHMENU(m_hMenu) , pos + 1); + + if ( IsAttached() && GetMenuBar()->IsAttached() ) + // otherwise, the change won't be visible + GetMenuBar()->Refresh(); - return item->IsChecked(); + // and from internal data structures + return wxMenuBase::DoRemove(item); } void wxMenu::SetTitle(const wxString& label) { m_title = label ; - // TODO + UMASetMenuTitle(MAC_WXHMENU(m_hMenu) , label , wxFont::GetDefaultEncoding() ) ; } -const wxString wxMenu::GetTitle() const +bool wxMenu::ProcessCommand(wxCommandEvent & event) { - return m_title; + bool processed = false; + + // Try the menu's event handler + if ( /* !processed && */ GetEventHandler()) + processed = GetEventHandler()->ProcessEvent(event); + + // 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); + + return processed; } -void wxMenu::SetLabel(int id, const wxString& label) +// --------------------------------------------------------------------------- +// other +// --------------------------------------------------------------------------- + +wxWindow *wxMenu::GetWindow() const { - wxMenuItem *item = FindItemForId(id) ; - if (item==NULL) - return; + if ( m_invokingWindow != NULL ) + return m_invokingWindow; + else if ( GetMenuBar() != NULL) + return (wxWindow *) GetMenuBar()->GetFrame(); + + return NULL; +} - if (item->GetSubMenu()==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++ ) { - // TODO + if ( node->GetData()->GetId() == id ) + break; + + node = node->GetNext(); } - else + + if (!node) + return 0; + + return pos + 1 ; +} + +int wxMenu::MacGetIndexFromItem( wxMenuItem *pItem ) +{ + size_t pos; + wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst(); + for ( pos = 0; node; pos++ ) { - // TODO + if ( node->GetData() == pItem ) + break; + + node = node->GetNext(); } - item->SetName(label); + + if (!node) + return 0; + + return pos + 1 ; } -wxString wxMenu::GetLabel(int Id) const +void wxMenu::MacEnableMenu( bool bDoEnable ) { - // TODO - return wxString("") ; + UMAEnableMenuItem(MAC_WXHMENU(m_hMenu) , 0 , bDoEnable ) ; + + ::DrawMenuBar() ; } -// Finds the item id matching the given string, -1 if not found. -int wxMenu::FindItem (const wxString& itemString) const +// 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 ) { - char buf1[200]; - char buf2[200]; - wxStripMenuCodes ((char *)(const char *)itemString, buf1); + wxMenuItem* previousItem = NULL ; + size_t pos ; + wxMenuItemList::compatibility_iterator node; + wxMenuItem *item; - for (wxNode * node = m_menuItems.First (); node; node = node->Next ()) + for (pos = 0, node = GetMenuItems().GetFirst(); node; node = node->GetNext(), pos++) { - wxMenuItem *item = (wxMenuItem *) node->Data (); - if (item->GetSubMenu()) - { - int ans = item->GetSubMenu()->FindItem(itemString); - if (ans > -1) - return ans; - } - if ( !item->IsSeparator() ) - { - wxStripMenuCodes((char *)item->GetName().c_str(), buf2); - if (strcmp(buf1, buf2) == 0) - return item->GetId(); - } + item = (wxMenuItem *)node->GetData(); + wxMenu* subMenu = item->GetSubMenu() ; + if (subMenu) + { + subMenu->MacBeforeDisplay( true ) ; + } + else // normal item + { +#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 ) ) ) + + { + 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 ) + { + // hide the separator as well + ChangeMenuItemAttributes( MAC_WXHMENU( GetHMenu() ), + posSeptoHide, + kMenuItemAttrHidden, + 0 ); + } + } +#endif // TARGET_CARBON + } + + previousItem = item ; } - return -1; + if ( isSubMenu ) + ::InsertMenu(MAC_WXHMENU( GetHMenu()), -1); } -wxMenuItem *wxMenu::FindItemForId(int itemId, wxMenu ** itemMenu) const +// undo all changes from the MacBeforeDisplay call +void wxMenu::MacAfterDisplay( bool isSubMenu ) { - if (itemMenu) - *itemMenu = NULL; - for (wxNode * node = m_menuItems.First (); node; node = node->Next ()) - { - wxMenuItem *item = (wxMenuItem *) node->Data (); + if ( isSubMenu ) + ::DeleteMenu(MacGetMenuId()); + + wxMenuItemList::compatibility_iterator node; + wxMenuItem *item; - if (item->GetId() == itemId) + for (node = GetMenuItems().GetFirst(); node; node = node->GetNext()) + { + item = (wxMenuItem *)node->GetData(); + wxMenu* subMenu = item->GetSubMenu() ; + if (subMenu) { - if (itemMenu) - *itemMenu = (wxMenu *) this; - return item; + subMenu->MacAfterDisplay( true ) ; } - - if (item->GetSubMenu()) + else { - wxMenuItem *ans = item->GetSubMenu()->FindItemForId (itemId, itemMenu); - if (ans) - return ans; + // no need to undo hidings } } +} - if (itemMenu) - *itemMenu = NULL; - return NULL; +// 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; } -void wxMenu::SetHelpString(int itemId, const wxString& helpString) +wxMenuBar::wxMenuBar() { - wxMenuItem *item = FindItemForId (itemId); - if (item) - item->SetHelp(helpString); + Init(); } -wxString wxMenu::GetHelpString (int itemId) const +wxMenuBar::wxMenuBar( long WXUNUSED(style) ) { - wxMenuItem *item = FindItemForId (itemId); - wxString str(""); - return (item == NULL) ? str : item->GetHelp(); + Init(); } -void wxMenu::ProcessCommand(wxCommandEvent & event) +wxMenuBar::wxMenuBar(size_t count, wxMenu *menus[], const wxString titles[], long WXUNUSED(style)) { - bool processed = FALSE; + Init(); - // Try a callback - if (m_callback) - { - (void) (*(m_callback)) (*this, event); - processed = TRUE; - } + m_titles.Alloc(count); - // Try the menu's event handler - if ( !processed && GetEventHandler()) + for ( size_t i = 0; i < count; i++ ) { - processed = GetEventHandler()->ProcessEvent(event); + m_menus.Append(menus[i]); + m_titles.Add(titles[i]); + + menus[i]->Attach(this); } -/* TODO - // Try the window the menu was popped up from (and up - // through the hierarchy) - if ( !processed && GetInvokingWindow()) - processed = GetInvokingWindow()->ProcessEvent(event); -*/ } -bool wxWindow::PopupMenu(wxMenu *menu, int x, int y) +wxMenuBar::~wxMenuBar() { - // TODO - return FALSE; + if (s_macCommonMenuBar == this) + s_macCommonMenuBar = NULL; + + if (s_macInstalledMenuBar == this) + { + ::ClearMenuBar(); + s_macInstalledMenuBar = NULL; + } } -// Menu Bar -wxMenuBar::wxMenuBar() +void wxMenuBar::Refresh(bool WXUNUSED(eraseBackground), const wxRect *WXUNUSED(rect)) { - m_eventHandler = this; - m_menuCount = 0; - m_menus = NULL; - m_titles = NULL; - m_menuBarFrame = NULL; + wxCHECK_RET( IsAttached(), wxT("can't refresh unatteched menubar") ); - // TODO + DrawMenuBar(); } -wxMenuBar::wxMenuBar(int n, wxMenu *menus[], const wxString titles[]) +void wxMenuBar::MacInstallMenuBar() { - m_eventHandler = this; - m_menuCount = n; - m_menus = menus; - m_titles = new wxString[n]; - int i; - for ( i = 0; i < n; i++ ) - m_titles[i] = titles[i]; - m_menuBarFrame = NULL; + if ( s_macInstalledMenuBar == this ) + return ; - // TODO -} + MenuBarHandle menubar = NULL ; -wxMenuBar::~wxMenuBar() -{ - int i; - for (i = 0; i < m_menuCount; i++) +#if TARGET_API_MAC_OSX + menubar = NewHandleClear( 6 /* sizeof( MenuBarHeader ) */ ) ; +#else + menubar = NewHandleClear( 12 ) ; + (*menubar)[3] = 0x0a ; +#endif + + ::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 + 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 ) { - delete m_menus[i]; + for ( int i = CountMenuItems( helpMenuHandle ) ; i >= firstUserHelpMenuItem ; --i ) + DeleteMenuItem( helpMenuHandle , i ) ; + } + else + { + helpMenuHandle = NULL ; + } + +#if TARGET_CARBON + if ( UMAGetSystemVersion() >= 0x1000 && wxApp::s_macPreferencesMenuItemId) + { + wxMenuItem *item = FindItem( wxApp::s_macPreferencesMenuItemId , NULL ) ; + if ( item == NULL || !(item->IsEnabled()) ) + DisableMenuCommand( NULL , kHICommandPreferences ) ; + 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 + + 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; + 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->GetText() ) ; + + if ( item->GetId() == wxApp::s_macAboutMenuItemId ) + { + // this will be taken care of below + } + else + { + if ( helpMenuHandle ) + { + 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_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 ) ; + } } - delete[] m_menus; - delete[] m_titles; - // TODO + if ( GetAutoWindowMenu() ) + { + if ( MacGetWindowMenuHMenu() == NULL ) + CreateStandardWindowMenu( 0 , (MenuHandle*) &s_macWindowMenuHandle ) ; + + InsertMenu( (MenuHandle) MacGetWindowMenuHMenu() , 0 ) ; + } + + ::DrawMenuBar() ; + s_macInstalledMenuBar = this; } -// Must only be used AFTER menu has been attached to frame, -// otherwise use individual menus to enable/disable items -void wxMenuBar::Enable(int id, bool flag) +void wxMenuBar::EnableTop(size_t pos, bool enable) { - wxMenu *itemMenu = NULL; - wxMenuItem *item = FindItemForId(id, &itemMenu) ; - if (!item) - return; + wxCHECK_RET( IsAttached(), wxT("doesn't work with unattached menubars") ); - // TODO + _wxMenuAt(m_menus, pos)->MacEnableMenu( enable ) ; + Refresh(); } -void wxMenuBar::EnableTop(int pos, bool flag) +bool wxMenuBar::Enable(bool enable) { - // TODO + 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; } -// Must only be used AFTER menu has been attached to frame, -// otherwise use individual menus -void wxMenuBar::Check(int id, bool flag) +void wxMenuBar::SetLabelTop(size_t pos, const wxString& label) { - wxMenu *itemMenu = NULL; - wxMenuItem *item = FindItemForId(id, &itemMenu) ; - if (!item) + wxCHECK_RET( pos < GetMenuCount(), wxT("invalid menu index") ); + + m_titles[pos] = label; + + if ( !IsAttached() ) return; - if (!item->IsCheckable()) - return ; + _wxMenuAt(m_menus, pos)->SetTitle( label ) ; - // TODO + if (wxMenuBar::s_macInstalledMenuBar == this) // are we currently installed ? + { + ::SetMenuBar( GetMenuBar() ) ; + ::InvalMenuBar() ; + } } -bool wxMenuBar::Checked(int id) const +wxString wxMenuBar::GetLabelTop(size_t pos) const { - wxMenu *itemMenu = NULL; - wxMenuItem *item = FindItemForId(id, &itemMenu) ; - if (!item) - return FALSE; + wxCHECK_MSG( pos < GetMenuCount(), wxEmptyString, + wxT("invalid menu index in wxMenuBar::GetLabelTop") ); - // TODO - return FALSE; + return m_titles[pos]; } -bool wxMenuBar::Enabled(int id) const +int wxMenuBar::FindMenu(const wxString& title) { - wxMenu *itemMenu = NULL; - wxMenuItem *item = FindItemForId(id, &itemMenu) ; - if (!item) - return FALSE; + wxString menuTitle = wxStripMenuCodes(title); - // TODO - return FALSE ; + size_t count = GetMenuCount(); + for ( size_t i = 0; i < count; i++ ) + { + wxString title = wxStripMenuCodes(m_titles[i]); + if ( menuTitle == title ) + return i; + } + + return wxNOT_FOUND; } +// --------------------------------------------------------------------------- +// wxMenuBar construction +// --------------------------------------------------------------------------- -void wxMenuBar::SetLabel(int id, const wxString& label) +wxMenu *wxMenuBar::Replace(size_t pos, wxMenu *menu, const wxString& title) { - wxMenu *itemMenu = NULL; - wxMenuItem *item = FindItemForId(id, &itemMenu) ; + wxMenu *menuOld = wxMenuBarBase::Replace(pos, menu, title); + if ( !menuOld ) + return NULL; - if (!item) - return; + m_titles[pos] = title; - // TODO -} + if ( IsAttached() ) + { + if (s_macInstalledMenuBar == this) + { + menuOld->MacAfterDisplay( false ) ; + ::DeleteMenu( menuOld->MacGetMenuId() /* m_menus[pos]->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() ) ; + } -wxString wxMenuBar::GetLabel(int id) const -{ - wxMenu *itemMenu = NULL; - wxMenuItem *item = FindItemForId(id, &itemMenu) ; + Refresh(); + } - if (!item) - return wxString(""); + if (m_invokingWindow) + wxMenubarSetInvokingWindow( menu, m_invokingWindow ); - // TODO - return wxString("") ; + return menuOld; } -void wxMenuBar::SetLabelTop(int pos, const wxString& label) +bool wxMenuBar::Insert(size_t pos, wxMenu *menu, const wxString& title) { - // TODO -} + if ( !wxMenuBarBase::Insert(pos, menu, title) ) + return false; -wxString wxMenuBar::GetLabelTop(int pos) const -{ - // TODO - return wxString(""); -} + m_titles.Insert(title, pos); -bool wxMenuBar::OnDelete(wxMenu *a_menu, int pos) -{ - // TODO - return FALSE; -} + UMASetMenuTitle( MAC_WXHMENU(menu->GetHMenu()) , title , m_font.GetEncoding() ) ; -bool wxMenuBar::OnAppend(wxMenu *a_menu, const char *title) -{ - // TODO - return FALSE; + 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; } -void wxMenuBar::Append (wxMenu * menu, const wxString& title) +wxMenu *wxMenuBar::Remove(size_t pos) { - if (!OnAppend(menu, title)) - return; - - m_menuCount ++; - wxMenu **new_menus = new wxMenu *[m_menuCount]; - wxString *new_titles = new wxString[m_menuCount]; - int i; + wxMenu *menu = wxMenuBarBase::Remove(pos); + if ( !menu ) + return NULL; - for (i = 0; i < m_menuCount - 1; i++) - { - new_menus[i] = m_menus[i]; - m_menus[i] = NULL; - new_titles[i] = m_titles[i]; - m_titles[i] = ""; - } - if (m_menus) + if ( IsAttached() ) { - delete[]m_menus; - delete[]m_titles; + if (s_macInstalledMenuBar == this) + ::DeleteMenu( menu->MacGetMenuId() /* m_menus[pos]->MacGetMenuId() */ ) ; + + Refresh(); } - m_menus = new_menus; - m_titles = new_titles; - m_menus[m_menuCount - 1] = (wxMenu *)menu; - m_titles[m_menuCount - 1] = title; + m_titles.RemoveAt(pos); - // TODO + return menu; } -void wxMenuBar::Delete(wxMenu * menu, int i) +bool wxMenuBar::Append(wxMenu *menu, const wxString& title) { - int j; - int ii = (int) i; + 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; - if (menu != 0) + m_titles.Add(title); + + UMASetMenuTitle( MAC_WXHMENU(menu->GetHMenu()) , title , m_font.GetEncoding() ) ; + + if ( IsAttached() ) { - for (ii = 0; ii < m_menuCount; ii++) + if (s_macInstalledMenuBar == this) { - if (m_menus[ii] == menu) - break; - } - if (ii >= m_menuCount) - return; - } else - { - if (ii < 0 || ii >= m_menuCount) - return; - menu = m_menus[ii]; + menu->MacBeforeDisplay( false ) ; + ::InsertMenu( MAC_WXHMENU(menu->GetHMenu()) , 0 ) ; + } + + Refresh(); } - if (!OnDelete(menu, ii)) - return; + // m_invokingWindow is set after wxFrame::SetMenuBar(). This call enables + // adding menu later on. + if (m_invokingWindow) + wxMenubarSetInvokingWindow( menu, m_invokingWindow ); - menu->SetParent(NULL); + return true; +} - -- m_menuCount; - for (j = ii; j < m_menuCount; j++) +static void wxMenubarUnsetInvokingWindow( wxMenu *menu ) +{ + menu->SetInvokingWindow( (wxWindow*) NULL ); + wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst(); + + while (node) { - m_menus[j] = m_menus[j + 1]; - m_titles[j] = m_titles[j + 1]; + wxMenuItem *menuitem = node->GetData(); + if (menuitem->IsSubMenu()) + wxMenubarUnsetInvokingWindow( menuitem->GetSubMenu() ); + + node = node->GetNext(); } } -// Find the menu menuString, item itemString, and return the item id. -// Returns -1 if none found. -int wxMenuBar::FindMenuItem (const wxString& menuString, const wxString& itemString) const +static void wxMenubarSetInvokingWindow( wxMenu *menu, wxWindow *win ) { - char buf1[200]; - char buf2[200]; - wxStripMenuCodes ((char *)(const char *)menuString, buf1); - int i; - for (i = 0; i < m_menuCount; i++) + menu->SetInvokingWindow( win ); + wxMenuItem *menuitem; + wxMenuItemList::compatibility_iterator node = menu->GetMenuItems().GetFirst(); + + while (node) { - wxStripMenuCodes ((char *)(const char *)m_titles[i], buf2); - if (strcmp (buf1, buf2) == 0) - return m_menus[i]->FindItem (itemString); + menuitem = node->GetData(); + if (menuitem->IsSubMenu()) + wxMenubarSetInvokingWindow( menuitem->GetSubMenu() , win ); + + node = node->GetNext(); } - return -1; } -wxMenuItem *wxMenuBar::FindItemForId (int Id, wxMenu ** itemMenu) const +void wxMenuBar::UnsetInvokingWindow() { - if (itemMenu) - *itemMenu = NULL; + m_invokingWindow = (wxWindow*) NULL; + wxMenu *menu; + wxMenuList::compatibility_iterator node = m_menus.GetFirst(); - wxMenuItem *item = NULL; - int i; - for (i = 0; i < m_menuCount; i++) - if ((item = m_menus[i]->FindItemForId (Id, itemMenu))) - return item; - return NULL; + while (node) + { + menu = node->GetData(); + wxMenubarUnsetInvokingWindow( menu ); + + node = node->GetNext(); + } } -void wxMenuBar::SetHelpString (int Id, const wxString& helpString) +void wxMenuBar::SetInvokingWindow(wxFrame *frame) { - int i; - for (i = 0; i < m_menuCount; i++) + m_invokingWindow = frame; + wxMenu *menu; + wxMenuList::compatibility_iterator node = m_menus.GetFirst(); + + while (node) { - if (m_menus[i]->FindItemForId (Id)) - { - m_menus[i]->SetHelpString (Id, helpString); - return; - } + menu = node->GetData(); + wxMenubarSetInvokingWindow( menu, frame ); + + node = node->GetNext(); } } -wxString wxMenuBar::GetHelpString (int Id) const +void wxMenuBar::Detach() +{ + wxMenuBarBase::Detach() ; +} + +void wxMenuBar::Attach(wxFrame *frame) +{ + wxMenuBarBase::Attach( frame ) ; +} + +// --------------------------------------------------------------------------- +// wxMenuBar searching for menu items +// --------------------------------------------------------------------------- + +// Find the itemString in menuString, and return the item id or wxNOT_FOUND +int wxMenuBar::FindMenuItem(const wxString& menuString, + const wxString& itemString) const { - int i; - for (i = 0; i < m_menuCount; i++) + wxString menuLabel = wxStripMenuCodes(menuString); + size_t count = GetMenuCount(); + for ( size_t i = 0; i < count; i++ ) { - if (m_menus[i]->FindItemForId (Id)) - return wxString(m_menus[i]->GetHelpString (Id)); + wxString title = wxStripMenuCodes(m_titles[i]); + if ( menuLabel == title ) + return _wxMenuAt(m_menus, i)->FindItem(itemString); } - return wxString(""); + + 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; +}