src/gtk/dialog.cpp

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