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

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

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

-// Id:          $Id$

 // Copyright:   (c) 1998 Robert Roebling
 // Copyright:   (c) 1998 Robert Roebling

-// Licence:    wxWindows licence
+// 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"

 
 

-//-----------------------------------------------------------------------------
+#ifndef WX_PRECOMP
+    #include "wx/cursor.h"
+#endif // WX_PRECOMP

 
 

-extern wxList wxPendingDelete;
+#include "wx/evtloop.h"

 
 

-//-----------------------------------------------------------------------------
-// "delete_event"
-//-----------------------------------------------------------------------------
+#include "wx/scopedptr.h"
+#include "wx/modalhook.h"

 
 

-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;
-}
+#include <gtk/gtk.h>
+#include "wx/gtk/private/gtk2-compat.h"
+#include "wx/gtk/private/dialogcount.h"

 
 

-//-----------------------------------------------------------------------------
-// "size_allocate"
-//-----------------------------------------------------------------------------
+wxDEFINE_TIED_SCOPED_PTR_TYPE(wxGUIEventLoop)

 
 

-static void gtk_dialog_size_callback( GtkWidget *WXUNUSED(widget), GtkAllocation* alloc, wxDialog *win )
-{
-    if (!win->HasVMT()) return;
-
-/*
-    printf( "OnDialogResize from " );
-    if (win->GetClassInfo() && win->GetClassInfo()->GetClassName())
-        printf( win->GetClassInfo()->GetClassName() );
-    printf( ".\n" );
-*/
-
-    win->GtkOnSize( alloc->x, alloc->y, alloc->width, alloc->height );
-}

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

-BEGIN_EVENT_TABLE(wxDialog,wxPanel)
-    EVT_BUTTON  (wxID_OK,       wxDialog::OnOK)
-    EVT_BUTTON  (wxID_CANCEL,   wxDialog::OnCancel)
-    EVT_BUTTON  (wxID_APPLY,    wxDialog::OnApply)
-    EVT_SIZE    (wxDialog::OnSize)
-    EVT_CLOSE   (wxDialog::OnCloseWindow)
-END_EVENT_TABLE()
-
-IMPLEMENT_DYNAMIC_CLASS(wxDialog,wxPanel)
-
-wxDialog::wxDialog()
+void wxDialog::Init()

 {
 {

-    m_title = "";
-    m_modalShowing = FALSE;
-    wxTopLevelWindows.Insert( this );
+    m_modalLoop = NULL;
+    m_modalShowing = false;

 }
 
 }
 

-wxDialog::wxDialog( wxWindow *parent, 
+wxDialog::wxDialog( wxWindow *parent,

                     wxWindowID id, const wxString &title,
                     wxWindowID id, const wxString &title,

-                    const wxPoint &pos, const wxSize &size, 
+                    const wxPoint &pos, const wxSize &size,

                     long style, const wxString &name )
 {
                     long style, const wxString &name )
 {

-    m_modalShowing = FALSE;
-    wxTopLevelWindows.Insert( this );
-    Create( parent, id, title, pos, size, style, name );
+    Init();
+
+    (void)Create( parent, id, title, pos, size, style, name );

 }
 
 bool wxDialog::Create( wxWindow *parent,
                        wxWindowID id, const wxString &title,
 }
 
 bool wxDialog::Create( wxWindow *parent,
                        wxWindowID id, const wxString &title,

-                       const wxPoint &pos, const wxSize &size, 
+                       const wxPoint &pos, const wxSize &size,

                        long style, const wxString &name )
 {
                        long style, const wxString &name )
 {

-    m_needParent = FALSE;
-  
-    PreCreation( parent, id, pos, size, style, name );
-  
-    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 );
-    
-    gtk_signal_connect( GTK_OBJECT(m_widget), "size_allocate", 
-        GTK_SIGNAL_FUNC(gtk_dialog_size_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 );
-  
-    if ((m_x != -1) || (m_y != -1))
-        gtk_widget_set_uposition( m_widget, m_x, m_y );
-     
-    gtk_widget_set_usize( m_widget, m_width, m_height );
-     
-    if (m_parent) m_parent->AddChild( this );
-  
-  
-    PostCreation();
-  
-    return TRUE;
-}
-
-wxDialog::~wxDialog()
-{
-    wxTopLevelWindows.DeleteObject( this );
-    if (wxTopLevelWindows.Number() == 0) wxTheApp->ExitMainLoop();
-}
-
-void wxDialog::SetTitle( const wxString& title )
-{
-    m_title = title;
-    if (m_title.IsNull()) m_title = "";
-    gtk_window_set_title( GTK_WINDOW(m_widget), m_title );
-}
+    SetExtraStyle(GetExtraStyle() | wxTOPLEVEL_EX_DIALOG);

 
 

-wxString wxDialog::GetTitle() const
-{
-    return (wxString&)m_title;
-}
+    // all dialogs should have tab traversal enabled
+    style |= wxTAB_TRAVERSAL;

 
 

-void wxDialog::OnApply( wxCommandEvent &WXUNUSED(event) )
-{
-    if (Validate()) TransferDataFromWindow();
+    return wxTopLevelWindow::Create(parent, id, title, pos, size, style, name);

 }
 
 }
 

