1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxMenu, wxMenuBar, wxMenuItem
8 // Copyright: (c) AUTHOR
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
13 // ============================================================================
14 // headers & declarations
15 // ============================================================================
21 #pragma implementation "menu.h"
22 #pragma implementation "menuitem.h"
27 #include "wx/menuitem.h"
28 #include "wx/window.h"
32 #include "wx/mac/uma.h"
34 // other standard headers
35 // ----------------------
38 #if !USE_SHARED_LIBRARY
39 IMPLEMENT_DYNAMIC_CLASS(wxMenu
, wxEvtHandler
)
40 IMPLEMENT_DYNAMIC_CLASS(wxMenuBar
, wxEvtHandler
)
43 // the (popup) menu title has this special id
44 static const int idMenuTitle
= -2;
45 static MenuItemIndex firstUserHelpMenuItem
= 0 ;
47 const short kwxMacMenuBarResource
= 1 ;
48 const short kwxMacAppleMenuId
= 1 ;
50 // ============================================================================
52 // ============================================================================
57 // Construct a menu with optional title (then use append)
60 short wxMenu::s_macNextMenuId
= 3 ;
62 short wxMenu::s_macNextMenuId
= 2 ;
71 wxMenuItem::MacBuildMenuString( label
, NULL
, NULL
, m_title
, false );
72 m_macMenuId
= s_macNextMenuId
++;
73 wxCHECK_RET( s_macNextMenuId
< 236 , "menu ids > 235 cannot be used for submenus on mac" );
74 m_hMenu
= ::NewMenu(m_macMenuId
, label
);
78 wxLogLastError("CreatePopupMenu");
81 // if we have a title, insert it in the beginning of the menu
84 Append(idMenuTitle
, m_title
) ;
92 ::DisposeMenu(m_hMenu
);
96 WX_CLEAR_ARRAY(m_accels
);
102 // not available on the mac platform
107 int wxMenu::FindAccel(int id
) const
109 size_t n
, count
= m_accels
.GetCount();
110 for ( n
= 0; n
< count
; n
++ )
112 if ( m_accels
[n
]->m_command
== id
)
119 void wxMenu::UpdateAccel(wxMenuItem
*item
)
121 // find the (new) accel for this item
122 wxAcceleratorEntry
*accel
= wxGetAccelFromString(item
->GetText());
124 accel
->m_command
= item
->GetId();
127 int n
= FindAccel(item
->GetId());
128 if ( n
== wxNOT_FOUND
)
130 // no old, add new if any
134 return; // skipping RebuildAccelTable() below
138 // replace old with new or just remove the old one if no new
143 m_accels
.RemoveAt(n
);
148 m_menuBar
->RebuildAccelTable();
152 #endif // wxUSE_ACCEL
154 // function appends a new item or submenu to the menu
155 // append a new item or submenu to the menu
156 bool wxMenu::DoInsertOrAppend(wxMenuItem
*pItem
, size_t pos
)
158 wxASSERT_MSG( pItem
!= NULL
, "can't append NULL item to the menu" );
161 #endif // wxUSE_ACCEL
163 if ( pItem
->IsSeparator() )
165 if ( pos
== (size_t)-1 )
167 MacAppendMenu(m_hMenu
, "\p-");
171 MacInsertMenuItem(m_hMenu
, "\p-" , pos
);
176 wxMenu
*pSubMenu
= pItem
->GetSubMenu() ;
177 if ( pSubMenu
!= NULL
)
180 wxASSERT_MSG( pSubMenu
->m_hMenu
!= NULL
, "invalid submenu added");
181 pSubMenu
->m_menuParent
= this ;
182 wxMenuItem::MacBuildMenuString( label
, NULL
, NULL
, pItem
->GetText() ,false);
184 if (wxMenuBar::MacGetInstalledMenuBar() == m_menuBar
)
186 ::InsertMenu( pSubMenu
->m_hMenu
, -1 ) ;
189 if ( pos
== (size_t)-1 )
191 UMAAppendSubMenuItem(m_hMenu
, label
, pSubMenu
->m_macMenuId
);
195 UMAInsertSubMenuItem(m_hMenu
, label
, pos
, pSubMenu
->m_macMenuId
);
203 wxMenuItem::MacBuildMenuString( label
, &key
, &modifiers
, pItem
->GetText(), pItem
->GetId() == wxApp::s_macAboutMenuItemId
);
206 // we cannot add empty menus on mac
210 if ( pos
== (size_t)-1 )
212 UMAAppendMenuItem(m_hMenu
, label
,key
,modifiers
);
216 UMAInsertMenuItem(m_hMenu
, label
, pos
,key
,modifiers
);
218 if ( pItem
->GetId() == idMenuTitle
)
220 if ( pos
== (size_t)-1 )
222 UMADisableMenuItem( m_hMenu
, CountMenuItems( m_hMenu
) ) ;
226 UMADisableMenuItem( m_hMenu
, pos
+ 1 ) ;
231 // if we're already attached to the menubar, we must update it
234 m_menuBar
->Refresh();
239 bool wxMenu::DoAppend(wxMenuItem
*item
)
241 return wxMenuBase::DoAppend(item
) && DoInsertOrAppend(item
);
244 bool wxMenu::DoInsert(size_t pos
, wxMenuItem
*item
)
246 return wxMenuBase::DoInsert(pos
, item
) && DoInsertOrAppend(item
, pos
);
249 wxMenuItem
*wxMenu::DoRemove(wxMenuItem
*item
)
251 // we need to find the items position in the child list
253 wxMenuItemList::Node
*node
= GetMenuItems().GetFirst();
254 for ( pos
= 0; node
; pos
++ )
256 if ( node
->GetData() == item
)
259 node
= node
->GetNext();
262 // DoRemove() (unlike Remove) can only be called for existing item!
263 wxCHECK_MSG( node
, NULL
, wxT("bug in wxMenu::Remove logic") );
266 // remove the corresponding accel from the accel table
267 int n
= FindAccel(item
->GetId());
268 if ( n
!= wxNOT_FOUND
)
272 m_accels
.RemoveAt(n
);
274 //else: this item doesn't have an accel, nothing to do
275 #endif // wxUSE_ACCEL
277 ::DeleteMenuItem( m_hMenu
, pos
+ 1);
281 // otherwise, the chane won't be visible
282 m_menuBar
->Refresh();
285 // and from internal data structures
286 return wxMenuBase::DoRemove(item
);
289 // ---------------------------------------------------------------------------
290 // accelerator helpers
291 // ---------------------------------------------------------------------------
295 // create the wxAcceleratorEntries for our accels and put them into provided
296 // array - return the number of accels we have
297 size_t wxMenu::CopyAccels(wxAcceleratorEntry
*accels
) const
299 size_t count
= GetAccelCount();
300 for ( size_t n
= 0; n
< count
; n
++ )
302 *accels
++ = *m_accels
[n
];
308 #endif // wxUSE_ACCEL
310 void wxMenu::SetTitle(const wxString
& label
)
314 wxMenuItem::MacBuildMenuString( title
, NULL
, NULL
, label
, false );
315 UMASetMenuTitle( m_hMenu
, title
) ;
317 bool wxMenu::ProcessCommand(wxCommandEvent
& event
)
319 bool processed
= FALSE
;
321 #if WXWIN_COMPATIBILITY
325 (void)(*(m_callback
))(*this, event
);
328 #endif WXWIN_COMPATIBILITY
330 // Try the menu's event handler
331 if ( !processed
&& GetEventHandler())
333 processed
= GetEventHandler()->ProcessEvent(event
);
336 // Try the window the menu was popped up from (and up through the
338 wxWindow
*win
= GetInvokingWindow();
339 if ( !processed
&& win
)
340 processed
= win
->GetEventHandler()->ProcessEvent(event
);
346 // ---------------------------------------------------------------------------
348 // ---------------------------------------------------------------------------
350 wxWindow
*wxMenu::GetWindow() const
352 if ( m_invokingWindow
!= NULL
)
353 return m_invokingWindow
;
354 else if ( m_menuBar
!= NULL
)
355 return (wxWindow
*) m_menuBar
->GetFrame();
360 // helper functions returning the mac menu position for a certain item, note that this is
361 // mac-wise 1 - based, i.e. the first item has index 1 whereas on MSWin it has pos 0
363 int wxMenu::MacGetIndexFromId( int id
)
366 wxMenuItemList::Node
*node
= GetMenuItems().GetFirst();
367 for ( pos
= 0; node
; pos
++ )
369 if ( node
->GetData()->GetId() == id
)
372 node
= node
->GetNext();
381 int wxMenu::MacGetIndexFromItem( wxMenuItem
*pItem
)
384 wxMenuItemList::Node
*node
= GetMenuItems().GetFirst();
385 for ( pos
= 0; node
; pos
++ )
387 if ( node
->GetData() == pItem
)
390 node
= node
->GetNext();
399 void wxMenu::MacEnableMenu( bool bDoEnable
)
402 UMAEnableMenuItem( m_hMenu
, 0 ) ;
404 UMADisableMenuItem( m_hMenu
, 0 ) ;
409 bool wxMenu::MacMenuSelect( wxEvtHandler
* handler
, long when
, int macMenuId
, int macMenuItemNum
)
414 if ( m_macMenuId
== macMenuId
)
416 node
= GetMenuItems().Nth(macMenuItemNum
-1);
419 wxMenuItem
*pItem
= (wxMenuItem
*)node
->Data();
421 if (pItem
->IsCheckable())
422 pItem
->Check(! pItem
->IsChecked());
424 wxCommandEvent
event(wxEVT_COMMAND_MENU_SELECTED
, pItem
->GetId());
425 event
.m_timeStamp
= when
;
426 event
.SetEventObject(handler
);
427 event
.SetInt( pItem
->GetId() );
429 bool processed
= false ;
431 #if WXWIN_COMPATIBILITY
435 (void) (*(m_callback
)) (*this, event
);
439 // Try the menu's event handler
440 if ( !processed
&& handler
)
442 processed
= handler
->ProcessEvent(event
);
445 // Try the window the menu was popped up from (and up
446 // through the hierarchy)
447 if ( !processed
&& GetInvokingWindow())
448 processed
= GetInvokingWindow()->GetEventHandler()->ProcessEvent(event
);
454 else if ( macMenuId
== kHMHelpMenuID
)
456 int menuItem
= firstUserHelpMenuItem
-1 ;
457 for (pos
= 0, node
= GetMenuItems().First(); node
; node
= node
->Next(), pos
++)
459 wxMenuItem
* pItem
= (wxMenuItem
*) node
->Data() ;
461 wxMenu
*pSubMenu
= pItem
->GetSubMenu() ;
462 if ( pSubMenu
!= NULL
)
467 if ( pItem
->GetId() != wxApp::s_macAboutMenuItemId
)
470 if ( menuItem
== macMenuItemNum
)
472 wxCommandEvent
event(wxEVT_COMMAND_MENU_SELECTED
, pItem
->GetId());
473 event
.m_timeStamp
= when
;
474 event
.SetEventObject(handler
);
475 event
.SetInt( pItem
->GetId() );
477 bool processed
= false ;
478 #if WXWIN_COMPATIBILITY
482 (void) (*(m_callback
)) (*this, event
);
486 // Try the menu's event handler
487 if ( !processed
&& handler
)
489 processed
= handler
->ProcessEvent(event
);
492 // Try the window the menu was popped up from (and up
493 // through the hierarchy)
494 if ( !processed
&& GetInvokingWindow())
495 processed
= GetInvokingWindow()->GetEventHandler()->ProcessEvent(event
);
504 for (pos
= 0, node
= GetMenuItems().First(); node
; node
= node
->Next(), pos
++)
506 wxMenuItem
* pItem
= (wxMenuItem
*) node
->Data() ;
508 wxMenu
*pSubMenu
= pItem
->GetSubMenu() ;
509 if ( pSubMenu
!= NULL
)
511 if ( pSubMenu
->MacMenuSelect( handler
, when
, macMenuId
, macMenuItemNum
) )
523 Mac Implementation note :
525 The Mac has only one global menubar, so we attempt to install the currently
526 active menubar from a frame, we currently don't take into account mdi-frames
527 which would ask for menu-merging
529 Secondly there is no mac api for changing a menubar that is not the current
530 menubar, so we have to wait for preparing the actual menubar until the
531 wxMenubar is to be used
533 We can in subsequent versions use MacInstallMenuBar to provide some sort of
534 auto-merge for MDI in case this will be necessary
538 wxMenuBar
* wxMenuBar::s_macInstalledMenuBar
= NULL
;
540 void wxMenuBar::Init()
542 m_eventHandler
= this;
543 m_menuBarFrame
= NULL
;
546 wxMenuBar::wxMenuBar()
551 wxMenuBar::wxMenuBar( long WXUNUSED(style
) )
557 wxMenuBar::wxMenuBar(int count
, wxMenu
*menus
[], const wxString titles
[])
561 m_titles
.Alloc(count
);
563 for ( int i
= 0; i
< count
; i
++ )
565 m_menus
.Append(menus
[i
]);
566 m_titles
.Add(titles
[i
]);
568 menus
[i
]->Attach(this);
572 wxMenuBar::~wxMenuBar()
574 if (s_macInstalledMenuBar
== this)
577 s_macInstalledMenuBar
= NULL
;
582 void wxMenuBar::Refresh()
584 wxCHECK_RET( IsAttached(), wxT("can't refresh unatteched menubar") );
591 void wxMenuBar::RebuildAccelTable()
593 // merge the accelerators of all menus into one accel table
594 size_t nAccelCount
= 0;
595 size_t i
, count
= GetMenuCount();
596 for ( i
= 0; i
< count
; i
++ )
598 nAccelCount
+= m_menus
[i
]->GetAccelCount();
603 wxAcceleratorEntry
*accelEntries
= new wxAcceleratorEntry
[nAccelCount
];
606 for ( i
= 0; i
< count
; i
++ )
608 nAccelCount
+= m_menus
[i
]->CopyAccels(&accelEntries
[nAccelCount
]);
611 m_accelTable
= wxAcceleratorTable(nAccelCount
, accelEntries
);
613 delete [] accelEntries
;
617 #endif // wxUSE_ACCEL
620 void wxMenuBar::MacInstallMenuBar()
622 if ( s_macInstalledMenuBar
== this )
625 Handle menubar
= ::GetNewMBar( kwxMacMenuBarResource
) ;
627 wxCHECK_RET( menubar
!= NULL
, "can't read MBAR resource" );
628 ::SetMenuBar( menubar
) ;
629 ::DisposeHandle( menubar
) ;
631 MenuHandle menu
= ::GetMenuHandle( kwxMacAppleMenuId
) ;
632 ::AppendResMenu(menu
, 'DRVR');
634 for (int i
= 0; i
< m_menus
.GetCount(); i
++)
640 wxMenu
* menu
= m_menus
[i
] , *subMenu
= NULL
;
642 if( m_titles
[i
] == "?" || m_titles
[i
] == "&?" || m_titles
[i
] == wxApp::s_macHelpMenuTitleName
)
644 MenuHandle mh
= NULL
;
645 if ( UMAGetHelpMenu( &mh
, &firstUserHelpMenuItem
) != noErr
)
650 for (pos
= 0 , node
= menu
->GetMenuItems().First(); node
; node
= node
->Next(), pos
++)
652 item
= (wxMenuItem
*)node
->Data();
653 subMenu
= item
->GetSubMenu() ;
656 // we don't support hierarchical menus in the help menu yet
660 if ( item
->IsSeparator() )
663 UMAAppendMenuItem(mh
, "\p-" );
670 wxMenuItem::MacBuildMenuString( label
, &key
, &modifiers
, item
->GetText(), item
->GetId() != wxApp::s_macAboutMenuItemId
); // no shortcut in about menu
673 // we cannot add empty menus on mac
677 if ( item
->GetId() == wxApp::s_macAboutMenuItemId
)
679 ::SetMenuItemText( GetMenuHandle( kwxMacAppleMenuId
) , 1 , label
);
680 UMAEnableMenuItem( GetMenuHandle( kwxMacAppleMenuId
) , 1 );
685 UMAAppendMenuItem(mh
, label
, key
, modifiers
);
693 wxMenuItem::MacBuildMenuString( label
, NULL
, NULL
, m_titles
[i
] , false );
694 UMASetMenuTitle( menu
->GetHMenu() , label
) ;
695 wxArrayPtrVoid submenus
;
697 for (pos
= 0, node
= menu
->GetMenuItems().First(); node
; node
= node
->Next(), pos
++)
699 item
= (wxMenuItem
*)node
->Data();
700 subMenu
= item
->GetSubMenu() ;
703 submenus
.Add(subMenu
) ;
706 ::InsertMenu(m_menus
[i
]->GetHMenu(), 0);
707 for ( int i
= 0 ; i
< submenus
.GetCount() ; ++i
)
709 wxMenu
* submenu
= (wxMenu
*) submenus
[i
] ;
713 for ( subpos
= 0 , subnode
= submenu
->GetMenuItems().First(); subnode
; subnode
= subnode
->Next(), subpos
++)
715 subitem
= (wxMenuItem
*)subnode
->Data();
716 wxMenu
* itsSubMenu
= subitem
->GetSubMenu() ;
719 submenus
.Add(itsSubMenu
) ;
722 ::InsertMenu( submenu
->GetHMenu() , -1 ) ;
728 s_macInstalledMenuBar
= this;
731 void wxMenuBar::EnableTop(size_t pos
, bool enable
)
733 wxCHECK_RET( IsAttached(), wxT("doesn't work with unattached menubars") );
734 m_menus
[pos
]->MacEnableMenu( enable
) ;
738 void wxMenuBar::SetLabelTop(size_t pos
, const wxString
& label
)
740 wxCHECK_RET( pos
< GetMenuCount(), wxT("invalid menu index") );
742 m_titles
[pos
] = label
;
749 m_menus
[pos
]->SetTitle( label
) ;
750 if (wxMenuBar::s_macInstalledMenuBar
== this) // are we currently installed ?
752 ::SetMenuBar( GetMenuBar() ) ;
757 wxString
wxMenuBar::GetLabelTop(size_t pos
) const
759 wxCHECK_MSG( pos
< GetMenuCount(), wxEmptyString
,
760 wxT("invalid menu index in wxMenuBar::GetLabelTop") );
762 return m_titles
[pos
];
765 int wxMenuBar::FindMenu(const wxString
& title
)
767 wxString menuTitle
= wxStripMenuCodes(title
);
769 size_t count
= GetMenuCount();
770 for ( size_t i
= 0; i
< count
; i
++ )
772 wxString title
= wxStripMenuCodes(m_titles
[i
]);
773 if ( menuTitle
== title
)
782 // ---------------------------------------------------------------------------
783 // wxMenuBar construction
784 // ---------------------------------------------------------------------------
786 // ---------------------------------------------------------------------------
787 // wxMenuBar construction
788 // ---------------------------------------------------------------------------
790 wxMenu
*wxMenuBar::Replace(size_t pos
, wxMenu
*menu
, const wxString
& title
)
792 wxMenu
*menuOld
= wxMenuBarBase::Replace(pos
, menu
, title
);
795 m_titles
[pos
] = title
;
799 if (s_macInstalledMenuBar
== this)
801 ::DeleteMenu( menuOld
->MacGetMenuId() /* m_menus[pos]->MacGetMenuId() */ ) ;
804 wxMenuItem::MacBuildMenuString( label
, NULL
, NULL
, title
, false );
805 UMASetMenuTitle( menu
->GetHMenu() , label
) ;
806 if ( pos
== m_menus
.GetCount() - 1)
808 ::InsertMenu( menu
->GetHMenu() , 0 ) ;
812 ::InsertMenu( menu
->GetHMenu() , m_menus
[pos
+1]->MacGetMenuId() ) ;
819 if ( menuOld
->HasAccels() || menu
->HasAccels() )
821 // need to rebuild accell table
824 #endif // wxUSE_ACCEL
832 bool wxMenuBar::Insert(size_t pos
, wxMenu
*menu
, const wxString
& title
)
834 if ( !wxMenuBarBase::Insert(pos
, menu
, title
) )
837 m_titles
.Insert(title
, pos
);
843 if ( pos
== (size_t) -1 )
845 ::InsertMenu( menu
->GetHMenu() , 0 ) ;
849 ::InsertMenu( menu
->GetHMenu() , m_menus
[pos
+1]->MacGetMenuId() ) ;
853 if ( menu
->HasAccels() )
855 // need to rebuild accell table
858 #endif // wxUSE_ACCEL
866 void wxMenuBar::MacMenuSelect(wxEvtHandler
* handler
, long when
, int macMenuId
, int macMenuItemNum
)
868 // first scan fast for direct commands, i.e. menus which have these commands directly in their own list
870 if ( macMenuId
== kwxMacAppleMenuId
&& macMenuItemNum
== 1 )
872 wxCommandEvent
event(wxEVT_COMMAND_MENU_SELECTED
, wxApp::s_macAboutMenuItemId
);
873 event
.m_timeStamp
= when
;
874 event
.SetEventObject(handler
);
875 event
.SetInt( wxApp::s_macAboutMenuItemId
);
876 handler
->ProcessEvent(event
);
880 for (int i
= 0; i
< m_menus
.GetCount() ; i
++)
882 if ( m_menus
[i
]->MacGetMenuId() == macMenuId
885 ( macMenuId
== kHMHelpMenuID
&& ( m_titles
[i
] == "?" || m_titles
[i
] == "&?" || m_titles
[i
] == wxApp::s_macHelpMenuTitleName
) )
889 if ( m_menus
[i
]->MacMenuSelect( handler
, when
, macMenuId
, macMenuItemNum
) )
893 //TODO flag this as an error since it must contain the item
899 for (int i
= 0; i
< m_menus
.GetCount(); i
++)
901 if ( m_menus
[i
]->MacMenuSelect( handler
, when
, macMenuId
, macMenuItemNum
) )
909 wxMenu
*wxMenuBar::Remove(size_t pos
)
911 wxMenu
*menu
= wxMenuBarBase::Remove(pos
);
917 if (s_macInstalledMenuBar
== this)
919 ::DeleteMenu( menu
->MacGetMenuId() /* m_menus[pos]->MacGetMenuId() */ ) ;
925 if ( menu
->HasAccels() )
927 // need to rebuild accell table
930 #endif // wxUSE_ACCEL
935 m_titles
.Remove(pos
);
940 bool wxMenuBar::Append(wxMenu
*menu
, const wxString
& title
)
942 WXHMENU submenu
= menu
? menu
->GetHMenu() : 0;
943 wxCHECK_MSG( submenu
, FALSE
, wxT("can't append invalid menu to menubar") );
945 if ( !wxMenuBarBase::Append(menu
, title
) )
952 if (s_macInstalledMenuBar
== this)
954 ::InsertMenu( menu
->GetHMenu() , 0 ) ;
958 if ( menu
->HasAccels() )
960 // need to rebuild accell table
963 #endif // wxUSE_ACCEL
971 void wxMenuBar::Detach()
973 wxMenuBarBase::Detach() ;
976 void wxMenuBar::Attach(wxFrame
*frame
)
978 wxMenuBarBase::Attach( frame
) ;
982 #endif // wxUSE_ACCEL
984 // ---------------------------------------------------------------------------
985 // wxMenuBar searching for menu items
986 // ---------------------------------------------------------------------------
988 // Find the itemString in menuString, and return the item id or wxNOT_FOUND
989 int wxMenuBar::FindMenuItem(const wxString
& menuString
,
990 const wxString
& itemString
) const
992 wxString menuLabel
= wxStripMenuCodes(menuString
);
993 size_t count
= GetMenuCount();
994 for ( size_t i
= 0; i
< count
; i
++ )
996 wxString title
= wxStripMenuCodes(m_titles
[i
]);
997 if ( menuString
== title
)
998 return m_menus
[i
]->FindItem(itemString
);
1004 wxMenuItem
*wxMenuBar::FindItem(int id
, wxMenu
**itemMenu
) const
1009 wxMenuItem
*item
= NULL
;
1010 size_t count
= GetMenuCount();
1011 for ( size_t i
= 0; !item
&& (i
< count
); i
++ )
1013 item
= m_menus
[i
]->FindItem(id
, itemMenu
);