src/gtk/dialog.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/gtk/dialog.cpp
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 // For compilers that support precompilation, includes "wx.h".
  11 #include "wx/wxprec.h"
  12
  13 #include "wx/dialog.h"
  14
  15 #ifndef WX_PRECOMP
  16     #include "wx/cursor.h"
  17 #endif // WX_PRECOMP
  18
  19 #include "wx/evtloop.h"
  20
  21 #include "wx/scopedptr.h"
  22 #include "wx/testing.h"
  23
  24 #include <gtk/gtk.h>
  25 #include "wx/gtk/private/gtk2-compat.h"
  26
  27 // this is defined in src/gtk/toplevel.cpp
  28 extern int wxOpenModalDialogsCount;
  29
  30 wxDEFINE_TIED_SCOPED_PTR_TYPE(wxGUIEventLoop)
  31
  32
  33 //-----------------------------------------------------------------------------
  34 // wxDialog
  35 //-----------------------------------------------------------------------------
  36
  37 void wxDialog::Init()
  38 {
  39     m_modalLoop = NULL;
  40     m_returnCode = 0;
  41     m_modalShowing = false;
  42     m_themeEnabled = true;
  43 }
  44
  45 wxDialog::wxDialog( wxWindow *parent,
  46                     wxWindowID id, const wxString &title,
  47                     const wxPoint &pos, const wxSize &size,
  48                     long style, const wxString &name )
  49 {
  50     Init();
  51
  52     (void)Create( parent, id, title, pos, size, style, name );
  53 }
  54
  55 bool wxDialog::Create( wxWindow *parent,
  56                        wxWindowID id, const wxString &title,
  57                        const wxPoint &pos, const wxSize &size,
  58                        long style, const wxString &name )
  59 {
  60     SetExtraStyle(GetExtraStyle() | wxTOPLEVEL_EX_DIALOG);
  61
  62     // all dialogs should have tab traversal enabled
  63     style |= wxTAB_TRAVERSAL;
  64
  65     return wxTopLevelWindow::Create(parent, id, title, pos, size, style, name);
  66 }
  67
  68 bool wxDialog::Show( bool show )
  69 {
  70     if (!show && IsModal())
  71     {
  72         EndModal( wxID_CANCEL );
  73     }
  74
  75     if (show && CanDoLayoutAdaptation())
  76         DoLayoutAdaptation();
  77
  78     bool ret = wxDialogBase::Show(show);
  79
  80     if (show)
  81         InitDialog();
  82
  83     return ret;
  84 }
  85
  86 wxDialog::~wxDialog()
  87 {
  88     // if the dialog is modal, this will end its event loop
  89     if ( IsModal() )
  90         EndModal(wxID_CANCEL);
  91 }
  92
  93 bool wxDialog::IsModal() const
  94 {
  95     return m_modalShowing;
  96 }
  97
  98 void wxDialog::SetModal( bool WXUNUSED(flag) )
  99 {
 100     wxFAIL_MSG( wxT("wxDialog:SetModal obsolete now") );
 101 }
 102
 103 // Workaround for Ubuntu overlay scrollbar, which adds our GtkWindow to a
 104 // private window group in a GtkScrollbar realize handler. This breaks the grab
 105 // done by gtk_window_set_modal(), and allows menus and toolbars in the parent
 106 // frame to remain active. So, we install an emission hook on the "realize"
 107 // signal while showing a modal dialog. For any realize on a GtkScrollbar,
 108 // we check the top level parent to see if it has an explicitly set window
 109 // group that is not the same as its transient parent. If we find this, we
 110 // put the top level back in the same window group as its transient parent, and
 111 // re-add the grab.
 112 // Ubuntu 12.04 and 12.10 are known to have this problem.
 113
 114 // need 2.10 for gtk_window_get_group()
 115 #if GTK_CHECK_VERSION(2,10,0)
 116 extern "C" {
 117 static gboolean
 118 realize_hook(GSignalInvocationHint*, unsigned, const GValue* param_values, void*)
 119 {
 120     void* p = g_value_peek_pointer(param_values);
 121     if (GTK_IS_SCROLLBAR(p))
 122     {
 123         GtkWindow* toplevel = GTK_WINDOW(gtk_widget_get_toplevel(GTK_WIDGET(p)));
 124         GtkWindow* transient_parent = gtk_window_get_transient_for(toplevel);
 125         if (transient_parent && gtk_window_has_group(toplevel))
 126         {
 127             GtkWindowGroup* group = gtk_window_get_group(toplevel);
 128             GtkWindowGroup* group_parent = gtk_window_get_group(transient_parent);
 129             if (group != group_parent)
 130             {
 131                 gtk_window_group_add_window(group_parent, toplevel);
 132                 gtk_grab_add(GTK_WIDGET(toplevel));
 133             }
 134         }
 135     }
 136     return true;
 137 }
 138 }
 139 #endif // GTK 2.10
 140
 141 int wxDialog::ShowModal()
 142 {
 143     WX_TESTING_SHOW_MODAL_HOOK();
 144
 145     wxASSERT_MSG( !IsModal(), "ShowModal() can't be called twice" );
 146
 147     // release the mouse if it's currently captured as the window having it
 148     // will be disabled when this dialog is shown -- but will still keep the
 149     // capture making it impossible to do anything in the modal dialog itself
 150     wxWindow * const win = wxWindow::GetCapture();
 151     if ( win )
 152         win->GTKReleaseMouseAndNotify();
 153
 154     wxWindow * const parent = GetParentForModalDialog();
 155     if ( parent )
 156     {
 157         gtk_window_set_transient_for( GTK_WINDOW(m_widget),
 158                                       GTK_WINDOW(parent->m_widget) );
 159     }
 160
 161     wxBusyCursorSuspender cs; // temporarily suppress the busy cursor
 162
 163 #if GTK_CHECK_VERSION(2,10,0)
 164     unsigned sigId = 0;
 165     gulong hookId = 0;
 166 #ifndef __WXGTK3__
 167     // Ubuntu overlay scrollbar uses at least GTK 2.24
 168     if (gtk_check_version(2,24,0) == NULL)
 169 #endif
 170     {
 171         sigId = g_signal_lookup("realize", GTK_TYPE_WIDGET);
 172         hookId = g_signal_add_emission_hook(sigId, 0, realize_hook, NULL, NULL);
 173     }
 174 #endif
 175
 176     Show( true );
 177
 178     m_modalShowing = true;
 179
 180     wxOpenModalDialogsCount++;
 181
 182     // NOTE: gtk_window_set_modal internally calls gtk_grab_add() !
 183     gtk_window_set_modal(GTK_WINDOW(m_widget), TRUE);
 184
 185     // Run modal dialog event loop.
 186     {
 187         wxGUIEventLoopTiedPtr modal(&m_modalLoop, new wxGUIEventLoop());
 188         m_modalLoop->Run();
 189     }
 190
 191 #if GTK_CHECK_VERSION(2,10,0)
 192     if (sigId)
 193         g_signal_remove_emission_hook(sigId, hookId);
 194 #endif
 195
 196     gtk_window_set_modal(GTK_WINDOW(m_widget), FALSE);
 197
 198     wxOpenModalDialogsCount--;
 199
 200     return GetReturnCode();
 201 }
 202
 203 void wxDialog::EndModal( int retCode )
 204 {
 205     SetReturnCode( retCode );
 206
 207     if (!IsModal())
 208     {
 209         wxFAIL_MSG( "either wxDialog:EndModal called twice or ShowModal wasn't called" );
 210         return;
 211     }
 212
 213     m_modalShowing = false;
 214
 215     // Ensure Exit() is only called once. The dialog's event loop may be terminated
 216     // externally due to an uncaught exception.
 217     if (m_modalLoop && m_modalLoop->IsRunning())
 218         m_modalLoop->Exit();
 219
 220     Show( false );
 221 }