///////////////////////////////////////////////////////////////////////////////
-// Name: common/menucmn.cpp
+// Name: src/common/menucmn.cpp
// Purpose: wxMenu and wxMenuBar methods common to all ports
// Author: Vadim Zeitlin
// Modified by:
// 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"
#if wxUSE_MENUS
-#include <ctype.h>
-
#ifndef WX_PRECOMP
#include "wx/intl.h"
#include "wx/log.h"
#include "wx/menu.h"
+ #include "wx/frame.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,
const wxString& help,
wxItemKind kind,
wxMenu *subMenu)
- : m_text(text),
- m_help(help)
{
- wxASSERT_MSG( parentMenu != NULL, wxT("menuitem should have a menu") );
+ switch ( id )
+ {
+ case wxID_ANY:
+ m_id = wxWindow::NewControlId();
+ break;
+
+ case wxID_SEPARATOR:
+ m_id = wxID_SEPARATOR;
+
+ // there is a lot of existing code just doing Append(wxID_SEPARATOR)
+ // and it makes sense to omit the following optional parameters,
+ // including the kind one which doesn't default to wxITEM_SEPARATOR,
+ // of course, so override it here
+ kind = wxITEM_SEPARATOR;
+ break;
+
+ case wxID_NONE:
+ // (popup) menu titles in wxMSW use this ID to indicate that
+ // it's not a real menu item, so we don't want the check below to
+ // apply to it
+ m_id = id;
+ break;
+
+ default:
+ // ids are limited to 16 bits under MSW so portable code shouldn't
+ // use ids outside of this range (negative ids generated by wx are
+ // fine though)
+ wxASSERT_MSG( (id >= 0 && id < SHRT_MAX) ||
+ (id >= wxID_AUTO_LOWEST && id <= wxID_AUTO_HIGHEST),
+ wxS("invalid id value") );
+ m_id = id;
+ }
+
+ // notice that parentMenu can be NULL: the item can be attached to the menu
+ // later with SetMenu()
m_parentMenu = parentMenu;
m_subMenu = subMenu;
- m_isEnabled = TRUE;
- m_isChecked = FALSE;
- m_id = id;
+ m_isEnabled = true;
+ m_isChecked = false;
m_kind = kind;
- if (m_id == wxID_ANY)
- m_id = wxNewId();
- if (m_id == wxID_SEPARATOR)
- m_kind = wxITEM_SEPARATOR;
+
+ SetItemLabel(text);
+ SetHelp(help);
}
wxMenuItemBase::~wxMenuItemBase()
#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());
+ return wxAcceleratorEntry::Create(GetItemLabel());
}
void wxMenuItemBase::SetAccel(wxAcceleratorEntry *accel)
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-");
+ SetItemLabel(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;
-
- // if there are any other keys wxGetAccelFromString() may return,
- // we should process them here
-
- default:
- if ( wxIsalnum(code) )
- {
- text << (wxChar)code;
-
- break;
- }
-
- wxFAIL_MSG( wxT("unknown keyboard accel") );
- }
+#endif // wxUSE_ACCEL
+
+void wxMenuItemBase::SetItemLabel(const wxString& str)
+{
+ m_text = str;
+
+ 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);
}
+}
+
+void wxMenuItemBase::SetHelp(const wxString& str)
+{
+ m_help = str;
- SetText(text);
+ if ( m_help.empty() && !IsSeparator() && wxIsStockID(GetId()) )
+ {
+ // get a stock help string
+ m_help = wxGetStockHelpString(GetId());
+ }
}
-#endif // wxUSE_ACCEL
+#ifndef __WXPM__
+wxString wxMenuItemBase::GetLabelText(const wxString& text)
+{
+ return wxStripMenuCodes(text);
+}
+#endif
+
+#if WXWIN_COMPATIBILITY_2_8
+wxString wxMenuItemBase::GetLabelFromText(const wxString& text)
+{
+ return GetLabelText(text);
+}
+#endif
bool wxMenuBase::ms_locked = true;
void wxMenuBase::Init(long style)
{
- m_menuBar = (wxMenuBar *)NULL;
- m_menuParent = (wxMenu *)NULL;
+ m_menuBar = NULL;
+ m_menuParent = NULL;
- m_invokingWindow = (wxWindow *)NULL;
+ m_invokingWindow = NULL;
m_style = style;
- m_clientData = (void *)NULL;
+ m_clientData = NULL;
m_eventHandler = this;
}
wxMenuBase::~wxMenuBase()
{
WX_CLEAR_LIST(wxMenuItemList, m_items);
-
- // Actually, in GTK, the submenus have to get deleted first.
}
// ----------------------------------------------------------------------------
void wxMenuBase::AddSubMenu(wxMenu *submenu)
{
- wxCHECK_RET( submenu, _T("can't add a NULL submenu") );
+ wxCHECK_RET( submenu, wxT("can't add a NULL submenu") );
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);
m_items.Erase(node);
// item isn't attached to anything any more
- item->SetMenu((wxMenu *)NULL);
+ item->SetMenu(NULL);
wxMenu *submenu = item->GetSubMenu();
if ( submenu )
{
- submenu->SetParent((wxMenu *)NULL);
+ submenu->SetParent(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);
+ item2->SetSubMenu(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);
+ wxString label = wxMenuItem::GetLabelText(text);
for ( wxMenuItemList::compatibility_iterator node = m_items.GetFirst();
node;
node = node->GetNext() )
// name just like the ordinary items
if ( !item->IsSeparator() )
{
- if ( item->GetLabel() == label )
+ if ( item->GetItemLabelText() == label )
return item->GetId();
}
}
// non recursive search
wxMenuItem *wxMenuBase::FindChildItem(int id, size_t *ppos) const
{
- wxMenuItem *item = (wxMenuItem *)NULL;
+ wxMenuItem *item = NULL;
wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst();
size_t pos;
wxMenuItem* wxMenuBase::FindItemByPosition(size_t position) const
{
wxCHECK_MSG( position < m_items.GetCount(), NULL,
- _T("wxMenu::FindItemByPosition(): invalid menu index") );
+ wxT("wxMenu::FindItemByPosition(): invalid menu index") );
return m_items.Item( position )->GetData();
}
event.SetEventObject(this);
event.SetInt(checked);
- bool processed = FALSE;
+ bool processed = false;
- // Try the menu's event handler
- if ( !processed )
- {
- wxEvtHandler *handler = GetEventHandler();
- if ( handler )
- processed = handler->ProcessEvent(event);
- }
+ // Try the menu's event handler first
+ wxEvtHandler *handler = GetEventHandler();
+ if ( handler )
+ processed = handler->SafelyProcessEvent(event);
- // Try the window the menu was popped up from (and up through the
- // hierarchy)
+ // Try the window the menu was popped up from or its menu bar belongs to
if ( !processed )
{
- const wxMenuBase *menu = this;
- while ( menu )
- {
- wxWindow *win = menu->GetInvokingWindow();
- if ( win )
- {
- processed = win->GetEventHandler()->ProcessEvent(event);
- break;
- }
-
- menu = menu->GetParent();
- }
+ wxWindow * const win = GetWindow();
+ if ( win )
+ processed = win->HandleWindowEvent(event);
}
return processed;
void wxMenuBase::Attach(wxMenuBarBase *menubar)
{
// use Detach() instead!
- wxASSERT_MSG( menubar, _T("menu can't be attached to NULL menubar") );
+ wxASSERT_MSG( menubar, wxT("menu can't be attached to NULL menubar") );
// use IsAttached() to prevent this from happening
- wxASSERT_MSG( !m_menuBar, _T("attaching menu twice?") );
+ wxASSERT_MSG( !m_menuBar, wxT("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?") );
+ wxASSERT_MSG( m_menuBar, wxT("detaching unattached menu?") );
m_menuBar = NULL;
}
+// ----------------------------------------------------------------------------
+// wxMenu invoking window handling
+// ----------------------------------------------------------------------------
+
+void wxMenuBase::SetInvokingWindow(wxWindow *win)
+{
+ wxASSERT_MSG( !GetParent(),
+ "should only be called for top level popup menus" );
+ wxASSERT_MSG( !IsAttached(),
+ "menus attached to menu bar can't have invoking window" );
+
+ m_invokingWindow = win;
+}
+
+wxWindow *wxMenuBase::GetWindow() const
+{
+ // only the top level menus have non-NULL invoking window or a pointer to
+ // the menu bar so recurse upwards until we find it
+ const wxMenuBase *menu = this;
+ while ( menu->GetParent() )
+ {
+ menu = menu->GetParent();
+ }
+
+ return menu->GetMenuBar() ? menu->GetMenuBar()->GetFrame()
+ : menu->GetInvokingWindow();
+}
+
// ----------------------------------------------------------------------------
// 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();
}
wxCHECK_RET( item, wxT("wxMenu::SetLabel: no such item") );
- item->SetText(label);
+ item->SetItemLabel(label);
}
wxString wxMenuBase::GetLabel( int id ) const
{
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();
+ return item->GetItemLabel();
}
void wxMenuBase::SetHelpString( int id, const wxString& helpString )
{
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();
}
return node->GetData();
}
-bool wxMenuBarBase::Append(wxMenu *menu, const wxString& WXUNUSED(title))
+bool wxMenuBarBase::Append(wxMenu *menu, const wxString& title)
{
- wxCHECK_MSG( menu, FALSE, wxT("can't append NULL menu") );
+ wxCHECK_MSG( menu, false, wxT("can't append NULL menu") );
+ wxCHECK_MSG( !title.empty(), false, wxT("can't append menu with empty title") );
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;
}
}
int wxMenuBarBase::FindMenu(const wxString& title) const
{
- wxString label = wxMenuItem::GetLabelFromText(title);
+ wxString label = wxMenuItem::GetLabelText(title);
size_t count = GetMenuCount();
for ( size_t i = 0; i < count; i++ )
{
- wxString title2 = GetLabelTop(i);
+ wxString title2 = GetMenuLabel(i);
if ( (title2 == title) ||
- (wxMenuItem::GetLabelFromText(title2) == label) )
+ (wxMenuItem::GetLabelText(title2) == label) )
{
// found
return (int)i;
int wxMenuBarBase::FindMenuItem(const wxString& menu, const wxString& item) const
{
- wxString label = wxMenuItem::GetLabelFromText(menu);
+ wxString label = wxMenuItem::GetLabelText(menu);
int i = 0;
wxMenuList::compatibility_iterator node;
for ( node = m_menus.GetFirst(); node; node = node->GetNext(), i++ )
{
- if ( label == wxMenuItem::GetLabelFromText(GetLabelTop(i)) )
+ if ( label == wxMenuItem::GetLabelText(GetMenuLabel(i)) )
return node->GetData()->FindItem(item);
}
{
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();
}
wxCHECK_RET( item, wxT("wxMenuBar::SetLabel(): no such item") );
- item->SetText(label);
+ item->SetItemLabel(label);
}
wxString wxMenuBarBase::GetLabel(int id) const
wxCHECK_MSG( item, wxEmptyString,
wxT("wxMenuBar::GetLabel(): no such item") );
- return item->GetText();
+ return item->GetItemLabel();
}
void wxMenuBarBase::SetHelpString(int id, const wxString& helpString)
return item->GetHelp();
}
+void wxMenuBarBase::UpdateMenus()
+{
+ 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 );
+ }
+ }
+}
+
+#if WXWIN_COMPATIBILITY_2_8
+// get or change the label of the menu at given position
+void wxMenuBarBase::SetLabelTop(size_t pos, const wxString& label)
+{
+ SetMenuLabel(pos, label);
+}
+
+wxString wxMenuBarBase::GetLabelTop(size_t pos) const
+{
+ return GetMenuLabelText(pos);
+}
+#endif
+
#endif // wxUSE_MENUS
projects / wxWidgets.git / blobdiff