///////////////////////////////////////////////////////////////////////////////
-// Name: common/menucmn.cpp
+// Name: src/common/menucmn.cpp
// Purpose: wxMenu and wxMenuBar methods common to all ports
// Author: Vadim Zeitlin
// Modified by:
// Created: 26.10.99
// RCS-ID: $Id$
-// Copyright: (c) wxWindows team
-// Licence: wxWindows license
+// Copyright: (c) wxWidgets team
+// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
// ============================================================================
// headers
// ----------------------------------------------------------------------------
-#ifdef __GNUG__
- #pragma implementation "menubase.h"
-#endif
-
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
-#include <ctype.h>
-
#ifdef __BORLANDC__
#pragma hdrstop
#endif
+#if wxUSE_MENUS
+
#ifndef WX_PRECOMP
+ #include "wx/intl.h"
+ #include "wx/log.h"
#include "wx/menu.h"
#endif
+#include "wx/stockitem.h"
+
// ----------------------------------------------------------------------------
// template lists
// ----------------------------------------------------------------------------
#include "wx/listimpl.cpp"
-WX_DEFINE_LIST(wxMenuList);
-WX_DEFINE_LIST(wxMenuItemList);
+WX_DEFINE_LIST(wxMenuList)
+WX_DEFINE_LIST(wxMenuItemList)
// ============================================================================
// implementation
// ============================================================================
// ----------------------------------------------------------------------------
-// wxMenuItem
+// wxMenuItemBase
// ----------------------------------------------------------------------------
+wxMenuItemBase::wxMenuItemBase(wxMenu *parentMenu,
+ int id,
+ const wxString& text,
+ const wxString& help,
+ wxItemKind kind,
+ wxMenu *subMenu)
+{
+ wxASSERT_MSG( parentMenu != NULL, wxT("menuitem should have a menu") );
+
+ m_parentMenu = parentMenu;
+ m_subMenu = subMenu;
+ m_isEnabled = true;
+ m_isChecked = false;
+ m_id = id;
+ m_kind = kind;
+ if (m_id == wxID_ANY)
+ m_id = wxNewId();
+ if (m_id == wxID_SEPARATOR)
+ m_kind = wxITEM_SEPARATOR;
+
+ SetText(text);
+ SetHelp(help);
+}
+
wxMenuItemBase::~wxMenuItemBase()
{
- if (m_subMenu)
- delete m_subMenu;
+ delete m_subMenu;
}
#if wxUSE_ACCEL
+wxAcceleratorEntry *wxMenuItemBase::GetAccel() const
+{
+ return wxAcceleratorEntry::Create(GetText());
+}
+
void wxMenuItemBase::SetAccel(wxAcceleratorEntry *accel)
{
wxString text = m_text.BeforeFirst(wxT('\t'));
if ( accel )
{
text += wxT('\t');
+ text += accel->ToString();
+ }
- int flags = accel->GetFlags();
- if ( flags & wxACCEL_ALT )
- text += wxT("Alt-");
- if ( flags & wxACCEL_CTRL )
- text += wxT("Ctrl-");
- if ( flags & wxACCEL_SHIFT )
- text += wxT("Shift-");
+ SetText(text);
+}
- int code = accel->GetKeyCode();
- switch ( code )
- {
- case WXK_F1:
- case WXK_F2:
- case WXK_F3:
- case WXK_F4:
- case WXK_F5:
- case WXK_F6:
- case WXK_F7:
- case WXK_F8:
- case WXK_F9:
- case WXK_F10:
- case WXK_F11:
- case WXK_F12:
- text << wxT('F') << code - WXK_F1 + 1;
- break;
+#endif // wxUSE_ACCEL
- // if there are any other keys wxGetAccelFromString() may return,
- // we should process them here
+void wxMenuItemBase::SetText(const wxString& str)
+{
+ m_text = str;
- default:
- if ( wxIsalnum(code) )
- {
- text << (wxChar)code;
+ if ( m_text.empty() && !IsSeparator() )
+ {
+ wxASSERT_MSG( wxIsStockID(GetId()),
+ wxT("A non-stock menu item with an empty label?") );
+ m_text = wxGetStockLabel(GetId(), wxSTOCK_WITH_ACCELERATOR |
+ wxSTOCK_WITH_MNEMONIC);
+ }
+}
- break;
- }
+void wxMenuItemBase::SetHelp(const wxString& str)
+{
+ m_help = str;
- wxFAIL_MSG( wxT("unknown keyboard accel") );
- }
+ if ( m_help.empty() && !IsSeparator() && wxIsStockID(GetId()) )
+ {
+ // get a stock help string
+ m_help = wxGetStockHelpString(GetId());
}
-
- SetText(text);
}
-#endif // wxUSE_ACCEL
+bool wxMenuBase::ms_locked = true;
// ----------------------------------------------------------------------------
// wxMenu ctor and dtor
void wxMenuBase::Init(long style)
{
- m_items.DeleteContents(TRUE);
-
m_menuBar = (wxMenuBar *)NULL;
m_menuParent = (wxMenu *)NULL;
m_style = style;
m_clientData = (void *)NULL;
m_eventHandler = this;
-
-#if wxUSE_MENU_CALLBACK
- m_callback = (wxFunction) NULL;
-#endif // wxUSE_MENU_CALLBACK
}
wxMenuBase::~wxMenuBase()
{
- // nothing to do, wxMenuItemList dtor will delete the menu items.
- // Actually, in GTK, the submenus have to get deleted first.
+ WX_CLEAR_LIST(wxMenuItemList, m_items);
+
+ // Actually, in GTK, the submenus have to get deleted first.
}
// ----------------------------------------------------------------------------
// wxMenu item adding/removing
// ----------------------------------------------------------------------------
-bool wxMenuBase::DoAppend(wxMenuItem *item)
+void wxMenuBase::AddSubMenu(wxMenu *submenu)
{
- wxCHECK_MSG( item, FALSE, wxT("invalid item in wxMenu::Append()") );
+ wxCHECK_RET( submenu, _T("can't add a NULL submenu") );
+
+ submenu->SetParent((wxMenu *)this);
+}
+
+wxMenuItem* wxMenuBase::DoAppend(wxMenuItem *item)
+{
+ wxCHECK_MSG( item, NULL, wxT("invalid item in wxMenu::Append()") );
m_items.Append(item);
+ item->SetMenu((wxMenu*)this);
+ if ( item->IsSubMenu() )
+ {
+ AddSubMenu(item->GetSubMenu());
+ }
- return TRUE;
+ return item;
}
-bool wxMenuBase::Insert(size_t pos, wxMenuItem *item)
+wxMenuItem* wxMenuBase::Insert(size_t pos, wxMenuItem *item)
{
- wxCHECK_MSG( item, FALSE, wxT("invalid item in wxMenu::Insert") );
+ wxCHECK_MSG( item, NULL, wxT("invalid item in wxMenu::Insert") );
if ( pos == GetMenuItemCount() )
{
}
else
{
- wxCHECK_MSG( pos < GetMenuItemCount(), FALSE,
+ wxCHECK_MSG( pos < GetMenuItemCount(), NULL,
wxT("invalid index in wxMenu::Insert") );
return DoInsert(pos, item);
}
}
-bool wxMenuBase::DoInsert(size_t pos, wxMenuItem *item)
+wxMenuItem* wxMenuBase::DoInsert(size_t pos, wxMenuItem *item)
{
- wxCHECK_MSG( item, FALSE, wxT("invalid item in wxMenu::Insert()") );
+ wxCHECK_MSG( item, NULL, wxT("invalid item in wxMenu::Insert()") );
- wxMenuItemList::Node *node = m_items.Item(pos);
- wxCHECK_MSG( node, FALSE, wxT("invalid index in wxMenu::Insert()") );
+ wxMenuItemList::compatibility_iterator node = m_items.Item(pos);
+ wxCHECK_MSG( node, NULL, wxT("invalid index in wxMenu::Insert()") );
m_items.Insert(node, item);
+ item->SetMenu((wxMenu*)this);
+ if ( item->IsSubMenu() )
+ {
+ AddSubMenu(item->GetSubMenu());
+ }
- return TRUE;
+ return item;
}
wxMenuItem *wxMenuBase::Remove(wxMenuItem *item)
wxMenuItem *wxMenuBase::DoRemove(wxMenuItem *item)
{
- wxMenuItemList::Node *node = m_items.Find(item);
+ wxMenuItemList::compatibility_iterator node = m_items.Find(item);
// if we get here, the item is valid or one of Remove() functions is broken
wxCHECK_MSG( node, NULL, wxT("bug in wxMenu::Remove logic") );
// we detach the item, but we do delete the list node (i.e. don't call
// DetachNode() here!)
- node->SetData((wxMenuItem *)NULL); // to prevent it from deleting the item
- m_items.DeleteNode(node);
+ m_items.Erase(node);
// item isn't attached to anything any more
+ item->SetMenu((wxMenu *)NULL);
wxMenu *submenu = item->GetSubMenu();
if ( submenu )
{
submenu->SetParent((wxMenu *)NULL);
+ if ( submenu->IsAttached() )
+ submenu->Detach();
}
return item;
bool wxMenuBase::Delete(wxMenuItem *item)
{
- wxCHECK_MSG( item, FALSE, wxT("invalid item in wxMenu::Delete") );
+ wxCHECK_MSG( item, false, wxT("invalid item in wxMenu::Delete") );
return DoDelete(item);
}
bool wxMenuBase::DoDelete(wxMenuItem *item)
{
wxMenuItem *item2 = DoRemove(item);
- wxCHECK_MSG( item2, FALSE, wxT("failed to delete menu item") );
+ wxCHECK_MSG( item2, false, wxT("failed to delete menu item") );
// don't delete the submenu
item2->SetSubMenu((wxMenu *)NULL);
delete item2;
- return TRUE;
+ return true;
}
bool wxMenuBase::Destroy(wxMenuItem *item)
{
- wxCHECK_MSG( item, FALSE, wxT("invalid item in wxMenu::Destroy") );
+ wxCHECK_MSG( item, false, wxT("invalid item in wxMenu::Destroy") );
return DoDestroy(item);
}
bool wxMenuBase::DoDestroy(wxMenuItem *item)
{
wxMenuItem *item2 = DoRemove(item);
- wxCHECK_MSG( item2, FALSE, wxT("failed to delete menu item") );
+ wxCHECK_MSG( item2, false, wxT("failed to delete menu item") );
delete item2;
- return TRUE;
+ return true;
}
// ----------------------------------------------------------------------------
// wxMenu searching for items
// ----------------------------------------------------------------------------
-// Finds the item id matching the given string, -1 if not found.
+// Finds the item id matching the given string, wxNOT_FOUND if not found.
int wxMenuBase::FindItem(const wxString& text) const
{
wxString label = wxMenuItem::GetLabelFromText(text);
- for ( wxMenuItemList::Node *node = m_items.GetFirst();
+ for ( wxMenuItemList::compatibility_iterator node = m_items.GetFirst();
node;
node = node->GetNext() )
{
if ( rc != wxNOT_FOUND )
return rc;
}
- else if ( !item->IsSeparator() )
+
+ // we execute this code for submenus as well to alllow finding them by
+ // name just like the ordinary items
+ if ( !item->IsSeparator() )
{
if ( item->GetLabel() == label )
return item->GetId();
*itemMenu = NULL;
wxMenuItem *item = NULL;
- for ( wxMenuItemList::Node *node = m_items.GetFirst();
+ for ( wxMenuItemList::compatibility_iterator node = m_items.GetFirst();
node && !item;
node = node->GetNext() )
{
wxMenuItem *wxMenuBase::FindChildItem(int id, size_t *ppos) const
{
wxMenuItem *item = (wxMenuItem *)NULL;
- wxMenuItemList::Node *node = GetMenuItems().GetFirst();
+ wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst();
size_t pos;
for ( pos = 0; node; pos++ )
return item;
}
+// find by position
+wxMenuItem* wxMenuBase::FindItemByPosition(size_t position) const
+{
+ wxCHECK_MSG( position < m_items.GetCount(), NULL,
+ _T("wxMenu::FindItemByPosition(): invalid menu index") );
+
+ return m_items.Item( position )->GetData();
+}
+
// ----------------------------------------------------------------------------
-// wxMenu helpers
+// wxMenu helpers used by derived classes
// ----------------------------------------------------------------------------
// Update a menu and all submenus recursively. source is the object that has
// window will be used.
void wxMenuBase::UpdateUI(wxEvtHandler* source)
{
+ if (GetInvokingWindow())
+ {
+ // Don't update menus if the parent
+ // frame is about to get deleted
+ wxWindow *tlw = wxGetTopLevelParent( GetInvokingWindow() );
+ if (tlw && wxPendingDelete.Member(tlw))
+ return;
+ }
+
if ( !source && GetInvokingWindow() )
source = GetInvokingWindow()->GetEventHandler();
if ( !source )
if ( !source )
source = this;
- wxMenuItemList::Node* node = GetMenuItems().GetFirst();
+ wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst();
while ( node )
{
wxMenuItem* item = node->GetData();
if ( source->ProcessEvent(event) )
{
- // if anything changed, update the chanegd attribute
+ // if anything changed, update the changed attribute
if (event.GetSetText())
SetLabel(id, event.GetText());
if (event.GetSetChecked())
if ( item->GetSubMenu() )
item->GetSubMenu()->UpdateUI(source);
}
- //else: item is a separator (which don't process update UI events)
+ //else: item is a separator (which doesn't process update UI events)
node = node->GetNext();
}
}
+bool wxMenuBase::SendEvent(int id, int checked)
+{
+ wxCommandEvent event(wxEVT_COMMAND_MENU_SELECTED, id);
+ event.SetEventObject(this);
+ event.SetInt(checked);
+
+ bool processed = false;
+
+ // Try the menu's event handler
+ // if ( !processed )
+ {
+ wxEvtHandler *handler = GetEventHandler();
+ if ( handler )
+ processed = handler->ProcessEvent(event);
+ }
+
+ // Try the window the menu was popped up from (and up through the
+ // hierarchy)
+ if ( !processed )
+ {
+ const wxMenuBase *menu = this;
+ while ( menu )
+ {
+ wxWindow *win = menu->GetInvokingWindow();
+ if ( win )
+ {
+ processed = win->GetEventHandler()->ProcessEvent(event);
+ break;
+ }
+
+ menu = menu->GetParent();
+ }
+ }
+
+ return processed;
+}
+
+// ----------------------------------------------------------------------------
+// wxMenu attaching/detaching to/from menu bar
+// ----------------------------------------------------------------------------
+
+wxMenuBar* wxMenuBase::GetMenuBar() const
+{
+ if(GetParent())
+ return GetParent()->GetMenuBar();
+ return m_menuBar;
+}
+
+void wxMenuBase::Attach(wxMenuBarBase *menubar)
+{
+ // use Detach() instead!
+ wxASSERT_MSG( menubar, _T("menu can't be attached to NULL menubar") );
+
+ // use IsAttached() to prevent this from happening
+ wxASSERT_MSG( !m_menuBar, _T("attaching menu twice?") );
+
+ m_menuBar = (wxMenuBar *)menubar;
+}
+
+void wxMenuBase::Detach()
+{
+ // use IsAttached() to prevent this from happening
+ wxASSERT_MSG( m_menuBar, _T("detaching unattached menu?") );
+
+ m_menuBar = NULL;
+}
+
// ----------------------------------------------------------------------------
// wxMenu functions forwarded to wxMenuItem
// ----------------------------------------------------------------------------
{
wxMenuItem *item = FindItem(id);
- wxCHECK_MSG( item, FALSE, wxT("wxMenu::IsEnabled: no such item") );
+ wxCHECK_MSG( item, false, wxT("wxMenu::IsEnabled: no such item") );
return item->IsEnabled();
}
{
wxMenuItem *item = FindItem(id);
- wxCHECK_MSG( item, FALSE, wxT("wxMenu::IsChecked: no such item") );
+ wxCHECK_MSG( item, false, wxT("wxMenu::IsChecked: no such item") );
return item->IsChecked();
}
{
wxMenuItem *item = FindItem(id);
- wxCHECK_MSG( item, wxT(""), wxT("wxMenu::GetLabel: no such item") );
+ wxCHECK_MSG( item, wxEmptyString, wxT("wxMenu::GetLabel: no such item") );
return item->GetText();
}
{
wxMenuItem *item = FindItem(id);
- wxCHECK_MSG( item, wxT(""), wxT("wxMenu::GetHelpString: no such item") );
+ wxCHECK_MSG( item, wxEmptyString, wxT("wxMenu::GetHelpString: no such item") );
return item->GetHelp();
}
wxMenuBarBase::wxMenuBarBase()
{
- // we own the menus when we get them
- m_menus.DeleteContents(TRUE);
+ // not attached yet
+ m_menuBarFrame = NULL;
}
wxMenuBarBase::~wxMenuBarBase()
{
- // nothing to do, the list will delete the menus because of the call to
- // DeleteContents() above
+ WX_CLEAR_LIST(wxMenuList, m_menus);
}
// ----------------------------------------------------------------------------
wxMenu *wxMenuBarBase::GetMenu(size_t pos) const
{
- wxMenuList::Node *node = m_menus.Item(pos);
+ wxMenuList::compatibility_iterator node = m_menus.Item(pos);
wxCHECK_MSG( node, NULL, wxT("bad index in wxMenuBar::GetMenu()") );
return node->GetData();
bool wxMenuBarBase::Append(wxMenu *menu, const wxString& WXUNUSED(title))
{
- wxCHECK_MSG( menu, FALSE, wxT("can't append NULL menu") );
+ wxCHECK_MSG( menu, false, wxT("can't append NULL menu") );
m_menus.Append(menu);
+ menu->Attach(this);
- return TRUE;
+ return true;
}
bool wxMenuBarBase::Insert(size_t pos, wxMenu *menu,
{
return wxMenuBarBase::Append(menu, title);
}
- else
+ else // not at the end
{
- wxCHECK_MSG( menu, FALSE, wxT("can't insert NULL menu") );
+ wxCHECK_MSG( menu, false, wxT("can't insert NULL menu") );
- wxMenuList::Node *node = m_menus.Item(pos);
- wxCHECK_MSG( node, FALSE, wxT("bad index in wxMenuBar::Insert()") );
+ wxMenuList::compatibility_iterator node = m_menus.Item(pos);
+ wxCHECK_MSG( node, false, wxT("bad index in wxMenuBar::Insert()") );
m_menus.Insert(node, menu);
+ menu->Attach(this);
- return TRUE;
+ return true;
}
}
{
wxCHECK_MSG( menu, NULL, wxT("can't insert NULL menu") );
- wxMenuList::Node *node = m_menus.Item(pos);
+ wxMenuList::compatibility_iterator node = m_menus.Item(pos);
wxCHECK_MSG( node, NULL, wxT("bad index in wxMenuBar::Replace()") );
wxMenu *menuOld = node->GetData();
node->SetData(menu);
+ menu->Attach(this);
+ menuOld->Detach();
+
return menuOld;
}
wxMenu *wxMenuBarBase::Remove(size_t pos)
{
- wxMenuList::Node *node = m_menus.Item(pos);
+ wxMenuList::compatibility_iterator node = m_menus.Item(pos);
wxCHECK_MSG( node, NULL, wxT("bad index in wxMenuBar::Remove()") );
- node = m_menus.DetachNode(node);
- wxCHECK( node, NULL ); // unexpected
wxMenu *menu = node->GetData();
-
- delete node;
+ m_menus.Erase(node);
+ menu->Detach();
return menu;
}
(wxMenuItem::GetLabelFromText(title2) == label) )
{
// found
- return (int)i;
+ return (int)i;
}
}
}
+// ----------------------------------------------------------------------------
+// wxMenuBar attaching/detaching to/from the frame
+// ----------------------------------------------------------------------------
+
+void wxMenuBarBase::Attach(wxFrame *frame)
+{
+ wxASSERT_MSG( !IsAttached(), wxT("menubar already attached!") );
+
+ m_menuBarFrame = frame;
+}
+
+void wxMenuBarBase::Detach()
+{
+ wxASSERT_MSG( IsAttached(), wxT("detaching unattached menubar") );
+
+ m_menuBarFrame = NULL;
+}
+
+// ----------------------------------------------------------------------------
+// wxMenuBar searching for items
+// ----------------------------------------------------------------------------
+
+wxMenuItem *wxMenuBarBase::FindItem(int id, wxMenu **menu) const
+{
+ if ( menu )
+ *menu = NULL;
+
+ wxMenuItem *item = NULL;
+ size_t count = GetMenuCount(), i;
+ wxMenuList::const_iterator it;
+ for ( i = 0, it = m_menus.begin(); !item && (i < count); i++, it++ )
+ {
+ item = (*it)->FindItem(id, menu);
+ }
+
+ return item;
+}
+
+int wxMenuBarBase::FindMenuItem(const wxString& menu, const wxString& item) const
+{
+ wxString label = wxMenuItem::GetLabelFromText(menu);
+
+ int i = 0;
+ wxMenuList::compatibility_iterator node;
+ for ( node = m_menus.GetFirst(); node; node = node->GetNext(), i++ )
+ {
+ if ( label == wxMenuItem::GetLabelFromText(GetLabelTop(i)) )
+ return node->GetData()->FindItem(item);
+ }
+
+ return wxNOT_FOUND;
+}
+
// ---------------------------------------------------------------------------
// wxMenuBar functions forwarded to wxMenuItem
// ---------------------------------------------------------------------------
{
wxMenuItem *item = FindItem(id);
- wxCHECK_MSG( item, FALSE, wxT("wxMenuBar::IsChecked(): no such item") );
+ wxCHECK_MSG( item, false, wxT("wxMenuBar::IsChecked(): no such item") );
return item->IsChecked();
}
{
wxMenuItem *item = FindItem(id);
- wxCHECK_MSG( item, FALSE, wxT("wxMenuBar::IsEnabled(): no such item") );
+ wxCHECK_MSG( item, false, wxT("wxMenuBar::IsEnabled(): no such item") );
return item->IsEnabled();
}
return item->GetHelp();
}
+void wxMenuBarBase::UpdateMenus( void )
+{
+ wxEvtHandler* source;
+ wxMenu* menu;
+ int nCount = GetMenuCount();
+ for (int n = 0; n < nCount; n++)
+ {
+ menu = GetMenu( n );
+ if (menu != NULL)
+ {
+ source = menu->GetEventHandler();
+ if (source != NULL)
+ menu->UpdateUI( source );
+ }
+ }
+}
+
+#endif // wxUSE_MENUS
projects / wxWidgets.git / blobdiff