1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxMenu, wxMenuBar, wxMenuItem
4 // Author: Stefan Csomor
8 // Copyright: (c) Stefan Csomor
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
13 #pragma implementation "menu.h"
14 #pragma implementation "menuitem.h"
17 // ============================================================================
18 // headers & declarations
19 // ============================================================================
26 #include "wx/menuitem.h"
27 #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 // ============================================================================
53 static void wxMenubarUnsetInvokingWindow( wxMenu
*menu
) ;
54 static void wxMenubarSetInvokingWindow( wxMenu
*menu
, wxWindow
*win
);
58 // Construct a menu with optional title (then use append)
61 short wxMenu::s_macNextMenuId
= 3 ;
63 short wxMenu::s_macNextMenuId
= 2 ;
69 m_startRadioGroup
= -1;
72 m_macMenuId
= s_macNextMenuId
++;
73 m_hMenu
= UMANewMenu(m_macMenuId
, m_title
, wxFont::GetDefaultEncoding() );
77 wxLogLastError(wxT("UMANewMenu failed"));
80 // if we have a title, insert it in the beginning of the menu
83 Append(idMenuTitle
, m_title
) ;
90 if (MAC_WXHMENU(m_hMenu
))
91 ::DisposeMenu(MAC_WXHMENU(m_hMenu
));
96 // not available on the mac platform
99 void wxMenu::Attach(wxMenuBarBase
*menubar
)
101 wxMenuBase::Attach(menubar
);
106 // function appends a new item or submenu to the menu
107 // append a new item or submenu to the menu
108 bool wxMenu::DoInsertOrAppend(wxMenuItem
*pItem
, size_t pos
)
110 wxASSERT_MSG( pItem
!= NULL
, wxT("can't append NULL item to the menu") );
112 if ( pItem
->IsSeparator() )
114 if ( pos
== (size_t)-1 )
115 MacAppendMenu(MAC_WXHMENU(m_hMenu
), "\p-");
117 MacInsertMenuItem(MAC_WXHMENU(m_hMenu
), "\p-" , pos
);
121 wxMenu
*pSubMenu
= pItem
->GetSubMenu() ;
122 if ( pSubMenu
!= NULL
)
124 wxASSERT_MSG( pSubMenu
->m_hMenu
!= NULL
, wxT("invalid submenu added"));
125 pSubMenu
->m_menuParent
= this ;
127 if (wxMenuBar::MacGetInstalledMenuBar() == GetMenuBar())
129 pSubMenu
->MacBeforeDisplay( true ) ;
132 if ( pos
== (size_t)-1 )
133 UMAAppendSubMenuItem(MAC_WXHMENU(m_hMenu
), pItem
->GetText(), wxFont::GetDefaultEncoding() , pSubMenu
->m_macMenuId
);
135 UMAInsertSubMenuItem(MAC_WXHMENU(m_hMenu
), pItem
->GetText(), wxFont::GetDefaultEncoding() , pos
, pSubMenu
->m_macMenuId
);
136 pItem
->UpdateItemBitmap() ;
137 pItem
->UpdateItemStatus() ;
141 if ( pos
== (size_t)-1 )
143 UMAAppendMenuItem(MAC_WXHMENU(m_hMenu
), wxT("a") , wxFont::GetDefaultEncoding() );
144 pos
= CountMenuItems(MAC_WXHMENU(m_hMenu
)) ;
148 // MacOS counts menu items from 1 and inserts after, therefore having the
149 // same effect as wx 0 based and inserting before, we must correct pos
150 // after however for updates to be correct
151 UMAInsertMenuItem(MAC_WXHMENU(m_hMenu
), wxT("a"), wxFont::GetDefaultEncoding(), pos
);
155 SetMenuItemCommandID( MAC_WXHMENU(m_hMenu
) , pos
, pItem
->GetId() ) ;
156 pItem
->UpdateItemText() ;
157 pItem
->UpdateItemBitmap() ;
158 pItem
->UpdateItemStatus() ;
160 if ( pItem
->GetId() == idMenuTitle
)
162 UMAEnableMenuItem(MAC_WXHMENU(m_hMenu
) , pos
, false ) ;
166 // if we're already attached to the menubar, we must update it
169 GetMenuBar()->Refresh();
174 void wxMenu::EndRadioGroup()
176 // we're not inside a radio group any longer
177 m_startRadioGroup
= -1;
180 wxMenuItem
* wxMenu::DoAppend(wxMenuItem
*item
)
182 wxCHECK_MSG( item
, NULL
, _T("NULL item in wxMenu::DoAppend") );
186 if ( item
->GetKind() == wxITEM_RADIO
)
188 int count
= GetMenuItemCount();
190 if ( m_startRadioGroup
== -1 )
192 // start a new radio group
193 m_startRadioGroup
= count
;
195 // for now it has just one element
196 item
->SetAsRadioGroupStart();
197 item
->SetRadioGroupEnd(m_startRadioGroup
);
199 // ensure that we have a checked item in the radio group
202 else // extend the current radio group
204 // we need to update its end item
205 item
->SetRadioGroupStart(m_startRadioGroup
);
206 wxMenuItemList::Node
*node
= GetMenuItems().Item(m_startRadioGroup
);
210 node
->GetData()->SetRadioGroupEnd(count
);
214 wxFAIL_MSG( _T("where is the radio group start item?") );
218 else // not a radio item
223 if ( !wxMenuBase::DoAppend(item
) || !DoInsertOrAppend(item
) )
230 // check the item initially
237 wxMenuItem
* wxMenu::DoInsert(size_t pos
, wxMenuItem
*item
)
239 if (wxMenuBase::DoInsert(pos
, item
) && DoInsertOrAppend(item
, pos
))
245 wxMenuItem
*wxMenu::DoRemove(wxMenuItem
*item
)
247 // we need to find the items position in the child list
249 wxMenuItemList::Node
*node
= GetMenuItems().GetFirst();
250 for ( pos
= 0; node
; pos
++ )
252 if ( node
->GetData() == item
)
255 node
= node
->GetNext();
258 // DoRemove() (unlike Remove) can only be called for existing item!
259 wxCHECK_MSG( node
, NULL
, wxT("bug in wxMenu::Remove logic") );
261 ::DeleteMenuItem(MAC_WXHMENU(m_hMenu
) , pos
+ 1);
265 // otherwise, the change won't be visible
266 GetMenuBar()->Refresh();
269 // and from internal data structures
270 return wxMenuBase::DoRemove(item
);
273 void wxMenu::SetTitle(const wxString
& label
)
276 UMASetMenuTitle(MAC_WXHMENU(m_hMenu
) , label
, wxFont::GetDefaultEncoding() ) ;
278 bool wxMenu::ProcessCommand(wxCommandEvent
& event
)
280 bool processed
= FALSE
;
282 // Try the menu's event handler
283 if ( !processed
&& GetEventHandler())
285 processed
= GetEventHandler()->ProcessEvent(event
);
288 // Try the window the menu was popped up from (and up through the
290 wxWindow
*win
= GetInvokingWindow();
291 if ( !processed
&& win
)
292 processed
= win
->GetEventHandler()->ProcessEvent(event
);
298 // ---------------------------------------------------------------------------
300 // ---------------------------------------------------------------------------
302 wxWindow
*wxMenu::GetWindow() const
304 if ( m_invokingWindow
!= NULL
)
305 return m_invokingWindow
;
306 else if ( GetMenuBar() != NULL
)
307 return (wxWindow
*) GetMenuBar()->GetFrame();
312 // helper functions returning the mac menu position for a certain item, note that this is
313 // mac-wise 1 - based, i.e. the first item has index 1 whereas on MSWin it has pos 0
315 int wxMenu::MacGetIndexFromId( int id
)
318 wxMenuItemList::Node
*node
= GetMenuItems().GetFirst();
319 for ( pos
= 0; node
; pos
++ )
321 if ( node
->GetData()->GetId() == id
)
324 node
= node
->GetNext();
333 int wxMenu::MacGetIndexFromItem( wxMenuItem
*pItem
)
336 wxMenuItemList::Node
*node
= GetMenuItems().GetFirst();
337 for ( pos
= 0; node
; pos
++ )
339 if ( node
->GetData() == pItem
)
342 node
= node
->GetNext();
351 void wxMenu::MacEnableMenu( bool bDoEnable
)
353 UMAEnableMenuItem(MAC_WXHMENU(m_hMenu
) , 0 , bDoEnable
) ;
358 // MacOS needs to know about submenus somewhere within this menu
359 // before it can be displayed , also hide special menu items like preferences
360 // that are handled by the OS
361 void wxMenu::MacBeforeDisplay( bool isSubMenu
)
363 wxMenuItem
* previousItem
= NULL
;
365 wxMenuItemList::Node
*node
;
367 for (pos
= 0, node
= GetMenuItems().GetFirst(); node
; node
= node
->GetNext(), pos
++)
369 item
= (wxMenuItem
*)node
->GetData();
370 wxMenu
* subMenu
= item
->GetSubMenu() ;
373 subMenu
->MacBeforeDisplay( true ) ;
378 if ( UMAGetSystemVersion() >= 0x1000 )
380 if ( item
->GetId() == wxApp::s_macPreferencesMenuItemId
|| item
->GetId() == wxApp::s_macExitMenuItemId
)
382 ChangeMenuItemAttributes( MAC_WXHMENU( GetHMenu() ) , pos
+ 1, kMenuItemAttrHidden
, 0 );
383 if ( GetMenuItems().GetCount() == pos
+ 1 &&
384 previousItem
!= NULL
&&
385 previousItem
->IsSeparator() )
387 ChangeMenuItemAttributes( MAC_WXHMENU( GetHMenu() ) , pos
, kMenuItemAttrHidden
, 0 );
393 previousItem
= item
;
397 ::InsertMenu(MAC_WXHMENU( GetHMenu()), -1);
400 // undo all changes from the MacBeforeDisplay call
401 void wxMenu::MacAfterDisplay( bool isSubMenu
)
404 ::DeleteMenu(MacGetMenuId());
406 wxMenuItem
* previousItem
= NULL
;
408 wxMenuItemList::Node
*node
;
410 for (pos
= 0, node
= GetMenuItems().GetFirst(); node
; node
= node
->GetNext(), pos
++)
412 item
= (wxMenuItem
*)node
->GetData();
413 wxMenu
* subMenu
= item
->GetSubMenu() ;
416 subMenu
->MacAfterDisplay( true ) ;
420 // no need to undo hidings
422 previousItem
= item
;
430 Mac Implementation note :
432 The Mac has only one global menubar, so we attempt to install the currently
433 active menubar from a frame, we currently don't take into account mdi-frames
434 which would ask for menu-merging
436 Secondly there is no mac api for changing a menubar that is not the current
437 menubar, so we have to wait for preparing the actual menubar until the
438 wxMenubar is to be used
440 We can in subsequent versions use MacInstallMenuBar to provide some sort of
441 auto-merge for MDI in case this will be necessary
445 wxMenuBar
* wxMenuBar::s_macInstalledMenuBar
= NULL
;
446 wxMenuBar
* wxMenuBar::s_macCommonMenuBar
= NULL
;
448 void wxMenuBar::Init()
450 m_eventHandler
= this;
451 m_menuBarFrame
= NULL
;
452 m_invokingWindow
= (wxWindow
*) NULL
;
455 wxMenuBar::wxMenuBar()
460 wxMenuBar::wxMenuBar( long WXUNUSED(style
) )
466 wxMenuBar::wxMenuBar(int count
, wxMenu
*menus
[], const wxString titles
[])
470 m_titles
.Alloc(count
);
472 for ( int i
= 0; i
< count
; i
++ )
474 m_menus
.Append(menus
[i
]);
475 m_titles
.Add(titles
[i
]);
477 menus
[i
]->Attach(this);
481 wxMenuBar::~wxMenuBar()
483 if (s_macCommonMenuBar
== this)
484 s_macCommonMenuBar
= NULL
;
485 if (s_macInstalledMenuBar
== this)
488 s_macInstalledMenuBar
= NULL
;
493 void wxMenuBar::Refresh(bool WXUNUSED(eraseBackground
), const wxRect
*WXUNUSED(rect
))
495 wxCHECK_RET( IsAttached(), wxT("can't refresh unatteched menubar") );
500 void wxMenuBar::MacInstallMenuBar()
502 if ( s_macInstalledMenuBar
== this )
505 wxStAppResource resload
;
507 MenuBarHandle menubar
= NewHandleClear( 6 /* sizeof( MenuBarHeader ) */ ) ;
508 ::SetMenuBar( menubar
) ;
509 DisposeMenuBar( menubar
) ;
510 MenuHandle appleMenu
= NULL
;
511 char appleMenuTitle
[3] = { 01 , kMenuAppleLogoFilledGlyph
, 0 } ;
513 verify_noerr( CreateNewMenu( kwxMacAppleMenuId
, 0 , &appleMenu
) ) ;
514 verify_noerr( SetMenuTitle( appleMenu
, (ConstStr255Param
) appleMenuTitle
) );
515 MacInsertMenuItem( appleMenu
, "\pAbout..." , 0 ) ;
516 MacInsertMenu( appleMenu
, 0 ) ;
518 // clean-up the help menu before adding new items
519 MenuHandle mh
= NULL
;
520 if ( UMAGetHelpMenu( &mh
, &firstUserHelpMenuItem
) == noErr
)
522 for ( int i
= CountMenuItems( mh
) ; i
>= firstUserHelpMenuItem
; --i
)
524 DeleteMenuItem( mh
, i
) ;
532 if ( UMAGetSystemVersion() >= 0x1000 && wxApp::s_macPreferencesMenuItemId
)
534 wxMenuItem
*item
= FindItem( wxApp::s_macPreferencesMenuItemId
, NULL
) ;
535 if ( item
== NULL
|| !(item
->IsEnabled()) )
536 DisableMenuCommand( NULL
, kHICommandPreferences
) ;
538 EnableMenuCommand( NULL
, kHICommandPreferences
) ;
541 for (size_t i
= 0; i
< m_menus
.GetCount(); i
++)
543 wxMenuItemList::Node
*node
;
546 wxMenu
* menu
= m_menus
[i
] , *subMenu
= NULL
;
548 if( m_titles
[i
] == wxT("?") || m_titles
[i
] == wxT("&?") || m_titles
[i
] == wxApp::s_macHelpMenuTitleName
)
555 for (pos
= 0 , node
= menu
->GetMenuItems().GetFirst(); node
; node
= node
->GetNext(), pos
++)
557 item
= (wxMenuItem
*)node
->GetData();
558 subMenu
= item
->GetSubMenu() ;
561 // we don't support hierarchical menus in the help menu yet
565 if ( item
->IsSeparator() )
568 MacAppendMenu(mh
, "\p-" );
572 wxAcceleratorEntry
* entry
= wxGetAccelFromString( item
->GetText() ) ;
574 if ( item
->GetId() == wxApp::s_macAboutMenuItemId
)
576 UMASetMenuItemText( GetMenuHandle( kwxMacAppleMenuId
) , 1 , item
->GetText() , wxFont::GetDefaultEncoding() );
577 UMAEnableMenuItem( GetMenuHandle( kwxMacAppleMenuId
) , 1 , true );
578 SetMenuItemCommandID( GetMenuHandle( kwxMacAppleMenuId
) , 1 , item
->GetId() ) ;
579 UMASetMenuItemShortcut( GetMenuHandle( kwxMacAppleMenuId
) , 1 , entry
) ;
585 UMAAppendMenuItem(mh
, item
->GetText() , wxFont::GetDefaultEncoding(), entry
);
586 SetMenuItemCommandID( mh
, CountMenuItems(mh
) , item
->GetId() ) ;
597 UMASetMenuTitle( MAC_WXHMENU(menu
->GetHMenu()) , m_titles
[i
], m_font
.GetEncoding() ) ;
598 m_menus
[i
]->MacBeforeDisplay(false) ;
599 ::InsertMenu(MAC_WXHMENU(m_menus
[i
]->GetHMenu()), 0);
603 s_macInstalledMenuBar
= this;
606 void wxMenuBar::EnableTop(size_t pos
, bool enable
)
608 wxCHECK_RET( IsAttached(), wxT("doesn't work with unattached menubars") );
609 m_menus
[pos
]->MacEnableMenu( enable
) ;
613 bool wxMenuBar::Enable( bool enable
)
615 wxCHECK_MSG( IsAttached(), false, wxT("doesn't work with unattached menubars") );
617 for (i
= 0; i
< GetMenuCount(); i
++)
619 EnableTop(i
, enable
);
624 void wxMenuBar::SetLabelTop(size_t pos
, const wxString
& label
)
626 wxCHECK_RET( pos
< GetMenuCount(), wxT("invalid menu index") );
628 m_titles
[pos
] = label
;
635 m_menus
[pos
]->SetTitle( label
) ;
636 if (wxMenuBar::s_macInstalledMenuBar
== this) // are we currently installed ?
638 ::SetMenuBar( GetMenuBar() ) ;
643 wxString
wxMenuBar::GetLabelTop(size_t pos
) const
645 wxCHECK_MSG( pos
< GetMenuCount(), wxEmptyString
,
646 wxT("invalid menu index in wxMenuBar::GetLabelTop") );
648 return m_titles
[pos
];
651 int wxMenuBar::FindMenu(const wxString
& title
)
653 wxString menuTitle
= wxStripMenuCodes(title
);
655 size_t count
= GetMenuCount();
656 for ( size_t i
= 0; i
< count
; i
++ )
658 wxString title
= wxStripMenuCodes(m_titles
[i
]);
659 if ( menuTitle
== title
)
668 // ---------------------------------------------------------------------------
669 // wxMenuBar construction
670 // ---------------------------------------------------------------------------
672 // ---------------------------------------------------------------------------
673 // wxMenuBar construction
674 // ---------------------------------------------------------------------------
676 wxMenu
*wxMenuBar::Replace(size_t pos
, wxMenu
*menu
, const wxString
& title
)
678 wxMenu
*menuOld
= wxMenuBarBase::Replace(pos
, menu
, title
);
681 m_titles
[pos
] = title
;
685 if (s_macInstalledMenuBar
== this)
687 menuOld
->MacAfterDisplay( false ) ;
688 ::DeleteMenu( menuOld
->MacGetMenuId() /* m_menus[pos]->MacGetMenuId() */ ) ;
690 menu
->MacBeforeDisplay( false ) ;
691 UMASetMenuTitle( MAC_WXHMENU(menu
->GetHMenu()) , title
, m_font
.GetEncoding() ) ;
692 if ( pos
== m_menus
.GetCount() - 1)
694 ::InsertMenu( MAC_WXHMENU(menu
->GetHMenu()) , 0 ) ;
698 ::InsertMenu( MAC_WXHMENU(menu
->GetHMenu()) , m_menus
[pos
+1]->MacGetMenuId() ) ;
709 bool wxMenuBar::Insert(size_t pos
, wxMenu
*menu
, const wxString
& title
)
711 if ( !wxMenuBarBase::Insert(pos
, menu
, title
) )
714 m_titles
.Insert(title
, pos
);
716 UMASetMenuTitle( MAC_WXHMENU(menu
->GetHMenu()) , title
, m_font
.GetEncoding() ) ;
718 if ( IsAttached() && s_macInstalledMenuBar
== this )
720 if (s_macInstalledMenuBar
== this)
722 menu
->MacBeforeDisplay( false ) ;
723 if ( pos
== (size_t) -1 || pos
+ 1 == m_menus
.GetCount() )
725 ::InsertMenu( MAC_WXHMENU(menu
->GetHMenu()) , 0 ) ;
729 ::InsertMenu( MAC_WXHMENU(menu
->GetHMenu()) , m_menus
[pos
+1]->MacGetMenuId() ) ;
738 wxMenu
*wxMenuBar::Remove(size_t pos
)
740 wxMenu
*menu
= wxMenuBarBase::Remove(pos
);
746 if (s_macInstalledMenuBar
== this)
748 ::DeleteMenu( menu
->MacGetMenuId() /* m_menus[pos]->MacGetMenuId() */ ) ;
754 m_titles
.RemoveAt(pos
);
759 bool wxMenuBar::Append(wxMenu
*menu
, const wxString
& title
)
761 WXHMENU submenu
= menu
? menu
->GetHMenu() : 0;
762 wxCHECK_MSG( submenu
, FALSE
, wxT("can't append invalid menu to menubar") );
764 if ( !wxMenuBarBase::Append(menu
, title
) )
769 UMASetMenuTitle( MAC_WXHMENU(menu
->GetHMenu()) , title
, m_font
.GetEncoding() ) ;
773 if (s_macInstalledMenuBar
== this)
775 ::InsertMenu( MAC_WXHMENU(menu
->GetHMenu()) , 0 ) ;
781 // m_invokingWindow is set after wxFrame::SetMenuBar(). This call enables
782 // adding menu later on.
783 if (m_invokingWindow
)
784 wxMenubarSetInvokingWindow( menu
, m_invokingWindow
);
789 static void wxMenubarUnsetInvokingWindow( wxMenu
*menu
)
791 menu
->SetInvokingWindow( (wxWindow
*) NULL
);
793 wxMenuItemList::Node
*node
= menu
->GetMenuItems().GetFirst();
796 wxMenuItem
*menuitem
= node
->GetData();
797 if (menuitem
->IsSubMenu())
798 wxMenubarUnsetInvokingWindow( menuitem
->GetSubMenu() );
799 node
= node
->GetNext();
803 static void wxMenubarSetInvokingWindow( wxMenu
*menu
, wxWindow
*win
)
805 menu
->SetInvokingWindow( win
);
807 wxMenuItemList::Node
*node
= menu
->GetMenuItems().GetFirst();
810 wxMenuItem
*menuitem
= node
->GetData();
811 if (menuitem
->IsSubMenu())
812 wxMenubarSetInvokingWindow( menuitem
->GetSubMenu() , win
);
813 node
= node
->GetNext();
817 void wxMenuBar::UnsetInvokingWindow()
819 m_invokingWindow
= (wxWindow
*) NULL
;
820 wxMenuList::Node
*node
= m_menus
.GetFirst();
823 wxMenu
*menu
= node
->GetData();
824 wxMenubarUnsetInvokingWindow( menu
);
825 node
= node
->GetNext();
829 void wxMenuBar::SetInvokingWindow(wxFrame
*frame
)
831 m_invokingWindow
= frame
;
832 wxMenuList::Node
*node
= m_menus
.GetFirst();
835 wxMenu
*menu
= node
->GetData();
836 wxMenubarSetInvokingWindow( menu
, frame
);
837 node
= node
->GetNext();
841 void wxMenuBar::Detach()
843 wxMenuBarBase::Detach() ;
846 void wxMenuBar::Attach(wxFrame
*frame
)
848 wxMenuBarBase::Attach( frame
) ;
850 // ---------------------------------------------------------------------------
851 // wxMenuBar searching for menu items
852 // ---------------------------------------------------------------------------
854 // Find the itemString in menuString, and return the item id or wxNOT_FOUND
855 int wxMenuBar::FindMenuItem(const wxString
& menuString
,
856 const wxString
& itemString
) const
858 wxString menuLabel
= wxStripMenuCodes(menuString
);
859 size_t count
= GetMenuCount();
860 for ( size_t i
= 0; i
< count
; i
++ )
862 wxString title
= wxStripMenuCodes(m_titles
[i
]);
863 if ( menuLabel
== title
)
864 return m_menus
[i
]->FindItem(itemString
);
870 wxMenuItem
*wxMenuBar::FindItem(int id
, wxMenu
**itemMenu
) const
875 wxMenuItem
*item
= NULL
;
876 size_t count
= GetMenuCount();
877 for ( size_t i
= 0; !item
&& (i
< count
); i
++ )
879 item
= m_menus
[i
]->FindItem(id
, itemMenu
);