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 0c63e39f11f4eaf864dfa20286ef457d66a3eed8..98f08d7d6facc8eb50855ddb951462061a41c4ca 100644 (file)
--- a/src/gtk/dialog.cpp
+++ b/src/gtk/dialog.cpp
@@ -1,212 +1,209 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        dialog.cpp
+// Name:        src/gtk/dialog.cpp

 // Purpose:
 // Author:      Robert Roebling
 // Purpose:
 // Author:      Robert Roebling

-// Created:     01/02/97
-// Id:
-// Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
-// Licence:    wxWindows licence
+// Copyright:   (c) 1998 Robert Roebling
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#ifdef __GNUG__
-#pragma implementation "dialog.h"
-#endif
+// For compilers that support precompilation, includes "wx.h".
+#include "wx/wxprec.h"

 
 #include "wx/dialog.h"
 
 #include "wx/dialog.h"

-#include "wx/frame.h"
-#include "wx/app.h"
-#include "wx/gtk/win_gtk.h"

 
 

-//-----------------------------------------------------------------------------
-// delete
-
-bool gtk_dialog_delete_callback( GtkWidget *WXUNUSED(widget), GdkEvent *WXUNUSED(event), wxDialog *win )
-{ 
-/*
-  printf( "OnDelete from " );
-  if (win->GetClassInfo() && win->GetClassInfo()->GetClassName())
-    printf( win->GetClassInfo()->GetClassName() );
-  printf( ".\n" );
-*/
-  
-  win->Close();
-
-  return TRUE;
-};
+#ifndef WX_PRECOMP
+    #include "wx/cursor.h"
+#endif // WX_PRECOMP
+
+#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)
+

 
 //-----------------------------------------------------------------------------
 // wxDialog
 //-----------------------------------------------------------------------------
 
 
 //-----------------------------------------------------------------------------
 // wxDialog
 //-----------------------------------------------------------------------------
 

-BEGIN_EVENT_TABLE(wxDialog,wxWindow)
-  EVT_BUTTON  (wxID_OK,       wxDialog::OnOk)
-  EVT_BUTTON  (wxID_CANCEL,   wxDialog::OnCancel)
-  EVT_BUTTON  (wxID_APPLY,    wxDialog::OnApply)
-  EVT_CLOSE   (wxDialog::OnCloseWindow)
-END_EVENT_TABLE()
-
-IMPLEMENT_DYNAMIC_CLASS(wxDialog,wxWindow)
-
-wxDialog::wxDialog(void)
-{
-  m_title = "";
-  m_modalShowing = TRUE;
-  wxTopLevelWindows.Insert( this );
-};
-
-wxDialog::wxDialog( wxWindow *parent, 
-      wxWindowID id, const wxString &title,
-      const wxPoint &pos, const wxSize &size, 
-      const long style, const wxString &name )
+void wxDialog::Init()

 {
 {

-  wxTopLevelWindows.Insert( this );
-  Create( parent, id, title, pos, size, style, name );
-};
+    m_modalLoop = NULL;
+    m_modalShowing = false;
+}

 
 

-bool wxDialog::Create( wxWindow *parent,
-      wxWindowID id, const wxString &title,
-      const wxPoint &pos, const wxSize &size, 
-      const long style, const wxString &name )
-{
-  m_needParent = FALSE;
-  
-  PreCreation( parent, id, pos, size, style, name );
-  
-  m_modalShowing = ((m_windowStyle & wxDIALOG_MODAL) == wxDIALOG_MODAL);
-  
-  m_widget = gtk_window_new( GTK_WINDOW_TOPLEVEL );
-  GTK_WIDGET_UNSET_FLAGS( m_widget, GTK_CAN_FOCUS );
- 
-  gtk_widget_set( m_widget, "GtkWindow::allow_shrink", TRUE, NULL);
-  
-  gtk_signal_connect( GTK_OBJECT(m_widget), "delete_event", 
-    GTK_SIGNAL_FUNC(gtk_dialog_delete_callback), (gpointer)this );
-    
-  m_wxwindow = gtk_myfixed_new();
-  gtk_widget_show( m_wxwindow );
-  GTK_WIDGET_UNSET_FLAGS( m_wxwindow, GTK_CAN_FOCUS );
-  
-  gtk_container_add( GTK_CONTAINER(m_widget), m_wxwindow );
-  
-  SetTitle( title );
-  
-  PostCreation();
-  
-  return TRUE;
-};
-
-wxDialog::~wxDialog(void)
+wxDialog::wxDialog( wxWindow *parent,
+                    wxWindowID id, const wxString &title,
+                    const wxPoint &pos, const wxSize &size,
+                    long style, const wxString &name )

 {
 {

-  wxTopLevelWindows.DeleteObject( this );
-  if (wxTopLevelWindows.Number() == 0) wxTheApp->ExitMainLoop();
-};
+    Init();

 
 

-void wxDialog::SetTitle(const wxString& title )
-{
-  m_title = title;
-  gtk_window_set_title( GTK_WINDOW(m_widget), m_title );
-};
+    (void)Create( parent, id, title, pos, size, style, name );
+}

 
 

