1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: common/menucmn.cpp
3 // Purpose: wxMenu and wxMenuBar methods common to all ports
4 // Author: Vadim Zeitlin
8 // Copyright: (c) wxWindows team
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
21 #pragma implementation "menubase.h"
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
41 // ----------------------------------------------------------------------------
43 // ----------------------------------------------------------------------------
45 #include "wx/listimpl.cpp"
47 WX_DEFINE_LIST(wxMenuList
);
48 WX_DEFINE_LIST(wxMenuItemList
);
50 // ============================================================================
52 // ============================================================================
54 // ----------------------------------------------------------------------------
56 // ----------------------------------------------------------------------------
58 wxMenuItemBase::wxMenuItemBase(wxMenu
*parentMenu
,
67 wxASSERT_MSG( parentMenu
!= NULL
, wxT("menuitem should have a menu") );
69 m_parentMenu
= parentMenu
;
77 wxMenuItemBase::~wxMenuItemBase()
84 static inline bool CompareAccelString(const wxString
& str
, const wxChar
*accel
)
87 return str
== accel
|| str
== wxGetTranslation(accel
);
93 // return wxAcceleratorEntry for the given menu string or NULL if none
95 wxAcceleratorEntry
*wxGetAccelFromString(const wxString
& label
)
97 // check for accelerators: they are given after '\t'
98 int posTab
= label
.Find(wxT('\t'));
99 if ( posTab
!= wxNOT_FOUND
) {
100 // parse the accelerator string
102 int accelFlags
= wxACCEL_NORMAL
;
104 for ( size_t n
= (size_t)posTab
+ 1; n
< label
.Len(); n
++ ) {
105 if ( (label
[n
] == '+') || (label
[n
] == '-') ) {
106 if ( CompareAccelString(current
, wxTRANSLATE("ctrl")) )
107 accelFlags
|= wxACCEL_CTRL
;
108 else if ( CompareAccelString(current
, wxTRANSLATE("alt")) )
109 accelFlags
|= wxACCEL_ALT
;
110 else if ( CompareAccelString(current
, wxTRANSLATE("shift")) )
111 accelFlags
|= wxACCEL_SHIFT
;
113 // we may have "Ctrl-+", for example, but we still want to
114 // catch typos like "Crtl-A" so only give the warning if we
115 // have something before the current '+' or '-', else take
116 // it as a literal symbol
117 if ( current
.empty() )
121 // skip clearing it below
126 wxLogDebug(wxT("Unknown accel modifier: '%s'"),
134 current
+= wxTolower(label
[n
]);
138 if ( current
.IsEmpty() ) {
139 wxLogDebug(wxT("No accel key found, accel string ignored."));
142 if ( current
.Len() == 1 ) {
144 keyCode
= current
[0U];
146 // Only call wxToupper if control, alt, or shift is held down,
147 // otherwise lower case accelerators won't work.
148 if (accelFlags
!= wxACCEL_NORMAL
) {
149 keyCode
= wxToupper(keyCode
);
153 // is it a function key?
154 if ( current
[0U] == 'f' && isdigit(current
[1U]) &&
155 (current
.Len() == 2 ||
156 (current
.Len() == 3 && isdigit(current
[2U]))) ) {
158 wxSscanf(current
.c_str() + 1, wxT("%d"), &n
);
160 keyCode
= WXK_F1
+ n
- 1;
163 // several special cases
165 if ( current
== wxT("DEL") )
166 keyCode
= WXK_DELETE
;
167 else if ( current
== wxT("DELETE") )
168 keyCode
= WXK_DELETE
;
169 else if ( current
== wxT("INS") )
170 keyCode
= WXK_INSERT
;
171 else if ( current
== wxT("INSERT") )
172 keyCode
= WXK_INSERT
;
173 else if ( current
== wxT("ENTER") || current
== wxT("RETURN") )
174 keyCode
= WXK_RETURN
;
175 else if ( current
== wxT("PGUP") )
177 else if ( current
== wxT("PGDN") )
179 else if ( current
== wxT("LEFT") )
181 else if ( current
== wxT("RIGHT") )
183 else if ( current
== wxT("UP") )
185 else if ( current
== wxT("DOWN") )
187 else if ( current
== wxT("HOME") )
189 else if ( current
== wxT("END") )
191 else if ( current
== wxT("SPACE") )
193 else if ( current
== wxT("TAB") )
195 else if ( current
== wxT("ESC") || current
== wxT("ESCAPE") )
196 keyCode
= WXK_ESCAPE
;
199 wxLogDebug(wxT("Unrecognized accel key '%s', accel string ignored."),
207 // we do have something
208 return new wxAcceleratorEntry(accelFlags
, keyCode
);
212 return (wxAcceleratorEntry
*)NULL
;
215 wxAcceleratorEntry
*wxMenuItemBase::GetAccel() const
217 return wxGetAccelFromString(GetText());
220 void wxMenuItemBase::SetAccel(wxAcceleratorEntry
*accel
)
222 wxString text
= m_text
.BeforeFirst(wxT('\t'));
227 int flags
= accel
->GetFlags();
228 if ( flags
& wxACCEL_ALT
)
230 if ( flags
& wxACCEL_CTRL
)
231 text
+= wxT("Ctrl-");
232 if ( flags
& wxACCEL_SHIFT
)
233 text
+= wxT("Shift-");
235 int code
= accel
->GetKeyCode();
250 text
<< wxT('F') << code
- WXK_F1
+ 1;
253 // if there are any other keys wxGetAccelFromString() may return,
254 // we should process them here
257 if ( wxIsalnum(code
) )
259 text
<< (wxChar
)code
;
264 wxFAIL_MSG( wxT("unknown keyboard accel") );
271 #endif // wxUSE_ACCEL
273 // ----------------------------------------------------------------------------
274 // wxMenu ctor and dtor
275 // ----------------------------------------------------------------------------
277 void wxMenuBase::Init(long style
)
279 m_items
.DeleteContents(TRUE
);
281 m_menuBar
= (wxMenuBar
*)NULL
;
282 m_menuParent
= (wxMenu
*)NULL
;
284 m_invokingWindow
= (wxWindow
*)NULL
;
286 m_clientData
= (void *)NULL
;
287 m_eventHandler
= this;
289 #if wxUSE_MENU_CALLBACK
290 m_callback
= (wxFunction
) NULL
;
291 #endif // wxUSE_MENU_CALLBACK
294 wxMenuBase::~wxMenuBase()
296 // nothing to do, wxMenuItemList dtor will delete the menu items.
298 // Actually, in GTK, the submenus have to get deleted first.
301 // ----------------------------------------------------------------------------
302 // wxMenu item adding/removing
303 // ----------------------------------------------------------------------------
305 void wxMenuBase::AddSubMenu(wxMenu
*submenu
)
307 wxCHECK_RET( submenu
, _T("can't add a NULL submenu") );
311 submenu
->Attach(m_menuBar
);
314 submenu
->SetParent((wxMenu
*)this);
317 bool wxMenuBase::DoAppend(wxMenuItem
*item
)
319 wxCHECK_MSG( item
, FALSE
, wxT("invalid item in wxMenu::Append()") );
321 m_items
.Append(item
);
322 item
->SetMenu((wxMenu
*)this);
323 if ( item
->IsSubMenu() )
325 AddSubMenu(item
->GetSubMenu());
331 bool wxMenuBase::Insert(size_t pos
, wxMenuItem
*item
)
333 wxCHECK_MSG( item
, FALSE
, wxT("invalid item in wxMenu::Insert") );
335 if ( pos
== GetMenuItemCount() )
337 return DoAppend(item
);
341 wxCHECK_MSG( pos
< GetMenuItemCount(), FALSE
,
342 wxT("invalid index in wxMenu::Insert") );
344 return DoInsert(pos
, item
);
348 bool wxMenuBase::DoInsert(size_t pos
, wxMenuItem
*item
)
350 wxCHECK_MSG( item
, FALSE
, wxT("invalid item in wxMenu::Insert()") );
352 wxMenuItemList::Node
*node
= m_items
.Item(pos
);
353 wxCHECK_MSG( node
, FALSE
, wxT("invalid index in wxMenu::Insert()") );
355 m_items
.Insert(node
, item
);
356 item
->SetMenu((wxMenu
*)this);
357 if ( item
->IsSubMenu() )
359 AddSubMenu(item
->GetSubMenu());
365 wxMenuItem
*wxMenuBase::Remove(wxMenuItem
*item
)
367 wxCHECK_MSG( item
, NULL
, wxT("invalid item in wxMenu::Remove") );
369 return DoRemove(item
);
372 wxMenuItem
*wxMenuBase::DoRemove(wxMenuItem
*item
)
374 wxMenuItemList::Node
*node
= m_items
.Find(item
);
376 // if we get here, the item is valid or one of Remove() functions is broken
377 wxCHECK_MSG( node
, NULL
, wxT("bug in wxMenu::Remove logic") );
379 // we detach the item, but we do delete the list node (i.e. don't call
380 // DetachNode() here!)
381 node
->SetData((wxMenuItem
*)NULL
); // to prevent it from deleting the item
382 m_items
.DeleteNode(node
);
384 // item isn't attached to anything any more
385 item
->SetMenu((wxMenu
*)NULL
);
386 wxMenu
*submenu
= item
->GetSubMenu();
389 submenu
->SetParent((wxMenu
*)NULL
);
395 bool wxMenuBase::Delete(wxMenuItem
*item
)
397 wxCHECK_MSG( item
, FALSE
, wxT("invalid item in wxMenu::Delete") );
399 return DoDelete(item
);
402 bool wxMenuBase::DoDelete(wxMenuItem
*item
)
404 wxMenuItem
*item2
= DoRemove(item
);
405 wxCHECK_MSG( item2
, FALSE
, wxT("failed to delete menu item") );
407 // don't delete the submenu
408 item2
->SetSubMenu((wxMenu
*)NULL
);
415 bool wxMenuBase::Destroy(wxMenuItem
*item
)
417 wxCHECK_MSG( item
, FALSE
, wxT("invalid item in wxMenu::Destroy") );
419 return DoDestroy(item
);
422 bool wxMenuBase::DoDestroy(wxMenuItem
*item
)
424 wxMenuItem
*item2
= DoRemove(item
);
425 wxCHECK_MSG( item2
, FALSE
, wxT("failed to delete menu item") );
432 // ----------------------------------------------------------------------------
433 // wxMenu searching for items
434 // ----------------------------------------------------------------------------
436 // Finds the item id matching the given string, -1 if not found.
437 int wxMenuBase::FindItem(const wxString
& text
) const
439 wxString label
= wxMenuItem::GetLabelFromText(text
);
440 for ( wxMenuItemList::Node
*node
= m_items
.GetFirst();
442 node
= node
->GetNext() )
444 wxMenuItem
*item
= node
->GetData();
445 if ( item
->IsSubMenu() )
447 int rc
= item
->GetSubMenu()->FindItem(label
);
448 if ( rc
!= wxNOT_FOUND
)
452 // we execute this code for submenus as well to alllow finding them by
453 // name just like the ordinary items
454 if ( !item
->IsSeparator() )
456 if ( item
->GetLabel() == label
)
457 return item
->GetId();
464 // recursive search for item by id
465 wxMenuItem
*wxMenuBase::FindItem(int itemId
, wxMenu
**itemMenu
) const
470 wxMenuItem
*item
= NULL
;
471 for ( wxMenuItemList::Node
*node
= m_items
.GetFirst();
473 node
= node
->GetNext() )
475 item
= node
->GetData();
477 if ( item
->GetId() == itemId
)
480 *itemMenu
= (wxMenu
*)this;
482 else if ( item
->IsSubMenu() )
484 item
= item
->GetSubMenu()->FindItem(itemId
, itemMenu
);
488 // don't exit the loop
496 // non recursive search
497 wxMenuItem
*wxMenuBase::FindChildItem(int id
, size_t *ppos
) const
499 wxMenuItem
*item
= (wxMenuItem
*)NULL
;
500 wxMenuItemList::Node
*node
= GetMenuItems().GetFirst();
503 for ( pos
= 0; node
; pos
++ )
505 if ( node
->GetData()->GetId() == id
)
507 item
= node
->GetData();
512 node
= node
->GetNext();
517 *ppos
= item
? pos
: (size_t)wxNOT_FOUND
;
524 wxMenuItem
* wxMenuBase::FindItemByPosition(size_t position
) const
526 wxCHECK_MSG( position
< m_items
.GetCount(), NULL
,
527 _T("wxMenu::FindItemByPosition(): invalid menu index") );
529 return m_items
.Item( position
)->GetData();
532 // ----------------------------------------------------------------------------
533 // wxMenu helpers used by derived classes
534 // ----------------------------------------------------------------------------
536 // Update a menu and all submenus recursively. source is the object that has
537 // the update event handlers defined for it. If NULL, the menu or associated
538 // window will be used.
539 void wxMenuBase::UpdateUI(wxEvtHandler
* source
)
541 if ( !source
&& GetInvokingWindow() )
542 source
= GetInvokingWindow()->GetEventHandler();
544 source
= GetEventHandler();
548 wxMenuItemList::Node
* node
= GetMenuItems().GetFirst();
551 wxMenuItem
* item
= node
->GetData();
552 if ( !item
->IsSeparator() )
554 wxWindowID id
= item
->GetId();
555 wxUpdateUIEvent
event(id
);
556 event
.SetEventObject( source
);
558 if ( source
->ProcessEvent(event
) )
560 // if anything changed, update the chanegd attribute
561 if (event
.GetSetText())
562 SetLabel(id
, event
.GetText());
563 if (event
.GetSetChecked())
564 Check(id
, event
.GetChecked());
565 if (event
.GetSetEnabled())
566 Enable(id
, event
.GetEnabled());
569 // recurse to the submenus
570 if ( item
->GetSubMenu() )
571 item
->GetSubMenu()->UpdateUI(source
);
573 //else: item is a separator (which don't process update UI events)
575 node
= node
->GetNext();
579 bool wxMenuBase::SendEvent(int id
, int checked
)
581 wxCommandEvent
event(wxEVT_COMMAND_MENU_SELECTED
, id
);
582 event
.SetEventObject(this);
583 event
.SetInt(checked
);
585 bool processed
= FALSE
;
587 #if wxUSE_MENU_CALLBACK
591 (void)(*(m_callback
))(*this, event
);
594 #endif // wxUSE_MENU_CALLBACK
596 // Try the menu's event handler
599 wxEvtHandler
*handler
= GetEventHandler();
601 processed
= handler
->ProcessEvent(event
);
604 // Try the window the menu was popped up from (and up through the
608 const wxMenuBase
*menu
= this;
611 wxWindow
*win
= menu
->GetInvokingWindow();
614 processed
= win
->GetEventHandler()->ProcessEvent(event
);
618 menu
= menu
->GetParent();
625 // ----------------------------------------------------------------------------
626 // wxMenu attaching/detaching to/from menu bar
627 // ----------------------------------------------------------------------------
629 void wxMenuBase::Attach(wxMenuBarBase
*menubar
)
631 // use Detach() instead!
632 wxASSERT_MSG( menubar
, _T("menu can't be attached to NULL menubar") );
634 // use IsAttached() to prevent this from happening
635 wxASSERT_MSG( !m_menuBar
, _T("attaching menu twice?") );
637 m_menuBar
= (wxMenuBar
*)menubar
;
640 void wxMenuBase::Detach()
642 // use IsAttached() to prevent this from happening
643 wxASSERT_MSG( m_menuBar
, _T("detaching unattached menu?") );
648 // ----------------------------------------------------------------------------
649 // wxMenu functions forwarded to wxMenuItem
650 // ----------------------------------------------------------------------------
652 void wxMenuBase::Enable( int id
, bool enable
)
654 wxMenuItem
*item
= FindItem(id
);
656 wxCHECK_RET( item
, wxT("wxMenu::Enable: no such item") );
658 item
->Enable(enable
);
661 bool wxMenuBase::IsEnabled( int id
) const
663 wxMenuItem
*item
= FindItem(id
);
665 wxCHECK_MSG( item
, FALSE
, wxT("wxMenu::IsEnabled: no such item") );
667 return item
->IsEnabled();
670 void wxMenuBase::Check( int id
, bool enable
)
672 wxMenuItem
*item
= FindItem(id
);
674 wxCHECK_RET( item
, wxT("wxMenu::Check: no such item") );
679 bool wxMenuBase::IsChecked( int id
) const
681 wxMenuItem
*item
= FindItem(id
);
683 wxCHECK_MSG( item
, FALSE
, wxT("wxMenu::IsChecked: no such item") );
685 return item
->IsChecked();
688 void wxMenuBase::SetLabel( int id
, const wxString
&label
)
690 wxMenuItem
*item
= FindItem(id
);
692 wxCHECK_RET( item
, wxT("wxMenu::SetLabel: no such item") );
694 item
->SetText(label
);
697 wxString
wxMenuBase::GetLabel( int id
) const
699 wxMenuItem
*item
= FindItem(id
);
701 wxCHECK_MSG( item
, wxT(""), wxT("wxMenu::GetLabel: no such item") );
703 return item
->GetText();
706 void wxMenuBase::SetHelpString( int id
, const wxString
& helpString
)
708 wxMenuItem
*item
= FindItem(id
);
710 wxCHECK_RET( item
, wxT("wxMenu::SetHelpString: no such item") );
712 item
->SetHelp( helpString
);
715 wxString
wxMenuBase::GetHelpString( int id
) const
717 wxMenuItem
*item
= FindItem(id
);
719 wxCHECK_MSG( item
, wxT(""), wxT("wxMenu::GetHelpString: no such item") );
721 return item
->GetHelp();
724 // ----------------------------------------------------------------------------
725 // wxMenuBarBase ctor and dtor
726 // ----------------------------------------------------------------------------
728 wxMenuBarBase::wxMenuBarBase()
730 // we own the menus when we get them
731 m_menus
.DeleteContents(TRUE
);
734 m_menuBarFrame
= NULL
;
737 wxMenuBarBase::~wxMenuBarBase()
739 // nothing to do, the list will delete the menus because of the call to
740 // DeleteContents() above
743 // ----------------------------------------------------------------------------
744 // wxMenuBar item access: the base class versions manage m_menus list, the
745 // derived class should reflect the changes in the real menubar
746 // ----------------------------------------------------------------------------
748 wxMenu
*wxMenuBarBase::GetMenu(size_t pos
) const
750 wxMenuList::Node
*node
= m_menus
.Item(pos
);
751 wxCHECK_MSG( node
, NULL
, wxT("bad index in wxMenuBar::GetMenu()") );
753 return node
->GetData();
756 bool wxMenuBarBase::Append(wxMenu
*menu
, const wxString
& WXUNUSED(title
))
758 wxCHECK_MSG( menu
, FALSE
, wxT("can't append NULL menu") );
760 m_menus
.Append(menu
);
766 bool wxMenuBarBase::Insert(size_t pos
, wxMenu
*menu
,
767 const wxString
& title
)
769 if ( pos
== m_menus
.GetCount() )
771 return wxMenuBarBase::Append(menu
, title
);
773 else // not at the end
775 wxCHECK_MSG( menu
, FALSE
, wxT("can't insert NULL menu") );
777 wxMenuList::Node
*node
= m_menus
.Item(pos
);
778 wxCHECK_MSG( node
, FALSE
, wxT("bad index in wxMenuBar::Insert()") );
780 m_menus
.Insert(node
, menu
);
787 wxMenu
*wxMenuBarBase::Replace(size_t pos
, wxMenu
*menu
,
788 const wxString
& WXUNUSED(title
))
790 wxCHECK_MSG( menu
, NULL
, wxT("can't insert NULL menu") );
792 wxMenuList::Node
*node
= m_menus
.Item(pos
);
793 wxCHECK_MSG( node
, NULL
, wxT("bad index in wxMenuBar::Replace()") );
795 wxMenu
*menuOld
= node
->GetData();
804 wxMenu
*wxMenuBarBase::Remove(size_t pos
)
806 wxMenuList::Node
*node
= m_menus
.Item(pos
);
807 wxCHECK_MSG( node
, NULL
, wxT("bad index in wxMenuBar::Remove()") );
809 node
= m_menus
.DetachNode(node
);
810 wxCHECK( node
, NULL
); // unexpected
811 wxMenu
*menu
= node
->GetData();
819 int wxMenuBarBase::FindMenu(const wxString
& title
) const
821 wxString label
= wxMenuItem::GetLabelFromText(title
);
823 size_t count
= GetMenuCount();
824 for ( size_t i
= 0; i
< count
; i
++ )
826 wxString title2
= GetLabelTop(i
);
827 if ( (title2
== title
) ||
828 (wxMenuItem::GetLabelFromText(title2
) == label
) )
839 // ----------------------------------------------------------------------------
840 // wxMenuBar attaching/detaching to/from the frame
841 // ----------------------------------------------------------------------------
843 void wxMenuBarBase::Attach(wxFrame
*frame
)
845 wxASSERT_MSG( !IsAttached(), wxT("menubar already attached!") );
847 m_menuBarFrame
= frame
;
850 void wxMenuBarBase::Detach()
852 wxASSERT_MSG( IsAttached(), wxT("detaching unattached menubar") );
854 m_menuBarFrame
= NULL
;
857 // ----------------------------------------------------------------------------
858 // wxMenuBar searching for items
859 // ----------------------------------------------------------------------------
861 wxMenuItem
*wxMenuBarBase::FindItem(int id
, wxMenu
**menu
) const
866 wxMenuItem
*item
= NULL
;
867 size_t count
= GetMenuCount();
868 for ( size_t i
= 0; !item
&& (i
< count
); i
++ )
870 item
= m_menus
[i
]->FindItem(id
, menu
);
876 int wxMenuBarBase::FindMenuItem(const wxString
& menu
, const wxString
& item
) const
878 wxString label
= wxMenuItem::GetLabelFromText(menu
);
881 wxMenuList::Node
*node
;
882 for ( node
= m_menus
.GetFirst(); node
; node
= node
->GetNext(), i
++ )
884 if ( label
== wxMenuItem::GetLabelFromText(GetLabelTop(i
)) )
885 return node
->GetData()->FindItem(item
);
891 // ---------------------------------------------------------------------------
892 // wxMenuBar functions forwarded to wxMenuItem
893 // ---------------------------------------------------------------------------
895 void wxMenuBarBase::Enable(int id
, bool enable
)
897 wxMenuItem
*item
= FindItem(id
);
899 wxCHECK_RET( item
, wxT("attempt to enable an item which doesn't exist") );
901 item
->Enable(enable
);
904 void wxMenuBarBase::Check(int id
, bool check
)
906 wxMenuItem
*item
= FindItem(id
);
908 wxCHECK_RET( item
, wxT("attempt to check an item which doesn't exist") );
909 wxCHECK_RET( item
->IsCheckable(), wxT("attempt to check an uncheckable item") );
914 bool wxMenuBarBase::IsChecked(int id
) const
916 wxMenuItem
*item
= FindItem(id
);
918 wxCHECK_MSG( item
, FALSE
, wxT("wxMenuBar::IsChecked(): no such item") );
920 return item
->IsChecked();
923 bool wxMenuBarBase::IsEnabled(int id
) const
925 wxMenuItem
*item
= FindItem(id
);
927 wxCHECK_MSG( item
, FALSE
, wxT("wxMenuBar::IsEnabled(): no such item") );
929 return item
->IsEnabled();
932 void wxMenuBarBase::SetLabel(int id
, const wxString
& label
)
934 wxMenuItem
*item
= FindItem(id
);
936 wxCHECK_RET( item
, wxT("wxMenuBar::SetLabel(): no such item") );
938 item
->SetText(label
);
941 wxString
wxMenuBarBase::GetLabel(int id
) const
943 wxMenuItem
*item
= FindItem(id
);
945 wxCHECK_MSG( item
, wxEmptyString
,
946 wxT("wxMenuBar::GetLabel(): no such item") );
948 return item
->GetText();
951 void wxMenuBarBase::SetHelpString(int id
, const wxString
& helpString
)
953 wxMenuItem
*item
= FindItem(id
);
955 wxCHECK_RET( item
, wxT("wxMenuBar::SetHelpString(): no such item") );
957 item
->SetHelp(helpString
);
960 wxString
wxMenuBarBase::GetHelpString(int id
) const
962 wxMenuItem
*item
= FindItem(id
);
964 wxCHECK_MSG( item
, wxEmptyString
,
965 wxT("wxMenuBar::GetHelpString(): no such item") );
967 return item
->GetHelp();
970 #endif // wxUSE_MENUS