Fix stc doxygen warnings and regen stc files.

[wxWidgets.git] / src / gtk / dialog.cpp

diff --git a/src/gtk/dialog.cpp b/src/gtk/dialog.cpp
index c70813d55755b7da1ccdee9223032d091a3111a8..98f08d7d6facc8eb50855ddb951462061a41c4ca 100644 (file)
--- a/src/gtk/dialog.cpp
+++ b/src/gtk/dialog.cpp
@@ -2,7 +2,6 @@
 // Name:        src/gtk/dialog.cpp
 // Purpose:
 // Author:      Robert Roebling
-// Id:          $Id$
 // Copyright:   (c) 1998 Robert Roebling
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
@@ -18,22 +17,24 @@
 
 #include "wx/evtloop.h"
 
+#include "wx/scopedptr.h"
+#include "wx/modalhook.h"
+
 #include <gtk/gtk.h>
+#include "wx/gtk/private/gtk2-compat.h"
+#include "wx/gtk/private/dialogcount.h"
+
+wxDEFINE_TIED_SCOPED_PTR_TYPE(wxGUIEventLoop)
 
-// this is defined in src/gtk/toplevel.cpp
-extern int wxOpenModalDialogsCount;
 
 //-----------------------------------------------------------------------------
 // wxDialog
 //-----------------------------------------------------------------------------
 
-IMPLEMENT_DYNAMIC_CLASS(wxDialog,wxTopLevelWindow)
-
 void wxDialog::Init()
 {
-    m_returnCode = 0;
+    m_modalLoop = NULL;
     m_modalShowing = false;
-    m_themeEnabled = true;
 }
 
 wxDialog::wxDialog( wxWindow *parent,
@@ -79,8 +80,6 @@ bool wxDialog::Show( bool show )
 
 wxDialog::~wxDialog()
 {
-    m_isBeingDeleted = true;
-
     // if the dialog is modal, this will end its event loop
     if ( IsModal() )
         EndModal(wxID_CANCEL);
@@ -91,18 +90,49 @@ bool wxDialog::IsModal() const
     return m_modalShowing;
 }
 
-void wxDialog::SetModal( bool WXUNUSED(flag) )
+// 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*)
 {
-    wxFAIL_MSG( wxT("wxDialog:SetModal obsolete now") );
+    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()
 {
-    if (IsModal())
-    {
-       wxFAIL_MSG( wxT("wxDialog:ShowModal called twice") );
-       return GetReturnCode();
-    }
+    WX_HOOK_MODAL_DIALOG();
+
+    wxASSERT_MSG( !IsModal(), "ShowModal() can't be called twice" );
 
     // release the mouse if it's currently captured as the window having it
     // will be disabled when this dialog is shown -- but will still keep the
@@ -111,34 +141,49 @@ int wxDialog::ShowModal()
     if ( win )
         win->GTKReleaseMouseAndNotify();
 
-    // use the apps top level window as parent if none given unless explicitly
-    // forbidden
-    if ( !GetParent() && !(GetWindowStyleFlag() & wxDIALOG_NO_PARENT) )
+    wxWindow * const parent = GetParentForModalDialog();
+    if ( parent )
     {
-        wxWindow * const parent = GetParentForModalDialog();
-        if ( parent && parent != this )
-        {
-            gtk_window_set_transient_for( GTK_WINDOW(m_widget),
-                                          GTK_WINDOW(parent->m_widget) );
-        }
+        gtk_window_set_transient_for( GTK_WINDOW(m_widget),
+                                      GTK_WINDOW(parent->m_widget) );
     }
 
     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;
 
-    wxOpenModalDialogsCount++;
+    wxOpenModalDialogLocker modalLock;
 
     // NOTE: gtk_window_set_modal internally calls gtk_grab_add() !
     gtk_window_set_modal(GTK_WINDOW(m_widget), TRUE);
 
-    wxGUIEventLoop().Run();
+    // Run modal dialog event loop.
+    {
+        wxGUIEventLoopTiedPtr modal(&m_modalLoop, new wxGUIEventLoop());
+        m_modalLoop->Run();
+    }
 
-    gtk_window_set_modal(GTK_WINDOW(m_widget), FALSE);
+#if GTK_CHECK_VERSION(2,10,0)
+    if (sigId)
+        g_signal_remove_emission_hook(sigId, hookId);
+#endif
 
-    wxOpenModalDialogsCount--;
+    gtk_window_set_modal(GTK_WINDOW(m_widget), FALSE);
 
     return GetReturnCode();
 }
@@ -155,7 +200,10 @@ void wxDialog::EndModal( int retCode )
 
     m_modalShowing = false;
 
-    gtk_main_quit();
+    // Ensure Exit() is only called once. The dialog's event loop may be terminated
+    // externally due to an uncaught exception.
+    if (m_modalLoop && m_modalLoop->IsRunning())
+        m_modalLoop->Exit();
 
     Show( false );
 }