Fix deprecating warning introduced in r72446.
[wxWidgets.git] / src / gtk / menu.cpp
index b506d195b6d0f039f9b9268435f84411eda47781..fe3ebb03a353acdea456d35e4b425dc9c9e14f51 100644 (file)
 
 #include "wx/accel.h"
 #include "wx/stockitem.h"
+
+#include <gtk/gtk.h>
 #include "wx/gtk/private.h"
+#include "wx/gtk/private/gtk2-compat.h"
 #include "wx/gtk/private/mnemonics.h"
 
 // we use normal item but with a special id for the menu title
@@ -58,6 +61,18 @@ static void DoCommonMenuCallbackCode(wxMenu *menu, wxMenuEvent& event)
 // wxMenuBar
 //-----------------------------------------------------------------------------
 
+wxMenuBar::~wxMenuBar()
+{
+    if (m_widget)
+    {
+        // Work around a probable bug in Ubuntu 12.04 which causes a warning if
+        // gtk_widget_destroy() is called on a wxMenuBar attached to a frame
+        GtkWidget* widget = m_widget;
+        m_widget = NULL;
+        g_object_unref(widget);
+    }
+}
+
 void wxMenuBar::Init(size_t n, wxMenu *menus[], const wxString titles[], long style)
 {
 #if wxUSE_LIBHILDON || wxUSE_LIBHILDON2
@@ -91,7 +106,7 @@ void wxMenuBar::Init(size_t n, wxMenu *menus[], const wxString titles[], long st
     GTKApplyWidgetStyle();
 #endif // wxUSE_LIBHILDON || wxUSE_LIBHILDON2/!wxUSE_LIBHILDON && !wxUSE_LIBHILDON2
 
-    g_object_ref(m_widget);
+    g_object_ref_sink(m_widget);
 
     for (size_t i = 0; i < n; ++i )
         Append(menus[i], titles[i]);
@@ -126,7 +141,7 @@ DetachFromFrame(wxMenu* menu, wxFrame* frame)
         // Note that wxGetTopLevelParent() is really needed because this frame
         // can be an MDI child frame which is a fake frame and not a TLW at all
         GtkWindow * const tlw = GTK_WINDOW(wxGetTopLevelParent(frame)->m_widget);
-        if (g_slist_find(menu->m_accel->acceleratables, tlw))
+        if (g_slist_find(gtk_accel_groups_from_object(G_OBJECT(tlw)), menu->m_accel))
             gtk_window_remove_accel_group(tlw, menu->m_accel);
     }
 
@@ -147,7 +162,7 @@ AttachToFrame(wxMenu* menu, wxFrame* frame)
     if (menu->m_accel)
     {
         GtkWindow * const tlw = GTK_WINDOW(wxGetTopLevelParent(frame)->m_widget);
-        if (!g_slist_find(menu->m_accel->acceleratables, tlw))
+        if (!g_slist_find(gtk_accel_groups_from_object(G_OBJECT(tlw)), menu->m_accel))
             gtk_window_add_accel_group(tlw, menu->m_accel);
     }
 
@@ -230,13 +245,15 @@ void wxMenuBar::Detach()
 
 bool wxMenuBar::Append( wxMenu *menu, const wxString &title )
 {
-    if ( !wxMenuBarBase::Append( menu, title ) )
-        return false;
-
-    return GtkAppend(menu, title);
+    if (wxMenuBarBase::Append(menu, title))
+    {
+        GtkAppend(menu, title);
+        return true;
+    }
+    return false;
 }
 
-bool wxMenuBar::GtkAppend(wxMenu *menu, const wxString& title, int pos)
+void wxMenuBar::GtkAppend(wxMenu* menu, const wxString& title, int pos)
 {
     menu->SetLayoutDirection(GetLayoutDirection());
 
@@ -251,7 +268,10 @@ bool wxMenuBar::GtkAppend(wxMenu *menu, const wxString& title, int pos)
         const wxString str(wxStripMenuCodes(item->GetItemLabel()));
 
         if ( item->IsSubMenu() )
-            return GtkAppend(item->GetSubMenu(), str, pos);
+        {
+            GtkAppend(item->GetSubMenu(), str, pos);
+            return;
+        }
 
         menu->m_owner = gtk_menu_item_new_with_mnemonic( wxGTK_CONV( str ) );
 
@@ -282,21 +302,16 @@ bool wxMenuBar::GtkAppend(wxMenu *menu, const wxString& title, int pos)
 
     if ( m_menuBarFrame )
         AttachToFrame( menu, m_menuBarFrame );
-
-    return true;
 }
 
 bool wxMenuBar::Insert(size_t pos, wxMenu *menu, const wxString& title)
 {
-    if ( !wxMenuBarBase::Insert(pos, menu, title) )
-        return false;
-
-    // TODO
-
-    if ( !GtkAppend(menu, title, (int)pos) )
-        return false;
-
-    return true;
+    if (wxMenuBarBase::Insert(pos, menu, title))
+    {
+        GtkAppend(menu, title, int(pos));
+        return true;
+    }
+    return false;
 }
 
 wxMenu *wxMenuBar::Replace(size_t pos, wxMenu *menu, const wxString& title)
@@ -416,6 +431,15 @@ void wxMenuBar::EnableTop( size_t pos, bool flag )
         gtk_widget_set_sensitive( menu->m_owner, flag );
 }
 
