]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/menucmn.cpp
VC6 compilation fix for native wxProgressDialog implementation.
[wxWidgets.git] / src / common / menucmn.cpp
index 2b65f80845f0bf2a7d25c7483c6bcaf87bf7274c..4c7abae78dbeedb04f4e4ad023d705f2a0dc13f0 100644 (file)
@@ -30,6 +30,7 @@
     #include "wx/intl.h"
     #include "wx/log.h"
     #include "wx/menu.h"
+    #include "wx/frame.h"
 #endif
 
 #include "wx/stockitem.h"
@@ -58,20 +59,49 @@ wxMenuItemBase::wxMenuItemBase(wxMenu *parentMenu,
                                wxItemKind kind,
                                wxMenu *subMenu)
 {
-    wxASSERT_MSG( parentMenu != NULL, wxT("menuitem should have a menu") );
+    switch ( id )
+    {
+        case wxID_ANY:
+            m_id = wxWindow::NewControlId();
+            break;
+
+        case wxID_SEPARATOR:
+            m_id = wxID_SEPARATOR;
+
+            // there is a lot of existing code just doing Append(wxID_SEPARATOR)
+            // and it makes sense to omit the following optional parameters,
+            // including the kind one which doesn't default to wxITEM_SEPARATOR,
+            // of course, so override it here
+            kind = wxITEM_SEPARATOR;
+            break;
+
+        case wxID_NONE:
+            // (popup) menu titles in wxMSW use this ID to indicate that
+            // it's not a real menu item, so we don't want the check below to
+            // apply to it
+            m_id = id;
+            break;
+
+        default:
+            // ids are limited to 16 bits under MSW so portable code shouldn't
+            // use ids outside of this range (negative ids generated by wx are
+            // fine though)
+            wxASSERT_MSG( (id >= 0 && id < SHRT_MAX) ||
+                            (id >= wxID_AUTO_LOWEST && id <= wxID_AUTO_HIGHEST),
+                          wxS("invalid id value") );
+            m_id = id;
+    }
+
+    // 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_id          = id;
     m_kind        = kind;
-    if (m_id == wxID_ANY)
-        m_id = wxNewId();
-    if (m_id == wxID_SEPARATOR)
-        m_kind = wxITEM_SEPARATOR;
 
-    SetText(text);
+    SetItemLabel(text);
     SetHelp(help);
 }
 
@@ -84,7 +114,7 @@ wxMenuItemBase::~wxMenuItemBase()
 
 wxAcceleratorEntry *wxMenuItemBase::GetAccel() const
 {
-    return wxAcceleratorEntry::Create(GetText());
+    return wxAcceleratorEntry::Create(GetItemLabel());
 }
 
 void wxMenuItemBase::SetAccel(wxAcceleratorEntry *accel)
@@ -96,12 +126,12 @@ void wxMenuItemBase::SetAccel(wxAcceleratorEntry *accel)
         text += accel->ToString();
     }
 
-    SetText(text);
+    SetItemLabel(text);
 }
 
 #endif // wxUSE_ACCEL
 
-void wxMenuItemBase::SetText(const wxString& str)
+void wxMenuItemBase::SetItemLabel(const wxString& str)
 {
     m_text = str;
 
@@ -125,6 +155,20 @@ void wxMenuItemBase::SetHelp(const wxString& str)
     }
 }
 
+#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;
 
 // ----------------------------------------------------------------------------
@@ -133,20 +177,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.
 }
 
 // ----------------------------------------------------------------------------
@@ -155,7 +197,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);
 }
@@ -227,11 +269,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();
     }
@@ -252,7 +294,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;
 
@@ -283,7 +325,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() )
@@ -300,7 +342,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();
         }
     }
@@ -343,7 +385,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;
@@ -371,7 +413,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();
 }
@@ -440,30 +482,17 @@ bool wxMenuBase::SendEvent(int id, int checked)
 
     bool processed = false;
 
-    // Try the menu's event handler
-    // if ( !processed )
-    {
-        wxEvtHandler *handler = GetEventHandler();
-        if ( handler )
-            processed = handler->ProcessEvent(event);
-    }
+    // Try the menu's event handler first
+    wxEvtHandler *handler = GetEventHandler();
+    if ( handler )
+        processed = handler->SafelyProcessEvent(event);
 
-    // Try the window the menu was popped up from (and up through the
-    // hierarchy)
+    // Try the window the menu was popped up from or its menu bar belongs to
     if ( !processed )
     {
-        const wxMenuBase *menu = this;
-        while ( menu )
-        {
-            wxWindow *win = menu->GetInvokingWindow();
-            if ( win )
-            {
-                processed = win->GetEventHandler()->ProcessEvent(event);
-                break;
-            }
-
-            menu = menu->GetParent();
-        }
+        wxWindow * const win = GetWindow();
+        if ( win )
+            processed = win->HandleWindowEvent(event);
     }
 
     return processed;
@@ -483,10 +512,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;
 }
@@ -494,11 +523,39 @@ 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;
 }
 
+// ----------------------------------------------------------------------------
+// wxMenu invoking window handling
+// ----------------------------------------------------------------------------
+
+void wxMenuBase::SetInvokingWindow(wxWindow *win)
+{
+    wxASSERT_MSG( !GetParent(),
+                    "should only be called for top level popup menus" );
+    wxASSERT_MSG( !IsAttached(),
+                    "menus attached to menu bar can't have invoking window" );
+
+    m_invokingWindow = win;
+}
+
+wxWindow *wxMenuBase::GetWindow() const
+{
+    // only the top level menus have non-NULL invoking window or a pointer to
+    // the menu bar so recurse upwards until we find it
+    const wxMenuBase *menu = this;
+    while ( menu->GetParent() )
+    {
+        menu = menu->GetParent();
+    }
+
+    return menu->GetMenuBar() ? menu->GetMenuBar()->GetFrame()
+                              : menu->GetInvokingWindow();
+}
+
 // ----------------------------------------------------------------------------
 // wxMenu functions forwarded to wxMenuItem
 // ----------------------------------------------------------------------------
@@ -545,7 +602,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
@@ -554,7 +611,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 )
@@ -603,9 +660,10 @@ wxMenu *wxMenuBarBase::GetMenu(size_t pos) const
     return node->GetData();
 }
 
-bool wxMenuBarBase::Append(wxMenu *menu, const wxString& WXUNUSED(title))
+bool wxMenuBarBase::Append(wxMenu *menu, const wxString& title)
 {
     wxCHECK_MSG( menu, false, wxT("can't append NULL menu") );
+    wxCHECK_MSG( !title.empty(), false, wxT("can't append menu with empty title") );
 
     m_menus.Append(menu);
     menu->Attach(this);
@@ -665,14 +723,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;
@@ -723,13 +781,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);
     }
 
@@ -783,7 +841,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
@@ -793,7 +851,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)
@@ -815,7 +873,7 @@ wxString wxMenuBarBase::GetHelpString(int id) const
     return item->GetHelp();
 }
 
-void wxMenuBarBase::UpdateMenus( void )
+void wxMenuBarBase::UpdateMenus()
 {
     wxEvtHandler* source;
     wxMenu* menu;
@@ -832,4 +890,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