Fixed handling of modal dialogs.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@30091 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

include/wx/os2/dialog.h

@@ -27,52 +27,17 @@ public:
 
   inline wxDialog() { Init(); }
 
-  //
+    // full ctor
-  // Constructor with a modal flag, but no window id - the old convention
+    wxDialog(wxWindow *parent, wxWindowID id,
-  //
+             const wxString& title,
-  inline wxDialog( wxWindow*       pParent
+             const wxPoint& pos = wxDefaultPosition,
-                  ,const wxString& rsTitle
+             const wxSize& size = wxDefaultSize,
-                  ,bool            bModal
+             long style = wxDEFAULT_DIALOG_STYLE,
-                  ,int             nX = -1
+             const wxString& name = wxDialogNameStr)
-                  ,int             nY = -1
-                  ,int             nWidth = 500
-                  ,int             nHeight = 500
-                  ,long            lStyle = wxDEFAULT_DIALOG_STYLE
-                  ,const wxString& rsName = wxDialogNameStr
-                 )
     {
-        long                        lModalStyle = lStyle ? wxDIALOG_MODAL : wxDIALOG_MODELESS ;
+        Init();
 
-        Create( pParent
+        (void)Create(parent, id, title, pos, size, style, name);
-               ,-1
-               ,rsTitle
-               ,wxPoint(nX, nY)
-               ,wxSize(nWidth, nHeight)
-               ,lStyle | lModalStyle
-               ,rsName
-              );
-    }
-
-    //
-    // Constructor with no modal flag - the new convention.
-    //
-    inline wxDialog( wxWindow*       pParent
-                    ,wxWindowID      vId
-                    ,const wxString& rsTitle
-                    ,const wxPoint&  rPos = wxDefaultPosition
-                    ,const wxSize&   rSize = wxDefaultSize
-                    ,long            lStyle = wxDEFAULT_DIALOG_STYLE
-                    ,const wxString& rsName = wxDialogNameStr
-                   )
-    {
-        Create( pParent
-               ,vId
-               ,rsTitle
-               ,rPos
-               ,rSize
-               ,lStyle
-               ,rsName
-              );
     }
 
     bool Create( wxWindow*       pParent
@@ -83,31 +48,22 @@ public:
                 ,long            lStyle = wxDEFAULT_DIALOG_STYLE
                 ,const wxString& rsName = wxDialogNameStr
                );
-    ~wxDialog();
+    virtual ~wxDialog();
 
-            void SetModal(bool bFlag);
+    // return true if we're showing the dialog modally
-    virtual bool IsModal(void) const;
+    virtual bool IsModal() const { return m_modalData != NULL; }
 
-    // For now, same as Show(TRUE) but returns return code
+    // show the dialog modally and return the value passed to EndModal()
     virtual int ShowModal();
 
     // may be called to terminate the dialog with the given return code
     virtual void EndModal(int retCode);
 
-    //
+    // implementation only from now on
-    // Returns TRUE if we're in a modal loop
-    //
-            bool IsModalShowing() const;
-
-    //
-    // Implementation only from now on
     // -------------------------------
-    //
 
-    //
+    // override some base class virtuals
-    // Override some base class virtuals
+    virtual bool Show(bool show = true);
-    //
-    virtual bool Show(bool bShow);
 
     //
     // Event handlers
@@ -134,20 +90,47 @@ public:
                                   ,WXWPARAM wParam
                                   ,WXLPARAM lParam
                                  );
+    // obsolete methods
+    // ----------------
+
+    // Constructor with a modal flag, but no window id - the old convention
+    wxDEPRECATED( wxDialog( wxWindow*       pParent
+                           ,const wxString& rsTitle
+                           ,bool            bModal
+                           ,int             nX = -1
+                           ,int             nY = -1
+                           ,int             nWidth = 500
+                           ,int             nHeight = 500
+                           ,long            lStyle = wxDEFAULT_DIALOG_STYLE
+                           ,const wxString& rsName = wxDialogNameStr
+                          ) );
+
+    // just call Show() or ShowModal()
+    wxDEPRECATED( void SetModal(bool bFlag) );
+
+    // use IsModal()
+    wxDEPRECATED( bool IsModalShowing() const );
 
 protected:
     //