-wxString wxDialog::GetTitle(void) const
+bool wxDialog::Create( wxWindow *parent,
+                       wxWindowID id, const wxString &title,
+                       const wxPoint &pos, const wxSize &size,
+                       long style, const wxString &name )

 {
 {

-  return (wxString&)m_title;
-};
+    SetExtraStyle(GetExtraStyle() | wxTOPLEVEL_EX_DIALOG);

 
 

-void wxDialog::OnApply( wxCommandEvent &WXUNUSED(event) )
-{
-  if (Validate()) TransferDataFromWindow();
-};
+    // all dialogs should have tab traversal enabled
+    style |= wxTAB_TRAVERSAL;

 
 

-void wxDialog::OnCancel( wxCommandEvent &WXUNUSED(event) )
-{
-  if (IsModal())
-    EndModal(wxID_CANCEL);
-  else
-  {
-    SetReturnCode(wxID_CANCEL);
-    this->Show(FALSE);
-  };
-};
-
-void wxDialog::OnOk( wxCommandEvent &WXUNUSED(event) )
+    return wxTopLevelWindow::Create(parent, id, title, pos, size, style, name);
+}
+
+bool wxDialog::Show( bool show )

 {
 {

-  if ( Validate() && TransferDataFromWindow())
-  {
-    if (IsModal()) 
-      EndModal(wxID_OK);
-    else
+    if (!show && IsModal())

     {
     {

-      SetReturnCode(wxID_OK);
-      this->Show(FALSE);
-    };
-  };
-  EndModal( wxID_OK );
-};
-
-void wxDialog::OnPaint( wxPaintEvent& WXUNUSED(event) )
-{
-  // yes
-};
+        EndModal( wxID_CANCEL );
+    }

 
 

-bool wxDialog::OnClose(void)
-{
-  static wxList closing;
+    if (show && CanDoLayoutAdaptation())
+        DoLayoutAdaptation();

 
 

-  if (closing.Member(this)) return FALSE;   // no loops
+    bool ret = wxDialogBase::Show(show);

 
 

-  closing.Append(this);
+    if (show)
+        InitDialog();

 
 

-  wxCommandEvent cancelEvent(wxEVT_COMMAND_BUTTON_CLICKED, wxID_CANCEL);
-  cancelEvent.SetEventObject( this );
-  GetEventHandler()->ProcessEvent(cancelEvent);
-  closing.DeleteObject(this);
-  
-  return FALSE;
+    return ret;

 }
 
 }
 

-void wxDialog::OnCloseWindow(wxCloseEvent& event)
+wxDialog::~wxDialog()

 {
 {

-  if (GetEventHandler()->OnClose() || event.GetForce())
-  {
-    this->Destroy();
-  };
-};
+    // if the dialog is modal, this will end its event loop
+    if ( IsModal() )
+        EndModal(wxID_CANCEL);
+}

 
 

-bool wxDialog::Show( const bool show )
+bool wxDialog::IsModal() const

 {
 {

-  if (!show && m_modalShowing)
-  {
-    EndModal( wxID_CANCEL );
-  };
-
-  wxWindow::Show( show );
-  
-  if (show) InitDialog();
-  
-  if (show && m_modalShowing)
-  {
-    gtk_grab_add( m_widget );
-    gtk_main();
-    gtk_grab_remove( m_widget );
-  };
-  
-  return TRUE;
-};
-
-int wxDialog::ShowModal(void)
+    return m_modalShowing;
+}
+
+// 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()

 {
 {

-  Show( TRUE );
-  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
+    // capture making it impossible to do anything in the modal dialog itself
+    wxWindow * const win = wxWindow::GetCapture();
+    if ( win )
+        win->GTKReleaseMouseAndNotify();
+
+    wxWindow * const parent = GetParentForModalDialog();
+    if ( parent )
+    {
+        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;
+
+    wxOpenModalDialogLocker modalLock;
+
+    // NOTE: gtk_window_set_modal internally calls gtk_grab_add() !
+    gtk_window_set_modal(GTK_WINDOW(m_widget), TRUE);
+
+    // Run modal dialog event loop.
+    {
+        wxGUIEventLoopTiedPtr modal(&m_modalLoop, new wxGUIEventLoop());
+        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);
+
+    return GetReturnCode();
+}

 
 void wxDialog::EndModal( int retCode )
 {
 
 void wxDialog::EndModal( int retCode )
 {

-  gtk_main_quit();
-  SetReturnCode( retCode );
-};
+    SetReturnCode( retCode );

 
 

-void wxDialog::InitDialog(void)
-{
-  wxWindow::InitDialog();
-};
+    if (!IsModal())
+    {
+        wxFAIL_MSG( "either wxDialog:EndModal called twice or ShowModal wasn't called" );
+        return;
+    }

 
 

+    m_modalShowing = false;
+
+    // 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 );
+}