]> 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 09251fcb4db5e5d10622eabb94d1a9c9f0dbf663..37c0c127f11178e0866c10233995177382e16db6 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,298 +48,7 @@ WX_DEFINE_LIST(wxMenuItemList)
 // ============================================================================
 
 // ----------------------------------------------------------------------------
-// wxAcceleratorEntry
-// ----------------------------------------------------------------------------
-
-
-#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
-            || 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;
-}
-
-bool wxAcceleratorEntry::FromString(const wxString& text)
-{
-    // the parser won't like leading/trailing spaces
-    wxString label = text.Strip(wxString::both);
-
-    // set to invalid state:
-    m_flags = 0;
-    m_keyCode = 0;
-
-    // check for accelerators: they are given after '\t'
-    int posTab = label.Find(wxT('\t'));
-    if ( posTab == wxNOT_FOUND )
-        return false;
-
-    // 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];
-
-                    // 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]);
-        }
-    }
-
-    int keyCode;
-    const size_t len = current.length();
-    switch ( len )
-    {
-        case 0:
-            wxLogDebug(wxT("No accel key found, accel string ignored."));
-            return false;
-
-        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) )
-                    {
-                        keyCode = kn.code;
-                        break;
-                    }
-                }
-            }
-
-            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 false;
-            }
-    }
-
-
-    wxASSERT_MSG( keyCode, _T("logic error: should have key code here") );
-
-    m_flags = accelFlags;
-    m_keyCode = keyCode;
-    return true;
-}
-
-wxString wxAcceleratorEntry::ToString() const
-{
-    wxString text;
-
-    int flags = GetFlags();
-    if ( flags & wxACCEL_ALT )
-        text += _("Alt-");
-    if ( flags & wxACCEL_CTRL )
-        text += _("Ctrl-");
-    if ( flags & wxACCEL_SHIFT )
-        text += _("Shift-");
-
-    const int code = 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
-    {
-        size_t n;
-        for ( n = 0; n < WXSIZEOF(wxKeyNames); n++ )
-        {
-            const wxKeyName& kn = wxKeyNames[n];
-            if ( code == kn.code )
-            {
-                text << wxGetTranslation(kn.name);
-                break;
-            }
-        }
-
-        wxASSERT_MSG( n != WXSIZEOF(wxKeyNames),
-                      wxT("unknown keyboard accelerator code") );
-    }
-
-    return text;
-}
-
-wxAcceleratorEntry *wxGetAccelFromString(const wxString& label)
-{
-    wxAcceleratorEntry *ret = new wxAcceleratorEntry();
-    if (ret->FromString(label))
-        return ret;
-
-    wxDELETE(ret);
-    return NULL;
-}
-
-#endif      // wxUSE_ACCEL
-
-
-// ----------------------------------------------------------------------------
-// wxMenuItem
+// wxMenuItemBase
 // ----------------------------------------------------------------------------
 
 wxMenuItemBase::wxMenuItemBase(wxMenu *parentMenu,
@@ -348,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;
@@ -360,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()
@@ -374,7 +85,7 @@ wxMenuItemBase::~wxMenuItemBase()
 
 wxAcceleratorEntry *wxMenuItemBase::GetAccel() const
 {
-    return wxGetAccelFromString(GetText());
+    return wxAcceleratorEntry::Create(GetItemLabel());
 }
 
 void wxMenuItemBase::SetAccel(wxAcceleratorEntry *accel)
@@ -386,11 +97,49 @@ void wxMenuItemBase::SetAccel(wxAcceleratorEntry *accel)
         text += accel->ToString();
     }
 
-    SetText(text);
+    SetItemLabel(text);
 }
 
 #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;
+
+    if ( m_help.empty() && !IsSeparator() && wxIsStockID(GetId()) )
+    {
+        // get a stock help string
+        m_help = wxGetStockHelpString(GetId());
+    }
+}
+
+#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;
 
 // ----------------------------------------------------------------------------
@@ -411,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.
 }
 
 // ----------------------------------------------------------------------------
@@ -549,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() )
@@ -566,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();
         }
     }
@@ -711,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
@@ -724,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;
             }
 
@@ -811,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
@@ -820,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 )
@@ -931,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;
@@ -989,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);
     }
 
@@ -1049,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
@@ -1059,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)
@@ -1081,7 +828,7 @@ wxString wxMenuBarBase::GetHelpString(int id) const
     return item->GetHelp();
 }
 
-void wxMenuBarBase::UpdateMenus( void )
+void wxMenuBarBase::UpdateMenus()
 {
     wxEvtHandler* source;
     wxMenu* menu;
@@ -1098,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