]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/menucmn.cpp
Minor corrections to wxFlexGridSizer ctor documentation.
[wxWidgets.git] / src / common / menucmn.cpp
index eebcea9bf9c8d08cc00531ee3ba5ca75012fdc87..65adec344f8f2b1b946f5ca7bda61c6aff4a02d1 100644 (file)
 
 #if wxUSE_MENUS
 
-#include <ctype.h>
-
 #ifndef WX_PRECOMP
     #include "wx/intl.h"
     #include "wx/log.h"
     #include "wx/menu.h"
 #endif
 
+#include "wx/stockitem.h"
+
 // ----------------------------------------------------------------------------
 // template lists
 // ----------------------------------------------------------------------------
@@ -48,7 +48,7 @@ WX_DEFINE_LIST(wxMenuItemList)
 // ============================================================================
 
 // ----------------------------------------------------------------------------
-// wxMenuItem
+// wxMenuItemBase
 // ----------------------------------------------------------------------------
 
 wxMenuItemBase::wxMenuItemBase(wxMenu *parentMenu,
@@ -57,10 +57,9 @@ 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") );
+    // notice that parentMenu can be NULL: the item can be attached to the menu
+    // later with SetMenu()
 
     m_parentMenu  = parentMenu;
     m_subMenu     = subMenu;
@@ -69,9 +68,12 @@ wxMenuItemBase::wxMenuItemBase(wxMenu *parentMenu,
     m_id          = id;
     m_kind        = kind;
     if (m_id == wxID_ANY)
-        m_id = wxNewId();
+        m_id = wxWindow::NewControlId();
     if (m_id == wxID_SEPARATOR)
         m_kind = wxITEM_SEPARATOR;
+
+    SetItemLabel(text);
+    SetHelp(help);
 }
 
 wxMenuItemBase::~wxMenuItemBase()
@@ -81,238 +83,9 @@ 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.empty() ) {
-            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]))) ) {
-                    keyCode = WXK_F1 + wxAtoi(current.c_str() + 1) - 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_PAGEUP;
-                    else if ( current == wxT("PGDN") )
-                        keyCode = WXK_PAGEDOWN;
-                    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") || current == _("SPACE") )
-                        keyCode = WXK_SPACE;
-                    else if ( current == wxT("TAB") )
-                        keyCode = WXK_TAB;
-                    else if ( current == wxT("ESC") || current == wxT("ESCAPE") )
-                        keyCode = WXK_ESCAPE;
-                    else if ( current == wxT("CANCEL") )
-                        keyCode = WXK_CANCEL;
-                    else if ( current == wxT("CLEAR") )
-                        keyCode = WXK_CLEAR;
-                    else if ( current == wxT("MENU") )
-                        keyCode = WXK_MENU;
-                    else if ( current == wxT("PAUSE") )
-                        keyCode = WXK_PAUSE;
-                    else if ( current == wxT("CAPITAL") )
-                        keyCode = WXK_CAPITAL;
-                    else if ( current == wxT("SELECT") )
-                        keyCode = WXK_SELECT;
-                    else if ( current == wxT("PRINT") )
-                        keyCode = WXK_PRINT;
-                    else if ( current == wxT("EXECUTE") )
-                        keyCode = WXK_EXECUTE;
-                    else if ( current == wxT("SNAPSHOT") )
-                        keyCode = WXK_SNAPSHOT;
-                    else if ( current == wxT("HELP") )
-                        keyCode = WXK_HELP;
-                    else if ( current == wxT("ADD") )
-                        keyCode = WXK_ADD;
-                    else if ( current == wxT("SEPARATOR") )
-                        keyCode = WXK_SEPARATOR;
-                    else if ( current == wxT("SUBTRACT") )
-                        keyCode = WXK_SUBTRACT;
-                    else if ( current == wxT("DECIMAL") )
-                        keyCode = WXK_DECIMAL;
-                    else if ( current == wxT("DIVIDE") )
-                        keyCode = WXK_DIVIDE;
-                    else if ( current == wxT("NUM_LOCK") )
-                        keyCode = WXK_NUMLOCK;
-                    else if ( current == wxT("SCROLL_LOCK") )
-                        keyCode = WXK_SCROLL;
-                    else if ( current == wxT("PAGEUP") )
-                        keyCode = WXK_PAGEUP;
-                    else if ( current == wxT("PAGEDOWN") )
-                        keyCode = WXK_PAGEDOWN;
-                    else if ( current == wxT("KP_SPACE") )
-                        keyCode = WXK_NUMPAD_SPACE;
-                    else if ( current == wxT("KP_TAB") )
-                        keyCode = WXK_NUMPAD_TAB;
-                    else if ( current == wxT("KP_ENTER") )
-                        keyCode = WXK_NUMPAD_ENTER;
-                    else if ( current == wxT("KP_HOME") )
-                        keyCode = WXK_NUMPAD_HOME;
-                    else if ( current == wxT("KP_LEFT") )
-                        keyCode = WXK_NUMPAD_LEFT;
-                    else if ( current == wxT("KP_UP") )
-                        keyCode = WXK_NUMPAD_UP;
-                    else if ( current == wxT("KP_RIGHT") )
-                        keyCode = WXK_NUMPAD_RIGHT;
-                    else if ( current == wxT("KP_DOWN") )
-                        keyCode = WXK_NUMPAD_DOWN;
-                    else if ( current == wxT("KP_PRIOR") )
-                        keyCode = WXK_NUMPAD_PAGEUP;
-                    else if ( current == wxT("KP_PAGEUP") )
-                        keyCode = WXK_NUMPAD_PAGEUP;
-                    else if ( current == wxT("KP_NEXT;") )
-                        keyCode = WXK_NUMPAD_PAGEDOWN;
-                    else if ( current == wxT("KP_PAGEDOWN") )
-                        keyCode = WXK_NUMPAD_PAGEDOWN;
-                    else if ( current == wxT("KP_END") )
-                        keyCode = WXK_NUMPAD_END;
-                    else if ( current == wxT("KP_BEGIN") )
-                        keyCode = WXK_NUMPAD_BEGIN;
-                    else if ( current == wxT("KP_INSERT") )
-                        keyCode = WXK_NUMPAD_INSERT;
-                    else if ( current == wxT("KP_DELETE") )
-                        keyCode = WXK_NUMPAD_DELETE;
-                    else if ( current == wxT("KP_EQUAL") )
-                        keyCode = WXK_NUMPAD_EQUAL;
-                    else if ( current == wxT("KP_MULTIPLY") )
-                        keyCode = WXK_NUMPAD_MULTIPLY;
-                    else if ( current == wxT("KP_ADD") )
-                        keyCode = WXK_NUMPAD_ADD;
-                    else if ( current == wxT("KP_SEPARATOR") )
-                        keyCode = WXK_NUMPAD_SEPARATOR;
-                    else if ( current == wxT("KP_SUBTRACT") )
-                        keyCode = WXK_NUMPAD_SUBTRACT;
-                    else if ( current == wxT("KP_DECIMAL") )
-                        keyCode = WXK_NUMPAD_DECIMAL;
-                    else if ( current == wxT("KP_DIVIDE") )
-                        keyCode = WXK_NUMPAD_DIVIDE;
-                    else if ( current == wxT("WINDOWS_LEFT") )
-                        keyCode = WXK_WINDOWS_LEFT;
-                    else if ( current == wxT("WINDOWS_RIGHT") )
-                        keyCode = WXK_WINDOWS_RIGHT;
-                    else if ( current == wxT("WINDOWS_MENU") )
-                        keyCode = WXK_WINDOWS_MENU;
-                    else if ( current == wxT("COMMAND") )
-                        keyCode = WXK_COMMAND;
-                    else if ( current.Left(3) == wxT("KP_") && wxIsdigit(current[3U]) )
-                        keyCode = WXK_NUMPAD0 + wxAtoi(current.c_str() + 3);
-                    else if ( current.Left(7) == wxT("SPECIAL") && wxIsdigit(current[7U]) )
-                        keyCode = WXK_SPECIAL1 + wxAtoi(current.c_str() + 7) - 1;
-                    else
-                    {
-                        wxLogDebug(wxT("Unrecognized accel key '%s', accel string ignored."),
-                                   current.c_str());
-                        return NULL;
-                    }
-                }
-            }
-        }
-
-        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)
@@ -321,52 +94,51 @@ 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;
+#endif // wxUSE_ACCEL
 