-    // Show modal dialog and enter modal loop
+    // find the window to use as parent for this dialog if none has been
+    // specified explicitly by the user
     //
-    void DoShowModal(void);
+    // may return NULL
+    //
+    wxWindow *FindSuitableParent() const;
 
     //
     // Common part of all ctors
     //
     void Init(void);
 
+    // end either modal or modeless dialog
+    void EndDialog(int rc);
+
 private:
     wxWindow*                       m_pOldFocus;
+    bool        m_endModalCalled; // allow for closing within InitDialog
 
     // this pointer is non-NULL only while the modal event loop is running
     wxDialogModalData *m_modalData;
@@ -160,6 +143,7 @@ private:
 
     DECLARE_DYNAMIC_CLASS(wxDialog)
     DECLARE_EVENT_TABLE()
+    DECLARE_NO_COPY_CLASS(wxDialog)
 }; // end of CLASS wxDialog
 
 #endif // _WX_DIALOG_H_

src/os2/dialog.cpp

@@ -41,6 +41,7 @@ BEGIN_EVENT_TABLE(wxDialog, wxDialogBase)
     EVT_BUTTON(wxID_CANCEL, wxDialog::OnCancel)
     EVT_CHAR_HOOK(wxDialog::OnCharHook)
     EVT_SYS_COLOUR_CHANGED(wxDialog::OnSysColourChanged)
+
     EVT_CLOSE(wxDialog::OnCloseWindow)
 END_EVENT_TABLE()
 
@@ -130,26 +131,35 @@ bool wxDialog::Create(
     return TRUE;
 } // end of wxDialog::Create
 
+// deprecated ctor
+wxDialog::wxDialog(wxWindow *parent,
+                   const wxString& title,
+                   bool WXUNUSED(modal),
+                   int x,
+                   int y,
+                   int w,
+                   int h,
+                   long style,
+                   const wxString& name)
+{
+    Init();
+
+    Create(parent, wxID_ANY, title, wxPoint(x, y), wxSize(w, h), style, name);
+}
+
 void wxDialog::SetModal(
-  bool                              bFlag
+  bool                              WXUNUSED(bFlag)
 )
 {
-    if (bFlag)
+    // nothing to do, obsolete method
-    {
-        m_windowStyle |= wxDIALOG_MODAL ;
-        wxModelessWindows.DeleteObject(this);
-    }
-    else
-    {
-        m_windowStyle &= ~wxDIALOG_MODAL ;
-        wxModelessWindows.Append(this);
-    }
 } // end of wxDialog::SetModal
 
 wxDialog::~wxDialog()
 {
     m_isBeingDeleted = TRUE;
-    Show(FALSE);
+
+    // this will also reenable all the other windows for a modal dialog
+    Show(false);
 } // end of wxDialog::~wxDialog
 
 //