-void wxDialog::OnCancel( wxCommandEvent &WXUNUSED(event) )
-{
-    if (IsModal())
-    {
-        EndModal(wxID_CANCEL);
-    }
-    else
-    {
-        SetReturnCode(wxID_CANCEL);
-        this->Show(FALSE);
-    }
-}
-
-void wxDialog::OnOK( wxCommandEvent &WXUNUSED(event) )
+bool wxDialog::Show( bool show )

 {
 {

-    if ( Validate() && TransferDataFromWindow())
+    if (!show && IsModal())

     {
     {

-        if (IsModal()) 
-        {
-            EndModal(wxID_OK);
-        }
-        else
-        {
-            SetReturnCode(wxID_OK);
-            this->Show(FALSE);
-        }
+        EndModal( wxID_CANCEL );

     }
     }

-}

 
 

-void wxDialog::OnPaint( wxPaintEvent& WXUNUSED(event) )
-{
-  // yes
-}
+    if (show && CanDoLayoutAdaptation())
+        DoLayoutAdaptation();

 
 

-bool wxDialog::OnClose()
-{
-    static wxList closing;
-
-    if (closing.Member(this)) return FALSE;   // no loops
-  
-    closing.Append(this);
-
-    wxCommandEvent cancelEvent(wxEVT_COMMAND_BUTTON_CLICKED, wxID_CANCEL);
-    cancelEvent.SetEventObject( this );
-    GetEventHandler()->ProcessEvent(cancelEvent);
-    closing.DeleteObject(this);
-  
-    return FALSE;
-}
+    bool ret = wxDialogBase::Show(show);

 
 

-bool wxDialog::Destroy()
-{
-    if (!wxPendingDelete.Member(this)) wxPendingDelete.Append(this);
+    if (show)
+        InitDialog();

 
 

-    return TRUE;
+    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);

 }
 
 }
 

-void wxDialog::GtkOnSize( int WXUNUSED(x), int WXUNUSED(y), int width, int height )
+bool wxDialog::IsModal() const

 {
 {

-    // due to a bug in gtk, x,y are always 0
-    // m_x = x;
-    // m_y = y;
-
-    if ((m_height == height) && (m_width == width) &&
-        (m_sizeSet)) return;
-    if (!m_wxwindow) return;
-  
-    m_width = width;
-    m_height = height;
-  
-    if ((m_minWidth != -1) && (m_width < m_minWidth)) m_width = m_minWidth;
-    if ((m_minHeight != -1) && (m_height < m_minHeight)) m_height = m_minHeight;
-    if ((m_maxWidth != -1) && (m_width > m_maxWidth)) m_width = m_minWidth;
-    if ((m_maxHeight != -1) && (m_height > m_maxHeight)) m_height = m_minHeight;
-
-    gtk_widget_set_usize( m_widget, m_width, m_height );
-
-    m_sizeSet = TRUE;
-    
-    wxSizeEvent event( wxSize(m_width,m_height), GetId() );
-    event.SetEventObject( this );
-    GetEventHandler()->ProcessEvent( event );
+    return m_modalShowing;

 }
 
 }
 

