// 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__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
#pragma implementation "menubase.h"
#endif
#pragma hdrstop
#endif
+#if wxUSE_MENUS
+
+#include <ctype.h>
+
#ifndef WX_PRECOMP
+ #include "wx/intl.h"
+ #include "wx/log.h"
#include "wx/menu.h"
#endif
// wxMenuItem
// ----------------------------------------------------------------------------
+wxMenuItemBase::wxMenuItemBase(wxMenu *parentMenu,
+ int id,
+ const wxString& text,
+ const wxString& help,
+ wxItemKind kind,
+ wxMenu *subMenu)
+ : m_text(text),
+ m_help(help)
+{
+ 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;
+}
+
wxMenuItemBase::~wxMenuItemBase()
{
- if (m_subMenu)
- delete m_subMenu;
+ delete m_subMenu;
}
#if wxUSE_ACCEL
+static inline bool CompareAccelString(const wxString& str, const wxChar *accel)
+{
+#if wxUSE_INTL
+ return str == accel || str == wxGetTranslation(accel);
+#else
+ return str == accel;
+#endif
+}
+
+// return wxAcceleratorEntry for the given menu string or NULL if none
+// specified
+wxAcceleratorEntry *wxGetAccelFromString(const wxString& label)
+{
+ // wxPrintf( wxT("label %s\n"), label.c_str() );
+
+ // check for accelerators: they are given after '\t'
+ int posTab = label.Find(wxT('\t'));
+ if ( posTab != wxNOT_FOUND ) {
+ // parse the accelerator string
+ int keyCode = 0;
+ int accelFlags = wxACCEL_NORMAL;
+ wxString current;
+ for ( size_t n = (size_t)posTab + 1; n < label.Len(); n++ ) {
+ if ( (label[n] == '+') || (label[n] == '-') ) {
+ if ( CompareAccelString(current, wxTRANSLATE("ctrl")) )
+ accelFlags |= wxACCEL_CTRL;
+ else if ( CompareAccelString(current, wxTRANSLATE("alt")) )
+ accelFlags |= wxACCEL_ALT;
+ else if ( CompareAccelString(current, wxTRANSLATE("shift")) )
+ accelFlags |= wxACCEL_SHIFT;
+ else {
+ // we may have "Ctrl-+", for example, but we still want to
+ // catch typos like "Crtl-A" so only give the warning if we
+ // have something before the current '+' or '-', else take
+ // it as a literal symbol
+ if ( current.empty() )
+ {
+ current += label[n];
+
+ // skip clearing it below
+ continue;
+ }
+ else
+ {
+ wxLogDebug(wxT("Unknown accel modifier: '%s'"),
+ current.c_str());
+ }
+ }
+
+ current.clear();
+ }
+ else {
+ current += (wxChar) wxTolower(label[n]);
+ }
+ }
+
+ if ( current.IsEmpty() ) {
+ wxLogDebug(wxT("No accel key found, accel string ignored."));
+ }
+ else {
+ if ( current.Len() == 1 ) {
+ // it's a letter
+ keyCode = current[0U];
+
+ // Only call wxToupper if control, alt, or shift is held down,
+ // otherwise lower case accelerators won't work.
+ if (accelFlags != wxACCEL_NORMAL) {
+ keyCode = wxToupper(keyCode);
+ }
+ }
+ else {
+ // is it a function key?
+ if ( current[0U] == 'f' && wxIsdigit(current[1U]) &&
+ (current.Len() == 2 ||
+ (current.Len() == 3 && wxIsdigit(current[2U]))) ) {
+ int n;
+ wxSscanf(current.c_str() + 1, wxT("%d"), &n);
+
+ keyCode = WXK_F1 + n - 1;
+ }
+ else {
+ // several special cases
+ current.MakeUpper();
+ if ( current == wxT("DEL") )
+ keyCode = WXK_DELETE;
+ else if ( current == wxT("DELETE") )
+ keyCode = WXK_DELETE;
+ else if ( current == wxT("BACK") )
+ keyCode = WXK_BACK;
+ else if ( current == wxT("INS") )
+ keyCode = WXK_INSERT;
+ else if ( current == wxT("INSERT") )
+ keyCode = WXK_INSERT;
+ else if ( current == wxT("ENTER") || current == wxT("RETURN") )
+ keyCode = WXK_RETURN;
+ else if ( current == wxT("PGUP") )
+ keyCode = WXK_PRIOR;
+ else if ( current == wxT("PGDN") )
+ keyCode = WXK_NEXT;
+ else if ( current == wxT("LEFT") )
+ keyCode = WXK_LEFT;
+ else if ( current == wxT("RIGHT") )
+ keyCode = WXK_RIGHT;
+ else if ( current == wxT("UP") )
+ keyCode = WXK_UP;
+ else if ( current == wxT("DOWN") )
+ keyCode = WXK_DOWN;
+ else if ( current == wxT("HOME") )
+ keyCode = WXK_HOME;
+ else if ( current == wxT("END") )
+ keyCode = WXK_END;
+ else if ( current == wxT("SPACE") )
+ keyCode = WXK_SPACE;
+ else if ( current == wxT("TAB") )
+ keyCode = WXK_TAB;
+ else if ( current == wxT("ESC") || current == wxT("ESCAPE") )
+ keyCode = WXK_ESCAPE;
+ else
+ {
+ wxLogDebug(wxT("Unrecognized accel key '%s', accel string ignored."),
+ current.c_str());
+ }
+ }
+ }
+ }
+
+ if ( keyCode ) {
+ // we do have something
+ return new wxAcceleratorEntry(accelFlags, keyCode);
+ }
+ }
+
+ return (wxAcceleratorEntry *)NULL;
+}
+
+wxAcceleratorEntry *wxMenuItemBase::GetAccel() const
+{
+ return wxGetAccelFromString(GetText());
+}
+
void wxMenuItemBase::SetAccel(wxAcceleratorEntry *accel)
{
wxString text = m_text.BeforeFirst(wxT('\t'));
#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_RET( submenu, _T("can't add a NULL submenu") );
+
+ submenu->SetParent((wxMenu *)this);
+}
+
+wxMenuItem* wxMenuBase::DoAppend(wxMenuItem *item)
{
- wxCHECK_MSG( item, FALSE, wxT("invalid item in wxMenu::Append()") );
+ 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, NULL, 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, NULL, 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(NULL, wxID_SEPARATOR, text).GetLabel();
- for ( wxMenuItemList::Node *node = m_items.GetFirst();
+ wxString label = wxMenuItem::GetLabelFromText(text);
+ 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();
}
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,
{
if ( pos == m_menus.GetCount() )
{
- return Append(menu, title);
+ 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;
}
+int wxMenuBarBase::FindMenu(const wxString& title) const
+{
+ wxString label = wxMenuItem::GetLabelFromText(title);
+
+ size_t count = GetMenuCount();
+ for ( size_t i = 0; i < count; i++ )
+ {
+ wxString title2 = GetLabelTop(i);
+ if ( (title2 == title) ||
+ (wxMenuItem::GetLabelFromText(title2) == label) )
+ {
+ // found
+ return (int)i;
+ }
+ }
+
+ return wxNOT_FOUND;
+
+}
+
+// ----------------------------------------------------------------------------
+// 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();
}
+#endif // wxUSE_MENUS
projects / wxWidgets.git / blobdiff