Fix for toolbars and menus not being disabled on Ubuntu

Ubuntu overlay scrollbar changes the GtkWindowGroup for its toplevel, which is
disastrous for modal windows. Put in a hack to detect and undo this.
Fixes #14855


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@73196 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

include/wx/gtk/private/gtk2-compat.h

@@ -381,6 +381,12 @@ static inline gint wx_gdk_visual_get_depth(GdkVisual* visual)
 }
 #define gdk_visual_get_depth wx_gdk_visual_get_depth
 
+static inline gboolean wx_gtk_window_has_group(GtkWindow* window)
+{
+    return window->group != NULL;
+}
+#define gtk_window_has_group wx_gtk_window_has_group
+
 // ----------------------------------------------------------------------------
 // the following were introduced in GTK+ 2.24
 

src/gtk/dialog.cpp

@@ -22,6 +22,7 @@
 #include "wx/testing.h"
 
 #include <gtk/gtk.h>
+#include "wx/gtk/private/gtk2-compat.h"
 
 // this is defined in src/gtk/toplevel.cpp
 extern int wxOpenModalDialogsCount;
@@ -99,6 +100,44 @@ void wxDialog::SetModal( bool WXUNUSED(flag) )
     wxFAIL_MSG( wxT("wxDialog:SetModal obsolete now") );
 }
 
+// Workaround for Ubuntu overlay scrollbar, which adds our GtkWindow to a
+// private window group in a GtkScrollbar realize handler. This breaks the grab
+// done by gtk_window_set_modal(), and allows menus and toolbars in the parent
+// frame to remain active. So, we install an emission hook on the "realize"
+// signal while showing a modal dialog. For any realize on a GtkScrollbar,
+// we check the top level parent to see if it has an explicitly set window
+// group that is not the same as its transient parent. If we find this, we
+// put the top level back in the same window group as its transient parent, and
+// re-add the grab.
+// Ubuntu 12.04 and 12.10 are known to have this problem.
+
+// need 2.10 for gtk_window_get_group()
+#if GTK_CHECK_VERSION(2,10,0)
+extern "C" {
+static gboolean
+realize_hook(GSignalInvocationHint*, unsigned, const GValue* param_values, void*)
+{
+    void* p = g_value_peek_pointer(param_values);
+    if (GTK_IS_SCROLLBAR(p))
+    {
+        GtkWindow* toplevel = GTK_WINDOW(gtk_widget_get_toplevel(GTK_WIDGET(p)));
+        GtkWindow* transient_parent = gtk_window_get_transient_for(toplevel);
+        if (transient_parent && gtk_window_has_group(toplevel))
+        {
+            GtkWindowGroup* group = gtk_window_get_group(toplevel);
+            GtkWindowGroup* group_parent = gtk_window_get_group(transient_parent);
+            if (group != group_parent)
+            {
+                gtk_window_group_add_window(group_parent, toplevel);
+                gtk_grab_add(GTK_WIDGET(toplevel));
+            }
+        }
+    }
+    return true;
+}
+}
+#endif // GTK 2.10
+
 int wxDialog::ShowModal()
 {
     WX_TESTING_SHOW_MODAL_HOOK();
@@ -121,6 +160,19 @@ int wxDialog::ShowModal()
 
     wxBusyCursorSuspender cs; // temporarily suppress the busy cursor
 
+#if GTK_CHECK_VERSION(2,10,0)
+    unsigned sigId = 0;
+    gulong hookId = 0;
+#ifndef __WXGTK3__
+    // Ubuntu overlay scrollbar uses at least GTK 2.24
+    if (gtk_check_version(2,24,0) == NULL)
+#endif
+    {
+        sigId = g_signal_lookup("realize", GTK_TYPE_WIDGET);
+        hookId = g_signal_add_emission_hook(sigId, 0, realize_hook, NULL, NULL);
+    }
+#endif
+
     Show( true );
 
     m_modalShowing = true;
@@ -136,6 +188,11 @@ int wxDialog::ShowModal()
         m_modalLoop->Run();
     }
 
+#if GTK_CHECK_VERSION(2,10,0)
+    if (sigId)
+        g_signal_remove_emission_hook(sigId, hookId);
+#endif
+
     gtk_window_set_modal(GTK_WINDOW(m_widget), FALSE);
 
     wxOpenModalDialogsCount--;