///////////////////////////////////////////////////////////////////////////////
-// 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
+// Copyright: (c) wxWidgets team
// Licence: wxWindows licence
///////////////////////////////////////////////////////////////////////////////
// headers
// ----------------------------------------------------------------------------
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
- #pragma implementation "menubase.h"
-#endif
-
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#include "wx/listimpl.cpp"
-WX_DEFINE_LIST(wxMenuList);
-WX_DEFINE_LIST(wxMenuItemList);
+WX_DEFINE_LIST(wxMenuList)
+WX_DEFINE_LIST(wxMenuItemList)
// ============================================================================
// implementation
m_parentMenu = parentMenu;
m_subMenu = subMenu;
- m_isEnabled = TRUE;
- m_isChecked = FALSE;
+ m_isEnabled = true;
+ m_isChecked = false;
m_id = id;
m_kind = kind;
if (m_id == wxID_ANY)
#if wxUSE_ACCEL
+static const struct wxKeyName
+{
+ wxKeyCode code;
+ const wxChar *name;
+} wxKeyNames[] =
+{
+ { WXK_DELETE, wxTRANSLATE("DEL") },
+ { WXK_DELETE, wxTRANSLATE("DELETE") },
+ { WXK_BACK, wxTRANSLATE("BACK") },
+ { WXK_INSERT, wxTRANSLATE("INS") },
+ { WXK_INSERT, wxTRANSLATE("INSERT") },
+ { WXK_RETURN, wxTRANSLATE("ENTER") },
+ { WXK_RETURN, wxTRANSLATE("RETURN") },
+ { WXK_PAGEUP, wxTRANSLATE("PGUP") },
+ { WXK_PAGEDOWN, wxTRANSLATE("PGDN") },
+ { WXK_LEFT, wxTRANSLATE("LEFT") },
+ { WXK_RIGHT, wxTRANSLATE("RIGHT") },
+ { WXK_UP, wxTRANSLATE("UP") },
+ { WXK_DOWN, wxTRANSLATE("DOWN") },
+ { WXK_HOME, wxTRANSLATE("HOME") },
+ { WXK_END, wxTRANSLATE("END") },
+ { WXK_SPACE, wxTRANSLATE("SPACE") },
+ { WXK_TAB, wxTRANSLATE("TAB") },
+ { WXK_ESCAPE, wxTRANSLATE("ESC") },
+ { WXK_ESCAPE, wxTRANSLATE("ESCAPE") },
+ { WXK_CANCEL, wxTRANSLATE("CANCEL") },
+ { WXK_CLEAR, wxTRANSLATE("CLEAR") },
+ { WXK_MENU, wxTRANSLATE("MENU") },
+ { WXK_PAUSE, wxTRANSLATE("PAUSE") },
+ { WXK_CAPITAL, wxTRANSLATE("CAPITAL") },
+ { WXK_SELECT, wxTRANSLATE("SELECT") },
+ { WXK_PRINT, wxTRANSLATE("PRINT") },
+ { WXK_EXECUTE, wxTRANSLATE("EXECUTE") },
+ { WXK_SNAPSHOT, wxTRANSLATE("SNAPSHOT") },
+ { WXK_HELP, wxTRANSLATE("HELP") },
+ { WXK_ADD, wxTRANSLATE("ADD") },
+ { WXK_SEPARATOR, wxTRANSLATE("SEPARATOR") },
+ { WXK_SUBTRACT, wxTRANSLATE("SUBTRACT") },
+ { WXK_DECIMAL, wxTRANSLATE("DECIMAL") },
+ { WXK_DIVIDE, wxTRANSLATE("DIVIDE") },
+ { WXK_NUMLOCK, wxTRANSLATE("NUM_LOCK") },
+ { WXK_SCROLL, wxTRANSLATE("SCROLL_LOCK") },
+ { WXK_PAGEUP, wxTRANSLATE("PAGEUP") },
+ { WXK_PAGEDOWN, wxTRANSLATE("PAGEDOWN") },
+ { WXK_NUMPAD_SPACE, wxTRANSLATE("KP_SPACE") },
+ { WXK_NUMPAD_TAB, wxTRANSLATE("KP_TAB") },
+ { WXK_NUMPAD_ENTER, wxTRANSLATE("KP_ENTER") },
+ { WXK_NUMPAD_HOME, wxTRANSLATE("KP_HOME") },
+ { WXK_NUMPAD_LEFT, wxTRANSLATE("KP_LEFT") },
+ { WXK_NUMPAD_UP, wxTRANSLATE("KP_UP") },
+ { WXK_NUMPAD_RIGHT, wxTRANSLATE("KP_RIGHT") },
+ { WXK_NUMPAD_DOWN, wxTRANSLATE("KP_DOWN") },
+ { WXK_NUMPAD_PAGEUP, wxTRANSLATE("KP_PRIOR") },
+ { WXK_NUMPAD_PAGEUP, wxTRANSLATE("KP_PAGEUP") },
+ { WXK_NUMPAD_PAGEDOWN, wxTRANSLATE("KP_NEXT") },
+ { WXK_NUMPAD_PAGEDOWN, wxTRANSLATE("KP_PAGEDOWN") },
+ { WXK_NUMPAD_END, wxTRANSLATE("KP_END") },
+ { WXK_NUMPAD_BEGIN, wxTRANSLATE("KP_BEGIN") },
+ { WXK_NUMPAD_INSERT, wxTRANSLATE("KP_INSERT") },
+ { WXK_NUMPAD_DELETE, wxTRANSLATE("KP_DELETE") },
+ { WXK_NUMPAD_EQUAL, wxTRANSLATE("KP_EQUAL") },
+ { WXK_NUMPAD_MULTIPLY, wxTRANSLATE("KP_MULTIPLY") },
+ { WXK_NUMPAD_ADD, wxTRANSLATE("KP_ADD") },
+ { WXK_NUMPAD_SEPARATOR, wxTRANSLATE("KP_SEPARATOR") },
+ { WXK_NUMPAD_SUBTRACT, wxTRANSLATE("KP_SUBTRACT") },
+ { WXK_NUMPAD_DECIMAL, wxTRANSLATE("KP_DECIMAL") },
+ { WXK_NUMPAD_DIVIDE, wxTRANSLATE("KP_DIVIDE") },
+ { WXK_WINDOWS_LEFT, wxTRANSLATE("WINDOWS_LEFT") },
+ { WXK_WINDOWS_RIGHT, wxTRANSLATE("WINDOWS_RIGHT") },
+ { WXK_WINDOWS_MENU, wxTRANSLATE("WINDOWS_MENU") },
+ { WXK_COMMAND, wxTRANSLATE("COMMAND") },
+};
+
+// return true if the 2 strings refer to the same accel
+//
+// as accels can be either translated or not, check for both possibilities and
+// also compare case-insensitively as the key names case doesn't count
static inline bool CompareAccelString(const wxString& str, const wxChar *accel)
{
+ return str.CmpNoCase(accel) == 0
#if wxUSE_INTL
- return str == accel || str == wxGetTranslation(accel);
-#else
- return str == accel;
+ || str.CmpNoCase(wxGetTranslation(accel)) == 0
#endif
+ ;
+}
+
+// return prefixCode+number if the string is of the form "<prefix><number>" and
+// 0 if it isn't
+//
+// first and last parameter specify the valid domain for "number" part
+static int
+IsNumberedAccelKey(const wxString& str,
+ const wxChar *prefix,
+ wxKeyCode prefixCode,
+ unsigned first,
+ unsigned last)
+{
+ const size_t lenPrefix = wxStrlen(prefix);
+ if ( !CompareAccelString(str.Left(lenPrefix), prefix) )
+ return 0;
+
+ unsigned long num;
+ if ( !str.Mid(lenPrefix).ToULong(&num) )
+ return 0;
+
+ if ( num < first || num > last )
+ {
+ // this must be a mistake, chances that this is a valid name of another
+ // key are vanishingly small
+ wxLogDebug(_T("Invalid key string \"%s\""), str.c_str());
+ return 0;
+ }
+
+ return prefixCode + num - first;
}
// return wxAcceleratorEntry for the given menu string or NULL if none
-// specified
wxAcceleratorEntry *wxGetAccelFromString(const wxString& label)
{
// 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];
+ if ( posTab == wxNOT_FOUND )
+ return NULL;
- // skip clearing it below
- continue;
- }
- else
- {
- wxLogDebug(wxT("Unknown accel modifier: '%s'"),
- current.c_str());
- }
- }
+ // parse the accelerator string
+ int accelFlags = wxACCEL_NORMAL;
+ wxString current;
+ for ( size_t n = (size_t)posTab + 1; n < label.length(); 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 // not a recognized modifier name
+ {
+ // 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];
- current.clear();
- }
- else {
- current += (wxChar) wxTolower(label[n]);
+ // skip clearing it below
+ continue;
+ }
+ else
+ {
+ wxLogDebug(wxT("Unknown accel modifier: '%s'"),
+ current.c_str());
+ }
}
+
+ current.clear();
+ }
+ else // not special character
+ {
+ current += (wxChar) wxTolower(label[n]);
}
+ }
- if ( current.IsEmpty() ) {
+ int keyCode;
+ const size_t len = current.length();
+ switch ( len )
+ {
+ case 0:
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
+ return NULL;
+
+ case 1:
+ // it's just a letter
+ keyCode = current[0U];
+
+ // if the key is used with any modifiers, make it an uppercase one
+ // because Ctrl-A and Ctrl-a are the same; but keep it as is if it's
+ // used alone as 'a' and 'A' are different
+ if ( accelFlags != wxACCEL_NORMAL )
+ keyCode = wxToupper(keyCode);
+ break;
+
+ default:
+ keyCode = IsNumberedAccelKey(current, wxTRANSLATE("F"),
+ WXK_F1, 1, 12);
+ if ( !keyCode )
+ {
+ for ( size_t n = 0; n < WXSIZEOF(wxKeyNames); n++ )
+ {
+ const wxKeyName& kn = wxKeyNames[n];
+ if ( CompareAccelString(current, kn.name) )
{
- wxLogDebug(wxT("Unrecognized accel key '%s', accel string ignored."),
- current.c_str());
+ keyCode = kn.code;
+ break;
}
}
}
- }
- if ( keyCode ) {
- // we do have something
- return new wxAcceleratorEntry(accelFlags, keyCode);
- }
+ if ( !keyCode )
+ keyCode = IsNumberedAccelKey(current, wxTRANSLATE("KP_"),
+ WXK_NUMPAD0, 0, 9);
+ if ( !keyCode )
+ keyCode = IsNumberedAccelKey(current, wxTRANSLATE("SPECIAL"),
+ WXK_SPECIAL1, 1, 20);
+
+ if ( !keyCode )
+ {
+ wxLogDebug(wxT("Unrecognized accel key '%s', accel string ignored."),
+ current.c_str());
+ return NULL;
+ }
}
- return (wxAcceleratorEntry *)NULL;
+
+ wxASSERT_MSG( keyCode, _T("logic error: should have key code here") );
+
+ return new wxAcceleratorEntry(accelFlags, keyCode);
}
wxAcceleratorEntry *wxMenuItemBase::GetAccel() const
int flags = accel->GetFlags();
if ( flags & wxACCEL_ALT )
- text += wxT("Alt-");
+ text += _("Alt-");
if ( flags & wxACCEL_CTRL )
- text += wxT("Ctrl-");
+ text += _("Ctrl-");
if ( flags & wxACCEL_SHIFT )
- text += wxT("Shift-");
-
- int code = accel->GetKeyCode();
- switch ( code )
+ text += _("Shift-");
+
+ const int code = accel->GetKeyCode();
+
+ if ( wxIsalnum(code) )
+ text << (wxChar)code;
+ else if ( code >= WXK_F1 && code <= WXK_F12 )
+ text << _("F") << code - WXK_F1 + 1;
+ else if ( code >= WXK_NUMPAD0 && code <= WXK_NUMPAD9 )
+ text << _("KP_") << code - WXK_NUMPAD0;
+ else if ( code >= WXK_SPECIAL1 && code <= WXK_SPECIAL20 )
+ text << _("SPECIAL") << code - WXK_SPECIAL1 + 1;
+ else // check the named keys
{
- 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;
-
- // if there are any other keys wxGetAccelFromString() may return,
- // we should process them here
-
- default:
- if ( wxIsalnum(code) )
+ size_t n;
+ for ( n = 0; n < WXSIZEOF(wxKeyNames); n++ )
+ {
+ const wxKeyName& kn = wxKeyNames[n];
+ if ( code == kn.code )
{
- text << (wxChar)code;
-
+ text << wxGetTranslation(kn.name);
break;
}
+ }
- wxFAIL_MSG( wxT("unknown keyboard accel") );
+ wxASSERT_MSG( n != WXSIZEOF(wxKeyNames),
+ wxT("unknown keyboard accelerator code") );
}
}
#endif // wxUSE_ACCEL
+bool wxMenuBase::ms_locked = true;
+
// ----------------------------------------------------------------------------
// wxMenu ctor and dtor
// ----------------------------------------------------------------------------
{
wxCHECK_RET( submenu, _T("can't add a NULL submenu") );
- if ( m_menuBar )
- {
- submenu->Attach(m_menuBar);
- }
-
submenu->SetParent((wxMenu *)this);
}
}
else
{
- wxCHECK_MSG( pos < GetMenuItemCount(), FALSE,
+ wxCHECK_MSG( pos < GetMenuItemCount(), NULL,
wxT("invalid index in wxMenu::Insert") );
return DoInsert(pos, item);
wxCHECK_MSG( item, NULL, wxT("invalid item in wxMenu::Insert()") );
wxMenuItemList::compatibility_iterator node = m_items.Item(pos);
- wxCHECK_MSG( node, FALSE, wxT("invalid index in wxMenu::Insert()") );
+ wxCHECK_MSG( node, NULL, wxT("invalid index in wxMenu::Insert()") );
m_items.Insert(node, item);
item->SetMenu((wxMenu*)this);
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);
// 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 )
event.SetEventObject(this);
event.SetInt(checked);
- bool processed = FALSE;
+ bool processed = false;
// Try the menu's event handler
- if ( !processed )
+ // if ( !processed )
{
wxEvtHandler *handler = GetEventHandler();
if ( handler )
// 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!
{
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();
}
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,
}
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::compatibility_iterator node = m_menus.Item(pos);
- wxCHECK_MSG( node, FALSE, wxT("bad index in wxMenuBar::Insert()") );
+ wxCHECK_MSG( node, false, wxT("bad index in wxMenuBar::Insert()") );
m_menus.Insert(node, menu);
menu->Attach(this);
- return TRUE;
+ return true;
}
}
{
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