@@ -190,42 +200,121 @@ void wxDialog::OnCharHook(
 // showing the dialogs
 // ----------------------------------------------------------------------------
 
-bool wxDialog::IsModal() const
-{
-    return (GetWindowStyleFlag() & wxDIALOG_MODAL) != 0;
-} // end of wxDialog::IsModal
-
 bool wxDialog::IsModalShowing() const
 {
-    return m_modalData != NULL; // const_cast
+    return IsModal();
 } // end of wxDialog::IsModalShowing
 
-void wxDialog::DoShowModal()
+
+wxWindow *wxDialog::FindSuitableParent() const
 {
-    wxWindow*                       pParent = GetParent();
+    // first try to use the currently active window
-    wxWindow*                       pOldFocus = m_pOldFocus;
+    HWND hwndFg = ::WinQueryActiveWindow(HWND_DESKTOP);
-    HWND                            hWndOldFocus = 0;
+    wxWindow *parent = hwndFg ? wxFindWinFromHandle((WXHWND)hwndFg)
-
+                              : NULL;
-    wxCHECK_RET( !IsModalShowing(), _T("DoShowModal() called twice") );
+    if ( !parent )
-    wxCHECK_RET( IsModal(), _T("can't DoShowModal() modeless dialog") );
-
-    if (pOldFocus)
-        hWndOldFocus = (HWND)pOldFocus->GetHWND();
-
-    //
-    // Remember where the focus was
-    //
-    if (!pOldFocus)
     {
-        pOldFocus = pParent;
+        // next try the main app window
-        if (pParent)
+        parent = wxTheApp->GetTopWindow();
-            hWndOldFocus = GetHwndOf(pParent);
     }
 
+    // finally, check if the parent we found is really suitable
+    if ( !parent || parent == (wxWindow *)this || !parent->IsShown() )
+    {
+        // don't use this one
+        parent = NULL;
+    }
+
+    return parent;
+}
+
+bool wxDialog::Show(
+  bool                              bShow
+)
+{
+    if ( bShow == IsShown() )
+        return false;
+
+    if (!bShow && m_modalData )
+    {
+        // we need to do this before calling wxDialogBase version because if we
+        // had disabled other app windows, they must be reenabled right now as
+        // if they stay disabled Windows will activate another window (one
+        // which is enabled, anyhow) when we're hidden in the base class Show()
+        // and we will lose activation
+        m_modalData->ExitLoop();
+#if 0
+        if (m_pWindowDisabler)
+        {
+            delete m_pWindowDisabler;
+            m_pWindowDisabler = NULL;
+        }
+#endif
+    }
+
+    if (bShow)
+    {
+        // this usually will result in TransferDataToWindow() being called
+        // which will change the controls values so do it before showing as
+        // otherwise we could have some flicker
+        InitDialog();
+    }
+
+    wxDialogBase::Show(bShow);
+
+    if (GetTitle().c_str())
+        ::WinSetWindowText((HWND)GetHwnd(), GetTitle().c_str());
+
+    if ( bShow )
+    {
+        // dialogs don't get WM_SIZE message after creation unlike most (all?)
+        // other windows and so could start their life non laid out correctly
+        // if we didn't call Layout() from here
         //
-    // Disable all other app windows
+        // NB: normally we should call it just the first time but doing it
-    //
+        //     every time is simpler than keeping a flag
-    wxASSERT_MSG(!m_pWindowDisabler, _T("disabling windows twice?"));
+        Layout();
+    }
+
+    return true;
+} // end of wxDialog::Show
+
+//
+// Replacement for Show(TRUE) for modal dialogs - returns return code
+//
+int wxDialog::ShowModal()
+{
+    wxASSERT_MSG( !IsModal(), _T("wxDialog::ShowModal() reentered?") );
+
+    m_endModalCalled = false;
+
+    Show();
+
+    // EndModal may have been called from InitDialog handler (called from
+    // inside Show()), which would cause an infinite loop if we didn't take it
+    // into account
+    if ( !m_endModalCalled )
+    {
+        // modal dialog needs a parent window, so try to find one
+        wxWindow *parent = GetParent();
+        if ( !parent )
+        {
+            parent = FindSuitableParent();
+        }
+
+        // remember where the focus was
+        wxWindow *oldFocus = m_pOldFocus;
+        if ( !oldFocus )
+        {
+            // VZ: do we really want to do this?
+            oldFocus = parent;
+        }
+
+        // We have to remember the HWND because we need to check
+        // the HWND still exists (oldFocus can be garbage when the dialog
+        // exits, if it has been destroyed)
+        HWND hwndOldFocus = oldFocus ? GetHwndOf(oldFocus) : NULL;
+
 
         //
         // Before entering the modal loop, reset the "is in OnIdle()" flag (see
@@ -236,7 +325,7 @@ void wxDialog::DoShowModal()
 
         gbInOnIdle = FALSE;
 
-    // enter the modal loop
+        // enter and run the modal loop
         {
             wxDialogModalDataTiedPtr modalData(&m_modalData,
                                                new wxDialogModalData(this));
@@ -244,108 +333,18 @@ void wxDialog::DoShowModal()
         }
         gbInOnIdle = bWasInOnIdle;
 
-    //
         // and restore focus
         // Note that this code MUST NOT access the dialog object's data
         // in case the object has been deleted (which will be the case
         // for a modal dialog that has been destroyed before calling EndModal).
-    //
+        if ( oldFocus && (oldFocus != this) && ::WinIsWindow(vHabmain, hwndOldFocus))
-    if (pOldFocus && (pOldFocus != this) && ::WinIsWindow(vHabmain, hWndOldFocus))
         {
-        //
             // This is likely to prove that the object still exists
-        //
+            if (wxFindWinFromHandle((WXHWND) hwndOldFocus) == oldFocus)
-        if (wxFindWinFromHandle((WXHWND) hWndOldFocus) == pOldFocus)
+                oldFocus->SetFocus();
-            pOldFocus->SetFocus();
         }
-} // end of wxDialog::DoShowModal
-
-bool wxDialog::Show(
-  bool                              bShow
-)
-{
-    if (!bShow)
-    {
-        //
-        // If we had disabled other app windows, reenable them back now because
-        // if they stay disabled Windows will activate another window (one
-        // which is enabled, anyhow) and we will lose activation.  We really don't
-        // do this in OS/2 since PM does this for us.
-        //
-        if (m_pWindowDisabler)
-        {
-            delete m_pWindowDisabler;
-            m_pWindowDisabler = NULL;
-        }
-        if ( m_modalData )
-            m_modalData->ExitLoop();
     }
 
-    //
-    // ShowModal() may be called for already shown dialog
-    //
-    if (!wxDialogBase::Show(bShow) && !(bShow && IsModal()))
-    {
-        //
-        // Nothing to do
-        //
-        return FALSE;
-    }
-
-    if (bShow)
-    {
-        // dialogs don't get WM_SIZE message after creation unlike most (all?)
-        // other windows and so could start their life non laid out correctly
-        // if we didn't call Layout() from here
-        //
-        // NB: normally we should call it just the first time but doing it
-        //     every time is simpler than keeping a flag
-//         Layout();
-
-        //
-        // Usually will result in TransferDataToWindow() being called
-        //
-        InitDialog();
-    }
-
-    if (GetTitle().c_str())
-        ::WinSetWindowText((HWND)GetHwnd(), GetTitle().c_str());
-    if (IsModal())
-    {
-        if (bShow)
-        {
-            //
-            // Modal dialog needs a parent window, so try to find one
-            //
-            if (!GetParent())
-            {
-                wxWindow*           pParent = wxTheApp->GetTopWindow();
-
-                if ( pParent && pParent != this && pParent->IsShown() )
-                {
-                    //
-                    // Use it
-                    //
-                    m_parent = pParent;
-
-                }
-            }
-            DoShowModal();
-        }
-    }
-    return TRUE;
-} // end of wxDialog::Show
-
-//
-// Replacement for Show(TRUE) for modal dialogs - returns return code
-//
-int wxDialog::ShowModal()
-{
-    if (!IsModal())
-    {
-        SetModal(TRUE);
-    }
-    Show(TRUE);
     return GetReturnCode();
 } // end of wxDialog::ShowModal
 
@@ -353,10 +352,22 @@ void wxDialog::EndModal(
   int                               nRetCode
 )
 {
+    wxASSERT_MSG( IsModal(), _T("EndModal() called for non modal dialog") );
+
+    m_endModalCalled = true;
     SetReturnCode(nRetCode);
-    Show(FALSE);
+
+    Hide();
 } // end of wxDialog::EndModal
 
+void wxDialog::EndDialog(int rc)
+{
+    if ( IsModal() )
+        EndModal(rc);
+    else
+        Hide();
+}
+
 // ----------------------------------------------------------------------------
 // wxWin event handlers
 // ----------------------------------------------------------------------------
@@ -376,7 +387,7 @@ void wxDialog::OnOK(
 {
     if ( Validate() && TransferDataFromWindow() )
     {
-        EndModal(wxID_OK);
+        EndDialog(wxID_OK);
     }
 } // end of wxDialog::OnOK
 
@@ -384,7 +395,7 @@ void wxDialog::OnCancel(
   wxCommandEvent&                   rEvent
 )
 {
-    EndModal(wxID_CANCEL);
+    EndDialog(wxID_CANCEL);
 } // end of wxDialog::OnCancel
 
 void wxDialog::OnCloseWindow(
@@ -392,8 +403,7 @@ void wxDialog::OnCloseWindow(
 )
 {
     //
-    // We'll send a Cancel message by default,
+    // We'll send a Cancel message by default, which may close the dialog.
-    // which may close the dialog.
     // Check for looping if the Cancel event handler calls Close().
     //
     // Note that if a cancel button and handler aren't present in the dialog,