]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/menucmn.cpp
move Ellipsize() to wxControl so it can be easily used by other controls
[wxWidgets.git] / src / common / menucmn.cpp
index b272d1483d48b7c3eef1bf35785e176375520187..37c0c127f11178e0866c10233995177382e16db6 100644 (file)
@@ -1,11 +1,11 @@
 ///////////////////////////////////////////////////////////////////////////////
-// 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"
 
 
 #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
 // ----------------------------------------------------------------------------
 
 #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,
@@ -61,21 +57,23 @@ 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;
-    m_isEnabled   = TRUE;
-    m_isChecked   = FALSE;
+    m_isEnabled   = true;
+    m_isChecked   = false;
     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()
@@ -85,144 +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.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)
@@ -231,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;
 
@@ -298,8 +160,6 @@ void wxMenuBase::Init(long style)
 wxMenuBase::~wxMenuBase()
 {
     WX_CLEAR_LIST(wxMenuItemList, m_items);
-
-    // Actually, in GTK, the submenus have to get deleted first.
 }
 
 // ----------------------------------------------------------------------------
@@ -337,7 +197,7 @@ wxMenuItem* wxMenuBase::Insert(size_t pos, wxMenuItem *item)
     }
     else
     {
-        wxCHECK_MSG( pos < GetMenuItemCount(), FALSE,
+        wxCHECK_MSG( pos < GetMenuItemCount(), NULL,
                      wxT("invalid index in wxMenu::Insert") );
 
         return DoInsert(pos, item);
@@ -349,7 +209,7 @@ wxMenuItem* wxMenuBase::DoInsert(size_t pos, wxMenuItem *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);
@@ -385,6 +245,8 @@ wxMenuItem *wxMenuBase::DoRemove(wxMenuItem *item)
     if ( submenu )
     {
         submenu->SetParent((wxMenu *)NULL);
+        if ( submenu->IsAttached() )
+            submenu->Detach();
     }
 
     return item;
@@ -392,7 +254,7 @@ wxMenuItem *wxMenuBase::DoRemove(wxMenuItem *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);
 }
@@ -400,19 +262,19 @@ bool wxMenuBase::Delete(wxMenuItem *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);
 }
@@ -420,21 +282,21 @@ bool wxMenuBase::Destroy(wxMenuItem *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() )
@@ -451,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();
         }
     }
@@ -589,14 +451,14 @@ bool wxMenuBase::SendEvent(int id, int checked)
     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 )
-            processed = handler->ProcessEvent(event);
+            processed = handler->SafelyProcessEvent(event);
     }
 
     // Try the window the menu was popped up from (and up through the
@@ -609,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;
             }
 
@@ -667,7 +529,7 @@ bool wxMenuBase::IsEnabled( int id ) const
 {
     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();
 }
@@ -685,7 +547,7 @@ bool wxMenuBase::IsChecked( int id ) const
 {
     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();
 }
@@ -696,16 +558,16 @@ 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
 {
     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 )
@@ -721,7 +583,7 @@ wxString wxMenuBase::GetHelpString( int id ) const
 {
     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();
 }
@@ -756,12 +618,12 @@ wxMenu *wxMenuBarBase::GetMenu(size_t pos) const
 
 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,
@@ -773,15 +635,15 @@ 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;
     }
 }
 
@@ -816,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;
@@ -874,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);
     }
 
@@ -914,7 +776,7 @@ bool wxMenuBarBase::IsChecked(int id) const
 {
     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();
 }
@@ -923,7 +785,7 @@ bool wxMenuBarBase::IsEnabled(int id) const
 {
     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();
 }
@@ -934,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
@@ -944,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)
@@ -966,4 +828,34 @@ wxString wxMenuBarBase::GetHelpString(int id) const
     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