-            // if there are any other keys wxGetAccelFromString() may return,
-            // we should process them here
+void wxMenuItemBase::SetItemLabel(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);
+#ifndef __WXPM__
+wxString wxMenuItemBase::GetLabelText(const wxString& text)
+{
+    return wxStripMenuCodes(text);
 }
+#endif
 
-#endif // wxUSE_ACCEL
+#if WXWIN_COMPATIBILITY_2_8
+wxString wxMenuItemBase::GetLabelFromText(const wxString& text)
+{
+    return GetLabelText(text);
+}
+#endif
 
 bool wxMenuBase::ms_locked = true;
 
@@ -376,20 +148,18 @@ 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.
 }
 
 // ----------------------------------------------------------------------------
@@ -398,7 +168,7 @@ wxMenuBase::~wxMenuBase()
 
 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);
 }
@@ -470,11 +240,11 @@ wxMenuItem *wxMenuBase::DoRemove(wxMenuItem *item)
     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();
     }
@@ -495,7 +265,7 @@ bool wxMenuBase::DoDelete(wxMenuItem *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;
 
@@ -526,7 +296,7 @@ bool wxMenuBase::DoDestroy(wxMenuItem *item)
 // 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() )
@@ -543,7 +313,7 @@ int wxMenuBase::FindItem(const wxString& text) const
         // name just like the ordinary items
         if ( !item->IsSeparator() )
         {
-            if ( item->GetLabel() == label )
+            if ( item->GetItemLabelText() == label )
                 return item->GetId();
         }
     }
