modifications to URL<->filename conversion: take wxFileName, rename

[wxWidgets.git] / src / common / menucmn.cpp

diff --git a/src/common/menucmn.cpp b/src/common/menucmn.cpp
index 6c2e5631a7a6ac04300e6eb3b3d24b1cb5bca966..05bb4f7f8c1c8ef5ede084d4eee852280b571fea 100644 (file)
--- a/src/common/menucmn.cpp
+++ b/src/common/menucmn.cpp
@@ -28,7 +28,13 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

+#if wxUSE_MENUS
+
+#include <ctype.h>
+

 #ifndef WX_PRECOMP
 #ifndef WX_PRECOMP

+    #include "wx/intl.h"
+    #include "wx/log.h"

     #include "wx/menu.h"
 #endif
 
     #include "wx/menu.h"
 #endif
 


@@ -49,6 +55,25 @@ WX_DEFINE_LIST(wxMenuItemList);
 // wxMenuItem
 // ----------------------------------------------------------------------------
 
 // 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;
+}
+

 wxMenuItemBase::~wxMenuItemBase()
 {
     delete m_subMenu;
 wxMenuItemBase::~wxMenuItemBase()
 {
     delete m_subMenu;


@@ -56,6 +81,140 @@ wxMenuItemBase::~wxMenuItemBase()
 
 #if wxUSE_ACCEL
 
 
 #if wxUSE_ACCEL
 

+// return wxAcceleratorEntry for the given menu string or NULL if none
+// specified
+wxAcceleratorEntry *wxGetAccelFromString(const wxString& label)
+{
+    // 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 ( current == _("ctrl") )
+                    accelFlags |= wxACCEL_CTRL;
+                else if ( current == _("alt") )
+                    accelFlags |= wxACCEL_ALT;
+                else if ( current == _("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 += 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 = wxToupper(current[0U]);
+            }
+            else {
+                // is it a function key?
+                if ( current[0U] == 'f' && isdigit(current[1U]) &&
+                     (current.Len() == 2 ||
+                     (current.Len() == 3 && isdigit(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("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
+                    {
+                        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'));
 void wxMenuItemBase::SetAccel(wxAcceleratorEntry *accel)
 {
     wxString text = m_text.BeforeFirst(wxT('\t'));


@@ -124,22 +283,44 @@ void wxMenuBase::Init(long style)
     m_style = style;
     m_clientData = (void *)NULL;
     m_eventHandler = this;
     m_style = style;
     m_clientData = (void *)NULL;
     m_eventHandler = this;

+
+#if wxUSE_MENU_CALLBACK
+    m_callback = (wxFunction) NULL;
+#endif // wxUSE_MENU_CALLBACK

 }
 
 wxMenuBase::~wxMenuBase()
 {
 }
 
 wxMenuBase::~wxMenuBase()
 {

-    // nothing to do, wxMenuItemList dtor will delete the menu items
+    // nothing to do, wxMenuItemList dtor will delete the menu items.
+
+    // Actually, in GTK, the submenus have to get deleted first.

 }
 
 // ----------------------------------------------------------------------------
 // wxMenu item adding/removing
 // ----------------------------------------------------------------------------
 
 }
 
 // ----------------------------------------------------------------------------
 // wxMenu item adding/removing
 // ----------------------------------------------------------------------------
 

+void wxMenuBase::AddSubMenu(wxMenu *submenu)
+{
+    wxCHECK_RET( submenu, _T("can't add a NULL submenu") );
+
+    if ( m_menuBar )
+    {
+        submenu->Attach(m_menuBar);
+    }
+
+    submenu->SetParent((wxMenu *)this);
+}
+

 bool wxMenuBase::DoAppend(wxMenuItem *item)
 {
     wxCHECK_MSG( item, FALSE, wxT("invalid item in wxMenu::Append()") );
 
     m_items.Append(item);
 bool wxMenuBase::DoAppend(wxMenuItem *item)
 {
     wxCHECK_MSG( item, FALSE, wxT("invalid item in wxMenu::Append()") );
 
     m_items.Append(item);

+    if ( item->IsSubMenu() )
+    {
+        AddSubMenu(item->GetSubMenu());
+    }

 
     return TRUE;
 }
 
     return TRUE;
 }


@@ -147,10 +328,18 @@ bool wxMenuBase::DoAppend(wxMenuItem *item)
 bool wxMenuBase::Insert(size_t pos, wxMenuItem *item)
 {
     wxCHECK_MSG( item, FALSE, wxT("invalid item in wxMenu::Insert") );
 bool wxMenuBase::Insert(size_t pos, wxMenuItem *item)
 {
     wxCHECK_MSG( item, FALSE, wxT("invalid item in wxMenu::Insert") );

-    wxCHECK_MSG( pos < GetMenuItemCount(), FALSE,
-                 wxT("invalid index in wxMenu::Insert") );

 
 

-    return DoInsert(pos, item);
+    if ( pos == GetMenuItemCount() )
+    {
+        return DoAppend(item);
+    }
+    else
+    {
+        wxCHECK_MSG( pos < GetMenuItemCount(), FALSE,
+                     wxT("invalid index in wxMenu::Insert") );
+
+        return DoInsert(pos, item);
+    }

 }
 
 bool wxMenuBase::DoInsert(size_t pos, wxMenuItem *item)
 }
 
 bool wxMenuBase::DoInsert(size_t pos, wxMenuItem *item)


@@ -161,6 +350,10 @@ bool wxMenuBase::DoInsert(size_t pos, wxMenuItem *item)
     wxCHECK_MSG( node, FALSE, wxT("invalid index in wxMenu::Insert()") );
 
     m_items.Insert(node, item);
     wxCHECK_MSG( node, FALSE, wxT("invalid index in wxMenu::Insert()") );
 
     m_items.Insert(node, item);

+    if ( item->IsSubMenu() )
+    {
+        AddSubMenu(item->GetSubMenu());
+    }

 
     return TRUE;
 }
 
     return TRUE;
 }


@@ -196,7 +389,7 @@ wxMenuItem *wxMenuBase::DoRemove(wxMenuItem *item)
 
 bool wxMenuBase::Delete(wxMenuItem *item)
 {
 
 bool wxMenuBase::Delete(wxMenuItem *item)
 {

-    wxCHECK_MSG( item, NULL, wxT("invalid item in wxMenu::Delete") );
+    wxCHECK_MSG( item, FALSE, wxT("invalid item in wxMenu::Delete") );

 
     return DoDelete(item);
 }
 
     return DoDelete(item);
 }


@@ -216,7 +409,7 @@ bool wxMenuBase::DoDelete(wxMenuItem *item)
 
 bool wxMenuBase::Destroy(wxMenuItem *item)
 {
 
 bool wxMenuBase::Destroy(wxMenuItem *item)
 {

-    wxCHECK_MSG( item, NULL, wxT("invalid item in wxMenu::Destroy") );
+    wxCHECK_MSG( item, FALSE, wxT("invalid item in wxMenu::Destroy") );

 
     return DoDestroy(item);
 }
 
     return DoDestroy(item);
 }


@@ -238,7 +431,7 @@ bool wxMenuBase::DoDestroy(wxMenuItem *item)
 // Finds the item id matching the given string, -1 if not found.
 int wxMenuBase::FindItem(const wxString& text) const
 {
 // Finds the item id matching the given string, -1 if not found.
 int wxMenuBase::FindItem(const wxString& text) const
 {

-    wxString label = wxMenuItem(NULL, wxID_SEPARATOR, text).GetLabel();
+    wxString label = wxMenuItem::GetLabelFromText(text);

     for ( wxMenuItemList::Node *node = m_items.GetFirst();
           node;
           node = node->GetNext() )
     for ( wxMenuItemList::Node *node = m_items.GetFirst();
           node;
           node = node->GetNext() )


@@ -250,7 +443,10 @@ int wxMenuBase::FindItem(const wxString& text) const
             if ( rc != wxNOT_FOUND )
                 return rc;
         }
             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();
         {
             if ( item->GetLabel() == label )
                 return item->GetId();


@@ -320,7 +516,7 @@ wxMenuItem *wxMenuBase::FindChildItem(int id, size_t *ppos) const
 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------

-// wxMenu helpers
+// wxMenu helpers used by derived classes

 // ----------------------------------------------------------------------------
 
 // Update a menu and all submenus recursively. source is the object that has
 // ----------------------------------------------------------------------------
 
 // Update a menu and all submenus recursively. source is the object that has


@@ -366,6 +562,75 @@ void wxMenuBase::UpdateUI(wxEvtHandler* source)
     }
 }
 
     }
 }
 

+bool wxMenuBase::SendEvent(int id, int checked)
+{
+    wxCommandEvent event(wxEVT_COMMAND_MENU_SELECTED, id);
+    event.SetEventObject(this);
+    event.SetInt(checked);
+
+    bool processed = FALSE;
+
+#if wxUSE_MENU_CALLBACK
+    // Try a callback
+    if (m_callback)
+    {
+        (void)(*(m_callback))(*this, event);
+        processed = TRUE;
+    }
+#endif // wxUSE_MENU_CALLBACK
+
+    // 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
+// ----------------------------------------------------------------------------
+
+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
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxMenu functions forwarded to wxMenuItem
 // ----------------------------------------------------------------------------


@@ -450,6 +715,9 @@ wxMenuBarBase::wxMenuBarBase()
 {
     // we own the menus when we get them
     m_menus.DeleteContents(TRUE);
 {
     // we own the menus when we get them
     m_menus.DeleteContents(TRUE);

+
+    // not attached yet
+    m_menuBarFrame = NULL;

 }
 
 wxMenuBarBase::~wxMenuBarBase()
 }
 
 wxMenuBarBase::~wxMenuBarBase()


@@ -476,21 +744,30 @@ bool wxMenuBarBase::Append(wxMenu *menu, const wxString& WXUNUSED(title))
     wxCHECK_MSG( menu, FALSE, wxT("can't append NULL menu") );
 
     m_menus.Append(menu);
     wxCHECK_MSG( menu, FALSE, wxT("can't append NULL menu") );
 
     m_menus.Append(menu);

+    menu->Attach(this);

 
     return TRUE;
 }
 
 bool wxMenuBarBase::Insert(size_t pos, wxMenu *menu,
 
     return TRUE;
 }
 
 bool wxMenuBarBase::Insert(size_t pos, wxMenu *menu,

-                           const wxString& WXUNUSED(title))
+                           const wxString& title)

 {
 {

-    wxCHECK_MSG( menu, FALSE, wxT("can't insert NULL menu") );
+    if ( pos == m_menus.GetCount() )
+    {
+        return wxMenuBarBase::Append(menu, title);
+    }
+    else // not at the end
+    {
+        wxCHECK_MSG( menu, FALSE, wxT("can't insert NULL menu") );

 
 

-    wxMenuList::Node *node = m_menus.Item(pos);
-    wxCHECK_MSG( node, FALSE, wxT("bad index in wxMenuBar::Insert()") );
+        wxMenuList::Node *node = m_menus.Item(pos);
+        wxCHECK_MSG( node, FALSE, wxT("bad index in wxMenuBar::Insert()") );

 
 

-    m_menus.Insert(node, menu);
+        m_menus.Insert(node, menu);
+        menu->Attach(this);

 
 

-    return TRUE;
+        return TRUE;
+    }

 }
 
 wxMenu *wxMenuBarBase::Replace(size_t pos, wxMenu *menu,
 }
 
 wxMenu *wxMenuBarBase::Replace(size_t pos, wxMenu *menu,


@@ -504,6 +781,9 @@ wxMenu *wxMenuBarBase::Replace(size_t pos, wxMenu *menu,
     wxMenu *menuOld = node->GetData();
     node->SetData(menu);
 
     wxMenu *menuOld = node->GetData();
     node->SetData(menu);
 

+    menu->Attach(this);
+    menuOld->Detach();
+

     return menuOld;
 }
 
     return menuOld;
 }
 


@@ -515,12 +795,85 @@ wxMenu *wxMenuBarBase::Remove(size_t pos)
     node = m_menus.DetachNode(node);
     wxCHECK( node, NULL );  // unexpected
     wxMenu *menu = node->GetData();
     node = m_menus.DetachNode(node);
     wxCHECK( node, NULL );  // unexpected
     wxMenu *menu = node->GetData();

+    menu->Detach();

 
     delete node;
 
     return menu;
 }
 
 
     delete node;
 
     return menu;
 }
 

+int wxMenuBarBase::FindMenu(const wxString& title) const
+{
+    wxString label = wxMenuItem::GetLabelFromText(title);
+
+    size_t count = GetMenuCount();
+    for ( size_t i = 0; i < count; i++ )
+    {
+        wxString title2 = GetLabelTop(i);
+        if ( (title2 == title) ||
+             (wxMenuItem::GetLabelFromText(title2) == label) )
+        {
+            // found
+            return (int)i;
+        }
+    }
+
+    return wxNOT_FOUND;
+
+}
+
+// ----------------------------------------------------------------------------
+// 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();
+    for ( size_t i = 0; !item && (i < count); i++ )
+    {
+        item = m_menus[i]->FindItem(id, menu);
+    }
+
+    return item;
+}
+
+int wxMenuBarBase::FindMenuItem(const wxString& menu, const wxString& item) const
+{
+    wxString label = wxMenuItem::GetLabelFromText(menu);
+
+    int i = 0;
+    wxMenuList::Node *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
 // ---------------------------------------------------------------------------
 // ---------------------------------------------------------------------------
 // wxMenuBar functions forwarded to wxMenuItem
 // ---------------------------------------------------------------------------


@@ -600,3 +953,4 @@ wxString wxMenuBarBase::GetHelpString(int id) const
     return item->GetHelp();
 }
 
     return item->GetHelp();
 }
 

+#endif // wxUSE_MENUS