-void wxDialog::OnSize( wxSizeEvent &WXUNUSED(event) )
-{
-    wxASSERT_MSG( (m_widget != NULL), "invalid frame" );
-  
-    if (GetAutoLayout())
+// 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))

     {
     {

-        Layout();
-    }
-    else 
-    {
-        // no child: go out !
-        if (!GetChildren()->First()) return;
-      
-        // do we have exactly one child?
-        wxWindow *child = (wxWindow *) NULL;
-        for(wxNode *node = GetChildren()->First(); node; node = node->Next())
+        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))

         {
         {

-            wxWindow *win = (wxWindow *)node->Data();
-            if (!IS_KIND_OF(win,wxFrame) && !IS_KIND_OF(win,wxDialog))
+            GtkWindowGroup* group = gtk_window_get_group(toplevel);
+            GtkWindowGroup* group_parent = gtk_window_get_group(transient_parent);
+            if (group != group_parent)

             {
             {

-               // it's the second one: do nothing
-                if (child) return;
-                child = win;
+                gtk_window_group_add_window(group_parent, toplevel);
+                gtk_grab_add(GTK_WIDGET(toplevel));

             }
         }
             }
         }

-
-        // yes: set it's size to fill all the frame
-        int client_x, client_y;
-        GetClientSize( &client_x, &client_y );
-        child->SetSize( 1, 1, client_x-2, client_y);

     }
     }

+    return true;

 }
 }

+}
+#endif // GTK 2.10

 
 