@@ -586,7 +356,7 @@ wxMenuItem *wxMenuBase::FindItem(int itemId, wxMenu **itemMenu) const
 // 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;
@@ -614,7 +384,7 @@ wxMenuItem *wxMenuBase::FindChildItem(int id, size_t *ppos) const
 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();
 }
@@ -688,7 +458,7 @@ bool wxMenuBase::SendEvent(int id, int checked)
     {
         wxEvtHandler *handler = GetEventHandler();
         if ( handler )
-            processed = handler->ProcessEvent(event);
+            processed = handler->SafelyProcessEvent(event);
     }
 
     // Try the window the menu was popped up from (and up through the
@@ -701,7 +471,7 @@ bool wxMenuBase::SendEvent(int id, int checked)
             wxWindow *win = menu->GetInvokingWindow();
             if ( win )
             {
-                processed = win->GetEventHandler()->ProcessEvent(event);
+                processed = win->HandleWindowEvent(event);
                 break;
             }
 
@@ -726,10 +496,10 @@ wxMenuBar* wxMenuBase::GetMenuBar() const
 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;
 }
@@ -737,7 +507,7 @@ void wxMenuBase::Attach(wxMenuBarBase *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;
 }
@@ -788,7 +558,7 @@ void wxMenuBase::SetLabel( int id, const wxString &label )
 
     wxCHECK_RET( item, wxT("wxMenu::SetLabel: no such item") );
 
-    item->SetText(label);
+    item->SetItemLabel(label);
 }
 
 wxString wxMenuBase::GetLabel( int id ) const
@@ -797,7 +567,7 @@ wxString wxMenuBase::GetLabel( int id ) const
 
     wxCHECK_MSG( item, wxEmptyString, wxT("wxMenu::GetLabel: no such item") );
 
-    return item->GetText();
+    return item->GetItemLabel();
 }
 
 void wxMenuBase::SetHelpString( int id, const wxString& helpString )
@@ -908,14 +678,14 @@ wxMenu *wxMenuBarBase::Remove(size_t pos)
 
 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;
@@ -966,13 +736,13 @@ wxMenuItem *wxMenuBarBase::FindItem(int id, wxMenu **menu) const
 
 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);
     }
 
@@ -1026,7 +796,7 @@ void wxMenuBarBase::SetLabel(int id, const wxString& label)
 
     wxCHECK_RET( item, wxT("wxMenuBar::SetLabel(): no such item") );
 
-    item->SetText(label);
+    item->SetItemLabel(label);
 }
 
 wxString wxMenuBarBase::GetLabel(int id) const
@@ -1036,7 +806,7 @@ 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)
@@ -1058,7 +828,7 @@ wxString wxMenuBarBase::GetHelpString(int id) const
     return item->GetHelp();
 }
 
-void wxMenuBarBase::UpdateMenus( void )
+void wxMenuBarBase::UpdateMenus()
 {
     wxEvtHandler* source;
     wxMenu* menu;
@@ -1075,4 +845,17 @@ void wxMenuBarBase::UpdateMenus( void )
     }
 }
 
+#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