+bool wxMenuBar::IsEnabledTop(size_t pos) const
+{
+    wxMenuList::compatibility_iterator node = m_menus.Item( pos );
+    wxCHECK_MSG( node, false, wxS("invalid index in IsEnabledTop") );
+    wxMenu* const menu = node->GetData();
+    wxCHECK_MSG( menu->m_owner, true, wxS("no menu owner?") );
+    return gtk_widget_get_sensitive( menu->m_owner ) != 0;
+}
+
 wxString wxMenuBar::GetMenuLabel( size_t pos ) const
 {
     wxMenuList::compatibility_iterator node = m_menus.Item( pos );
@@ -660,6 +684,13 @@ static void menu_map(GtkWidget*, wxMenu* menu)
 // "hide" from m_menu
 static void menu_hide(GtkWidget*, wxMenu* menu)
 {
+    // When using Ubuntu Unity desktop environment we get "hide" signal even
+    // when the window is not shown yet because Unity hides all the menus to
+    // show them only in the global menu bar. Just ignore this even instead of
+    // crashing in DoCommonMenuCallbackCode().
+    if ( !menu->GetWindow() )
+        return;
+
     wxMenuEvent event(wxEVT_MENU_CLOSE, menu->m_popupShown ? -1 : 0, menu);
     menu->m_popupShown = false;
     DoCommonMenuCallbackCode(menu, event);
@@ -698,8 +729,6 @@ void wxMenu::Init()
         gtk_menu_shell_append(GTK_MENU_SHELL(m_menu), tearoff);
     }
 
-    m_prevRadio = NULL;
-
     // append the title as the very first entry if we have it
     if ( !m_title.empty() )
     {
@@ -747,11 +776,9 @@ wxString wxMenu::GetTitle() const
     return wxConvertMnemonicsFromGTK(wxMenuBase::GetTitle());
 }
 
-bool wxMenu::GtkAppend(wxMenuItem *mitem, int pos)
+void wxMenu::GtkAppend(wxMenuItem* mitem, int pos)
 {
     GtkWidget *menuItem;
-    GtkWidget* prevRadio = m_prevRadio;
-    m_prevRadio = NULL;
     switch (mitem->GetKind())
     {
         case wxITEM_SEPARATOR:
@@ -762,11 +789,44 @@ bool wxMenu::GtkAppend(wxMenuItem *mitem, int pos)
             break;
         case wxITEM_RADIO:
             {
+                // See if we need to create a new radio group for this item or
+                // add it to an existing one.
+                wxMenuItem* radioGroupItem = NULL;
+
+                const size_t numItems = GetMenuItemCount();
+                const size_t n = pos == -1 ? numItems - 1 : size_t(pos);
+
+                if (n != 0)
+                {
+                    wxMenuItem* const itemPrev = FindItemByPosition(n - 1);
+                    if ( itemPrev->GetKind() == wxITEM_RADIO )
+                    {
+                        // Appending an item after an existing radio item puts
+                        // it into the same radio group.
+                        radioGroupItem = itemPrev;
+                    }
+                }
+
+                if (radioGroupItem == NULL && n != numItems - 1)
+                {
+                    wxMenuItem* const itemNext = FindItemByPosition(n + 1);
+                    if ( itemNext->GetKind() == wxITEM_RADIO )
+                    {
+                        // Inserting an item before an existing radio item
+                        // also puts it into the existing radio group.
+                        radioGroupItem = itemNext;
+                    }
+                }
+
                 GSList* group = NULL;
-                if (prevRadio)
-                    group = gtk_radio_menu_item_get_group(GTK_RADIO_MENU_ITEM(prevRadio));
+                if ( radioGroupItem )
+                {
+                    group = gtk_radio_menu_item_get_group(
+                              GTK_RADIO_MENU_ITEM(radioGroupItem->GetMenuItem())
+                            );
+                }
+
                 menuItem = gtk_radio_menu_item_new_with_label(group, "");
-                m_prevRadio = menuItem;
             }
             break;
         default:
@@ -821,28 +881,26 @@ bool wxMenu::GtkAppend(wxMenuItem *mitem, int pos)
                               mitem);
         }
     }