-void wxDialog::SetSize( int x, int y, int width, int height, int sizeFlags )
+int wxDialog::ShowModal()

 {
 {

-    wxASSERT_MSG( (m_widget != NULL), "invalid window" );
-  
-    // Don't do anything for children of wxMDIChildFrame
-    if (!m_wxwindow) return;
-
-    if (m_resizing) return; // I don't like recursions
-    m_resizing = TRUE;
-
-    int old_x = m_x;
-    int old_y = m_y;
-    int old_width = m_width;
-    int old_height = m_height;
-  
-    if ((sizeFlags & wxSIZE_USE_EXISTING) == wxSIZE_USE_EXISTING)
-    {
-        if (x != -1) m_x = x;
-        if (y != -1) m_y = y;
-        if (width != -1) m_width = width;
-        if (height != -1) m_height = height;
-    }
-    else
-    {
-        m_x = x;
-        m_y = y;
-        m_width = width;
-        m_height = height;
-    }
+    WX_HOOK_MODAL_DIALOG();

 
 

-    if ((sizeFlags & wxSIZE_AUTO_WIDTH) == wxSIZE_AUTO_WIDTH)
-    {
-        if (width == -1) m_width = 80;
-    }
+    wxASSERT_MSG( !IsModal(), "ShowModal() can't be called twice" );

 
 

-    if ((sizeFlags & wxSIZE_AUTO_HEIGHT) == wxSIZE_AUTO_HEIGHT)
-    {
-       if (height == -1) m_height = 26;
-    }
-  
-    if ((m_minWidth != -1) && (m_width < m_minWidth)) m_width = m_minWidth;
-    if ((m_minHeight != -1) && (m_height < m_minHeight)) m_height = m_minHeight;
-    if ((m_maxWidth != -1) && (m_width > m_maxWidth)) m_width = m_minWidth;
-    if ((m_maxHeight != -1) && (m_height > m_maxHeight)) m_height = m_minHeight;
+    // 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();

 
 

-    if ((m_x != -1) || (m_y != -1))
+    wxWindow * const parent = GetParentForModalDialog();
+    if ( parent )

     {
     {

-        if ((m_x != old_x) || (m_y != old_y)) 
-            gtk_widget_set_uposition( m_widget, m_x, m_y );
+        gtk_window_set_transient_for( GTK_WINDOW(m_widget),
+                                      GTK_WINDOW(parent->m_widget) );

     }
     }

-  
-    if ((m_width != old_width) || (m_height != old_height))
+
+    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

     {
     {

-        gtk_widget_set_usize( m_widget, m_width, m_height );
+        sigId = g_signal_lookup("realize", GTK_TYPE_WIDGET);
+        hookId = g_signal_add_emission_hook(sigId, 0, realize_hook, NULL, NULL);

     }
     }

-  
-    m_sizeSet = TRUE;
+#endif

 
 

-    wxSizeEvent event( wxSize(m_width,m_height), GetId() );
-    event.SetEventObject( this );
-    GetEventHandler()->ProcessEvent( event );
+    Show( true );

 
 

-    m_resizing = FALSE;
-}
+    m_modalShowing = true;

 
 

-void wxDialog::SetSize( int width, int height )
-{
-    SetSize( -1, -1, width, height, wxSIZE_USE_EXISTING );
-}
+    wxOpenModalDialogLocker modalLock;

 
 

-void wxDialog::Centre( int direction )
-{
-    wxASSERT_MSG( (m_widget != NULL), "invalid frame" );
-  
-    int x = 0;
-    int y = 0;
-    
-    if (direction & wxHORIZONTAL == wxHORIZONTAL) x = (gdk_screen_width () - m_width) / 2;
-    if (direction & wxVERTICAL == wxVERTICAL) y = (gdk_screen_height () - m_height) / 2;
-  
-    Move( x, y );
-}
+    // NOTE: gtk_window_set_modal internally calls gtk_grab_add() !
+    gtk_window_set_modal(GTK_WINDOW(m_widget), TRUE);

 
 

-bool wxDialog::Show( bool show )
-{
-    if (!show && IsModal())
+    // Run modal dialog event loop.

     {
     {

-      EndModal( wxID_CANCEL );
+        wxGUIEventLoopTiedPtr modal(&m_modalLoop, new wxGUIEventLoop());
+        m_modalLoop->Run();

     }
 
     }
 

-    wxWindow::Show( show );
-  
-    if (show) InitDialog();
-  
-    return TRUE;
-}
-
-bool wxDialog::IsModal() const
-{
-    return m_modalShowing;
-}
-
-void wxDialog::SetModal( bool WXUNUSED(flag) )
-{
-/*
-  if (flag)
-    m_windowStyle |= wxDIALOG_MODAL;
-  else
-    if (m_windowStyle & wxDIALOG_MODAL) m_windowStyle -= wxDIALOG_MODAL;
-*/
-    wxFAIL_MSG( "wxDialog:SetModal obsolete now" );
-}
+#if GTK_CHECK_VERSION(2,10,0)
+    if (sigId)
+        g_signal_remove_emission_hook(sigId, hookId);
+#endif

 
 

-int wxDialog::ShowModal()
-{
-    if (IsModal())
-    {
-       wxFAIL_MSG( "wxDialog:ShowModal called twice" );
-       return GetReturnCode();
-    }
+    gtk_window_set_modal(GTK_WINDOW(m_widget), FALSE);

 
 

-    Show( TRUE );
-  
-    m_modalShowing = TRUE;
-  
-    gtk_grab_add( m_widget );
-    gtk_main();
-    gtk_grab_remove( m_widget );
-  

     return GetReturnCode();
 }
 
 void wxDialog::EndModal( int retCode )
 {
     SetReturnCode( retCode );
     return GetReturnCode();
 }
 
 void wxDialog::EndModal( int retCode )
 {
     SetReturnCode( retCode );

-  
+

     if (!IsModal())
     {
     if (!IsModal())
     {

-        wxFAIL_MSG( "wxDialog:EndModal called twice" );
+        wxFAIL_MSG( "either wxDialog:EndModal called twice or ShowModal wasn't called" );

         return;
     }
         return;
     }

-  
-    m_modalShowing = FALSE;
-  
-    gtk_main_quit();
-  
-    Show( FALSE );
-}

 
 

-void wxDialog::InitDialog()
-{
-    wxWindow::InitDialog();
-}
+    m_modalShowing = false;

 
 

-void wxDialog::SetIcon( const wxIcon &icon )
-{
-    m_icon = icon;
-    if (!icon.Ok()) return;
-  
-    wxMask *mask = icon.GetMask();
-    GdkBitmap *bm = (GdkBitmap *) NULL;
-    if (mask) bm = mask->GetBitmap();
-  
-    gdk_window_set_icon( m_widget->window, (GdkWindow *) NULL, icon.GetPixmap(), bm );
+    // 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 );

 }
 }