]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/menucmn.cpp
really show the window after creation (calling Show(TRUE) doesn't do it any more)
[wxWidgets.git] / src / common / menucmn.cpp
index 86b13483796a482c63a01dab24417fb765d7d8e3..b272d1483d48b7c3eef1bf35785e176375520187 100644 (file)
@@ -6,7 +6,7 @@
 // Created:     26.10.99
 // RCS-ID:      $Id$
 // Copyright:   (c) wxWindows team
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 // headers
 // ----------------------------------------------------------------------------
 
-#ifdef __GNUG__
+#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 <ctype.h>
-
 #ifdef __BORLANDC__
     #pragma hdrstop
 #endif
 
+#if wxUSE_MENUS
+
+#include <ctype.h>
+
 #ifndef WX_PRECOMP
+    #include "wx/intl.h"
+    #include "wx/log.h"
     #include "wx/menu.h"
 #endif
 
@@ -51,14 +55,176 @@ WX_DEFINE_LIST(wxMenuItemList);
 // wxMenuItem
 // ----------------------------------------------------------------------------
 
+wxMenuItemBase::wxMenuItemBase(wxMenu *parentMenu,
+                               int id,
+                               const wxString& text,
+                               const wxString& help,
+                               wxItemKind kind,
+                               wxMenu *subMenu)
+              : m_text(text),
+                m_help(help)
+{
+    wxASSERT_MSG( parentMenu != NULL, wxT("menuitem should have a menu") );
+
+    m_parentMenu  = parentMenu;
+    m_subMenu     = subMenu;
+    m_isEnabled   = TRUE;
+    m_isChecked   = FALSE;
+    m_id          = id;
+    m_kind        = kind;
+    if (m_id == wxID_ANY)
+        m_id = wxNewId();
+    if (m_id == wxID_SEPARATOR)
+        m_kind = wxITEM_SEPARATOR;
+}
+
 wxMenuItemBase::~wxMenuItemBase()
 {
-    if (m_subMenu)
-        delete m_subMenu;
+    delete m_subMenu;
 }
 
 #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());
+}
+
 void wxMenuItemBase::SetAccel(wxAcceleratorEntry *accel)
 {
     wxString text = m_text.BeforeFirst(wxT('\t'));
@@ -112,14 +278,14 @@ void wxMenuItemBase::SetAccel(wxAcceleratorEntry *accel)
 
 #endif // wxUSE_ACCEL
 
+bool wxMenuBase::ms_locked = true;
+
 // ----------------------------------------------------------------------------
 // wxMenu ctor and dtor
 // ----------------------------------------------------------------------------
 
 void wxMenuBase::Init(long style)
 {
-    m_items.DeleteContents(TRUE);
-
     m_menuBar = (wxMenuBar *)NULL;
     m_menuParent = (wxMenu *)NULL;
 
@@ -127,34 +293,43 @@ void wxMenuBase::Init(long style)
     m_style = style;
     m_clientData = (void *)NULL;
     m_eventHandler = this;
-
-#if wxUSE_MENU_CALLBACK
-    m_callback = (wxFunction) NULL;
-#endif // wxUSE_MENU_CALLBACK
 }
 
 wxMenuBase::~wxMenuBase()
 {
-    // nothing to do, wxMenuItemList dtor will delete the menu items.
-       // Actually, in GTK, the submenus have to get deleted first.
+    WX_CLEAR_LIST(wxMenuItemList, m_items);
+
+    // Actually, in GTK, the submenus have to get deleted first.
 }
 
 // ----------------------------------------------------------------------------
 // wxMenu item adding/removing
 // ----------------------------------------------------------------------------
 
-bool wxMenuBase::DoAppend(wxMenuItem *item)
+void wxMenuBase::AddSubMenu(wxMenu *submenu)
+{
+    wxCHECK_RET( submenu, _T("can't add a NULL submenu") );
+
+    submenu->SetParent((wxMenu *)this);
+}
+
+wxMenuItem* wxMenuBase::DoAppend(wxMenuItem *item)
 {
-    wxCHECK_MSG( item, FALSE, wxT("invalid item in wxMenu::Append()") );
+    wxCHECK_MSG( item, NULL, wxT("invalid item in wxMenu::Append()") );
 
     m_items.Append(item);
+    item->SetMenu((wxMenu*)this);
+    if ( item->IsSubMenu() )
+    {
+        AddSubMenu(item->GetSubMenu());
+    }
 
-    return TRUE;
+    return item;
 }
 
-bool wxMenuBase::Insert(size_t pos, wxMenuItem *item)
+wxMenuItem* wxMenuBase::Insert(size_t pos, wxMenuItem *item)
 {
-    wxCHECK_MSG( item, FALSE, wxT("invalid item in wxMenu::Insert") );
+    wxCHECK_MSG( item, NULL, wxT("invalid item in wxMenu::Insert") );
 
     if ( pos == GetMenuItemCount() )
     {
@@ -169,16 +344,21 @@ bool wxMenuBase::Insert(size_t pos, wxMenuItem *item)
     }
 }
 
-bool wxMenuBase::DoInsert(size_t pos, wxMenuItem *item)
+wxMenuItem* wxMenuBase::DoInsert(size_t pos, wxMenuItem *item)
 {
-    wxCHECK_MSG( item, FALSE, wxT("invalid item in wxMenu::Insert()") );
+    wxCHECK_MSG( item, NULL, wxT("invalid item in wxMenu::Insert()") );
 
-    wxMenuItemList::Node *node = m_items.Item(pos);
+    wxMenuItemList::compatibility_iterator node = m_items.Item(pos);
     wxCHECK_MSG( node, FALSE, wxT("invalid index in wxMenu::Insert()") );
 
     m_items.Insert(node, item);
+    item->SetMenu((wxMenu*)this);
+    if ( item->IsSubMenu() )
+    {
+        AddSubMenu(item->GetSubMenu());
+    }
 
-    return TRUE;
+    return item;
 }
 
 wxMenuItem *wxMenuBase::Remove(wxMenuItem *item)
@@ -190,17 +370,17 @@ wxMenuItem *wxMenuBase::Remove(wxMenuItem *item)
 
 wxMenuItem *wxMenuBase::DoRemove(wxMenuItem *item)
 {
-    wxMenuItemList::Node *node = m_items.Find(item);
+    wxMenuItemList::compatibility_iterator node = m_items.Find(item);
 
     // if we get here, the item is valid or one of Remove() functions is broken
     wxCHECK_MSG( node, NULL, wxT("bug in wxMenu::Remove logic") );
 
     // we detach the item, but we do delete the list node (i.e. don't call
     // DetachNode() here!)
-    node->SetData((wxMenuItem *)NULL);  // to prevent it from deleting the item
-    m_items.DeleteNode(node);
+    m_items.Erase(node);
 
     // item isn't attached to anything any more
+    item->SetMenu((wxMenu *)NULL);
     wxMenu *submenu = item->GetSubMenu();
     if ( submenu )
     {
@@ -255,7 +435,7 @@ bool wxMenuBase::DoDestroy(wxMenuItem *item)
 int wxMenuBase::FindItem(const wxString& text) const
 {
     wxString label = wxMenuItem::GetLabelFromText(text);
-    for ( wxMenuItemList::Node *node = m_items.GetFirst();
+    for ( wxMenuItemList::compatibility_iterator node = m_items.GetFirst();
           node;
           node = node->GetNext() )
     {
@@ -266,7 +446,10 @@ int wxMenuBase::FindItem(const wxString& text) const
             if ( rc != wxNOT_FOUND )
                 return rc;
         }
-        else if ( !item->IsSeparator() )
+
+        // we execute this code for submenus as well to alllow finding them by
+        // name just like the ordinary items
+        if ( !item->IsSeparator() )
         {
             if ( item->GetLabel() == label )
                 return item->GetId();
@@ -283,7 +466,7 @@ wxMenuItem *wxMenuBase::FindItem(int itemId, wxMenu **itemMenu) const
         *itemMenu = NULL;
 
     wxMenuItem *item = NULL;
-    for ( wxMenuItemList::Node *node = m_items.GetFirst();
+    for ( wxMenuItemList::compatibility_iterator node = m_items.GetFirst();
           node && !item;
           node = node->GetNext() )
     {
@@ -312,7 +495,7 @@ wxMenuItem *wxMenuBase::FindItem(int itemId, wxMenu **itemMenu) const
 wxMenuItem *wxMenuBase::FindChildItem(int id, size_t *ppos) const
 {
     wxMenuItem *item = (wxMenuItem *)NULL;
-    wxMenuItemList::Node *node = GetMenuItems().GetFirst();
+    wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst();
 
     size_t pos;
     for ( pos = 0; node; pos++ )
@@ -335,8 +518,17 @@ wxMenuItem *wxMenuBase::FindChildItem(int id, size_t *ppos) const
     return item;
 }
 
+// find by position
+wxMenuItem* wxMenuBase::FindItemByPosition(size_t position) const
+{
+    wxCHECK_MSG( position < m_items.GetCount(), NULL,
+                 _T("wxMenu::FindItemByPosition(): invalid menu index") );
+
+    return m_items.Item( position )->GetData();
+}
+
 // ----------------------------------------------------------------------------
-// wxMenu helpers
+// wxMenu helpers used by derived classes
 // ----------------------------------------------------------------------------
 
 // Update a menu and all submenus recursively. source is the object that has
@@ -344,6 +536,15 @@ wxMenuItem *wxMenuBase::FindChildItem(int id, size_t *ppos) const
 // 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 )
@@ -351,7 +552,7 @@ void wxMenuBase::UpdateUI(wxEvtHandler* source)
     if ( !source )
         source = this;
 
-    wxMenuItemList::Node* node = GetMenuItems().GetFirst();
+    wxMenuItemList::compatibility_iterator  node = GetMenuItems().GetFirst();
     while ( node )
     {
         wxMenuItem* item = node->GetData();
@@ -363,7 +564,7 @@ void wxMenuBase::UpdateUI(wxEvtHandler* source)
 
             if ( source->ProcessEvent(event) )
             {
-                // if anything changed, update the chanegd attribute
+                // if anything changed, update the changed attribute
                 if (event.GetSetText())
                     SetLabel(id, event.GetText());
                 if (event.GetSetChecked())
@@ -376,12 +577,79 @@ void wxMenuBase::UpdateUI(wxEvtHandler* source)
             if ( item->GetSubMenu() )
                 item->GetSubMenu()->UpdateUI(source);
         }
-        //else: item is a separator (which don't process update UI events)
+        //else: item is a separator (which doesn't process update UI events)
 
         node = node->GetNext();
     }
 }
 
+bool wxMenuBase::SendEvent(int id, int checked)
+{
+    wxCommandEvent event(wxEVT_COMMAND_MENU_SELECTED, id);
+    event.SetEventObject(this);
+    event.SetInt(checked);
+
+    bool processed = FALSE;
+
+    // Try the menu's event handler
+    if ( !processed )
+    {
+        wxEvtHandler *handler = GetEventHandler();
+        if ( handler )
+            processed = handler->ProcessEvent(event);
+    }
+
+    // Try the window the menu was popped up from (and up through the
+    // hierarchy)
+    if ( !processed )
+    {
+        const wxMenuBase *menu = this;
+        while ( menu )
+        {
+            wxWindow *win = menu->GetInvokingWindow();
+            if ( win )
+            {
+                processed = win->GetEventHandler()->ProcessEvent(event);
+                break;
+            }
+
+            menu = menu->GetParent();
+        }
+    }
+
+    return processed;
+}
+
+// ----------------------------------------------------------------------------
+// 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!
+    wxASSERT_MSG( menubar, _T("menu can't be attached to NULL menubar") );
+
+    // use IsAttached() to prevent this from happening
+    wxASSERT_MSG( !m_menuBar, _T("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?") );
+
+    m_menuBar = NULL;
+}
+
 // ----------------------------------------------------------------------------
 // wxMenu functions forwarded to wxMenuItem
 // ----------------------------------------------------------------------------
@@ -464,14 +732,13 @@ wxString wxMenuBase::GetHelpString( int id ) const
 
 wxMenuBarBase::wxMenuBarBase()
 {
-    // we own the menus when we get them
-    m_menus.DeleteContents(TRUE);
+    // not attached yet
+    m_menuBarFrame = NULL;
 }
 
 wxMenuBarBase::~wxMenuBarBase()
 {
-    // nothing to do, the list will delete the menus because of the call to
-    // DeleteContents() above
+    WX_CLEAR_LIST(wxMenuList, m_menus);
 }
 
 // ----------------------------------------------------------------------------
@@ -481,7 +748,7 @@ wxMenuBarBase::~wxMenuBarBase()
 
 wxMenu *wxMenuBarBase::GetMenu(size_t pos) const
 {
-    wxMenuList::Node *node = m_menus.Item(pos);
+    wxMenuList::compatibility_iterator node = m_menus.Item(pos);
     wxCHECK_MSG( node, NULL, wxT("bad index in wxMenuBar::GetMenu()") );
 
     return node->GetData();
@@ -492,6 +759,7 @@ bool wxMenuBarBase::Append(wxMenu *menu, const wxString& WXUNUSED(title))
     wxCHECK_MSG( menu, FALSE, wxT("can't append NULL menu") );
 
     m_menus.Append(menu);
+    menu->Attach(this);
 
     return TRUE;
 }
@@ -501,16 +769,17 @@ bool wxMenuBarBase::Insert(size_t pos, wxMenu *menu,
 {
     if ( pos == m_menus.GetCount() )
     {
-        return Append(menu, title);
+        return wxMenuBarBase::Append(menu, title);
     }
-    else
+    else // not at the end
     {
         wxCHECK_MSG( menu, FALSE, wxT("can't insert NULL menu") );
 
-        wxMenuList::Node *node = m_menus.Item(pos);
+        wxMenuList::compatibility_iterator node = m_menus.Item(pos);
         wxCHECK_MSG( node, FALSE, wxT("bad index in wxMenuBar::Insert()") );
 
         m_menus.Insert(node, menu);
+        menu->Attach(this);
 
         return TRUE;
     }
@@ -521,25 +790,26 @@ wxMenu *wxMenuBarBase::Replace(size_t pos, wxMenu *menu,
 {
     wxCHECK_MSG( menu, NULL, wxT("can't insert NULL menu") );
 
-    wxMenuList::Node *node = m_menus.Item(pos);
+    wxMenuList::compatibility_iterator node = m_menus.Item(pos);
     wxCHECK_MSG( node, NULL, wxT("bad index in wxMenuBar::Replace()") );
 
     wxMenu *menuOld = node->GetData();
     node->SetData(menu);
 
+    menu->Attach(this);
+    menuOld->Detach();
+
     return menuOld;
 }
 
 wxMenu *wxMenuBarBase::Remove(size_t pos)
 {
-    wxMenuList::Node *node = m_menus.Item(pos);
+    wxMenuList::compatibility_iterator node = m_menus.Item(pos);
     wxCHECK_MSG( node, NULL, wxT("bad index in wxMenuBar::Remove()") );
 
-    node = m_menus.DetachNode(node);
-    wxCHECK( node, NULL );  // unexpected
     wxMenu *menu = node->GetData();
-
-    delete node;
+    m_menus.Erase(node);
+    menu->Detach();
 
     return menu;
 }
@@ -556,7 +826,7 @@ int wxMenuBarBase::FindMenu(const wxString& title) const
              (wxMenuItem::GetLabelFromText(title2) == label) )
         {
             // found
-            return (int)i; 
+            return (int)i;
         }
     }
 
@@ -564,6 +834,59 @@ int wxMenuBarBase::FindMenu(const wxString& title) const
 
 }
 
+// ----------------------------------------------------------------------------
+// wxMenuBar attaching/detaching to/from the frame
+// ----------------------------------------------------------------------------
+
+void wxMenuBarBase::Attach(wxFrame *frame)
+{
+    wxASSERT_MSG( !IsAttached(), wxT("menubar already attached!") );
+
+    m_menuBarFrame = frame;
+}
+
+void wxMenuBarBase::Detach()
+{
+    wxASSERT_MSG( IsAttached(), wxT("detaching unattached menubar") );
+
+    m_menuBarFrame = NULL;
+}
+
+// ----------------------------------------------------------------------------
+// wxMenuBar searching for items
+// ----------------------------------------------------------------------------
+
+wxMenuItem *wxMenuBarBase::FindItem(int id, wxMenu **menu) const
+{
+    if ( menu )
+        *menu = NULL;
+
+    wxMenuItem *item = NULL;
+    size_t count = GetMenuCount(), i;
+    wxMenuList::const_iterator it;
+    for ( i = 0, it = m_menus.begin(); !item && (i < count); i++, it++ )
+    {
+        item = (*it)->FindItem(id, menu);
+    }
+
+    return item;
+}
+
+int wxMenuBarBase::FindMenuItem(const wxString& menu, const wxString& item) const
+{
+    wxString label = wxMenuItem::GetLabelFromText(menu);
+
+    int i = 0;
+    wxMenuList::compatibility_iterator node;
+    for ( node = m_menus.GetFirst(); node; node = node->GetNext(), i++ )
+    {
+        if ( label == wxMenuItem::GetLabelFromText(GetLabelTop(i)) )
+            return node->GetData()->FindItem(item);
+    }
+
+    return wxNOT_FOUND;
+}
+
 // ---------------------------------------------------------------------------
 // wxMenuBar functions forwarded to wxMenuItem
 // ---------------------------------------------------------------------------
@@ -643,3 +966,4 @@ wxString wxMenuBarBase::GetHelpString(int id) const
     return item->GetHelp();
 }
 
+#endif // wxUSE_MENUS