-
-    return true;
 }
 
 wxMenuItem* wxMenu::DoAppend(wxMenuItem *mitem)
 {
-    if (!GtkAppend(mitem))
-        return NULL;
-
-    return wxMenuBase::DoAppend(mitem);
+    if (wxMenuBase::DoAppend(mitem))
+    {
+        GtkAppend(mitem);
+        return mitem;
+    }
+    return NULL;
 }
 
 wxMenuItem* wxMenu::DoInsert(size_t pos, wxMenuItem *item)
 {
-    if ( !wxMenuBase::DoInsert(pos, item) )
-        return NULL;
-
-    // TODO
-    if ( !GtkAppend(item, (int)pos) )
-        return NULL;
-
-    return item;
+    if (wxMenuBase::DoInsert(pos, item))
+    {
+        GtkAppend(item, int(pos));
+        return item;
+    }
+    return NULL;
 }
 
 wxMenuItem *wxMenu::DoRemove(wxMenuItem *item)
@@ -851,14 +909,25 @@ wxMenuItem *wxMenu::DoRemove(wxMenuItem *item)
         return NULL;
 
     GtkWidget * const mitem = item->GetMenuItem();
-    if ( m_prevRadio == mitem )
+#ifdef __WXGTK3__
+    gtk_menu_item_set_submenu(GTK_MENU_ITEM(mitem), NULL);
+#else
+    if (!gtk_check_version(2,12,0))
+    {
+        // gtk_menu_item_remove_submenu() is deprecated since 2.12, but
+        // gtk_menu_item_set_submenu() can now be used with NULL submenu now so
+        // just do use it.
+        gtk_menu_item_set_submenu(GTK_MENU_ITEM(mitem), NULL);
+    }
+    else // GTK+ < 2.12
     {
-        // deleting an item starts a new radio group (has to as we shouldn't
-        // keep a deleted pointer anyhow)
-        m_prevRadio = NULL;
+        // In 2.10 calling gtk_menu_item_set_submenu() with NULL submenu
+        // results in critical GTK+ error messages so use the old function
+        // instead.
+        gtk_menu_item_remove_submenu(GTK_MENU_ITEM(mitem));
     }
+#endif
 
-    gtk_menu_item_set_submenu(GTK_MENU_ITEM(mitem), NULL);
     gtk_widget_destroy(mitem);
     item->SetMenuItem(NULL);
 
@@ -1169,12 +1238,6 @@ const char *wxGetStockGtkID(wxWindowID id)
         case wx:                   \
             return gtk;
 
-    #if GTK_CHECK_VERSION(2,6,0)
-        #define STOCKITEM_26(wx,gtk) STOCKITEM(wx,gtk)
-    #else
-        #define STOCKITEM_26(wx,gtk)
-    #endif
-
     #if GTK_CHECK_VERSION(2,8,0)
         #define STOCKITEM_28(wx,gtk) STOCKITEM(wx,gtk)
     #else
@@ -1190,7 +1253,7 @@ const char *wxGetStockGtkID(wxWindowID id)
 
     switch (id)
     {
-        STOCKITEM_26(wxID_ABOUT,         GTK_STOCK_ABOUT)
+        STOCKITEM(wxID_ABOUT,            GTK_STOCK_ABOUT)
         STOCKITEM(wxID_ADD,              GTK_STOCK_ADD)
         STOCKITEM(wxID_APPLY,            GTK_STOCK_APPLY)
         STOCKITEM(wxID_BACKWARD,         GTK_STOCK_GO_BACK)
@@ -1205,10 +1268,10 @@ const char *wxGetStockGtkID(wxWindowID id)
         STOCKITEM(wxID_CUT,              GTK_STOCK_CUT)
         STOCKITEM(wxID_DELETE,           GTK_STOCK_DELETE)
         STOCKITEM(wxID_DOWN,             GTK_STOCK_GO_DOWN)
-        STOCKITEM_26(wxID_EDIT,          GTK_STOCK_EDIT)
+        STOCKITEM(wxID_EDIT,             GTK_STOCK_EDIT)
         STOCKITEM(wxID_EXECUTE,          GTK_STOCK_EXECUTE)
         STOCKITEM(wxID_EXIT,             GTK_STOCK_QUIT)
-        STOCKITEM_26(wxID_FILE,          GTK_STOCK_FILE)
+        STOCKITEM(wxID_FILE,             GTK_STOCK_FILE)
         STOCKITEM(wxID_FIND,             GTK_STOCK_FIND)
         STOCKITEM(wxID_FIRST,            GTK_STOCK_GOTO_FIRST)
         STOCKITEM(wxID_FLOPPY,           GTK_STOCK_FLOPPY)