Use DECLARE_DYNAMIC_CLASS instead of DECLARE_CLASS.

[wxWidgets.git] / src / msw / progdlg.cpp

diff --git a/src/msw/progdlg.cpp b/src/msw/progdlg.cpp
index 1aa5298b24f6f45699a8dabf8a2a96b980c2cbfd..254fa00679c19f10811cc6f988c90c32c693ecbc 100644 (file)
--- a/src/msw/progdlg.cpp
+++ b/src/msw/progdlg.cpp
@@ -25,9 +25,18 @@
 
 #if wxUSE_PROGRESSDLG && wxUSE_THREADS
 
 
 #if wxUSE_PROGRESSDLG && wxUSE_THREADS
 

-#include "wx/msw/private/msgdlg.h"

 #include "wx/progdlg.h"
 
 #include "wx/progdlg.h"
 

+#ifndef WX_PRECOMP
+    #include "wx/app.h"
+    #include "wx/msgdlg.h"
+    #include "wx/stopwatch.h"
+    #include "wx/msw/private.h"
+#endif
+
+#include "wx/msw/private/msgdlg.h"
+#include "wx/evtloop.h"
+

 using namespace wxMSWMessageDialog;
 
 #ifdef wxHAS_MSW_TASKDIALOG
 using namespace wxMSWMessageDialog;
 
 #ifdef wxHAS_MSW_TASKDIALOG


@@ -72,10 +81,12 @@ public:
         m_progressBarMarquee = false;
         m_skipped = false;
         m_notifications = 0;
         m_progressBarMarquee = false;
         m_skipped = false;
         m_notifications = 0;

+        m_parent = NULL;

     }
 
     wxCriticalSection m_cs;
 
     }
 
     wxCriticalSection m_cs;
 

+    wxWindow *m_parent;     // Parent window only used to center us over it.

     HWND m_hwnd;            // Task dialog handler
     long m_style;           // wxProgressDialog style
     int m_value;
     HWND m_hwnd;            // Task dialog handler
     long m_style;           // wxProgressDialog style
     int m_value;


@@ -119,20 +130,36 @@ private:
                                                    LONG_PTR dwRefData);
 };
 
                                                    LONG_PTR dwRefData);
 };
 

-// ============================================================================
-// Helper functions
-// ============================================================================
-

 namespace
 {
 
 namespace
 {
 

-// This function returns true if the progress dialog with the given style
-// (combination of wxPD_XXX constants) needs the "Close" button and this button
-// only, i.e. not a "Cancel" one.
-bool UsesCloseButtonOnly(long style)
+// A custom event loop which runs until the state of the dialog becomes
+// "Dismissed".
+class wxProgressDialogModalLoop : public wxEventLoop

 {
 {

-    return !(style & (wxPD_CAN_ABORT | wxPD_AUTO_HIDE));
-}
+public:
+    wxProgressDialogModalLoop(wxProgressDialogSharedData& data)
+        : m_data(data)
+    {
+    }
+
+protected:
+    virtual void OnNextIteration()
+    {
+        wxCriticalSectionLocker locker(m_data.m_cs);
+
+        if ( m_data.m_state == wxProgressDialog::Dismissed )
+            Exit();
+    }
+
+    wxProgressDialogSharedData& m_data;
+
+    wxDECLARE_NO_COPY_CLASS(wxProgressDialogModalLoop);
+};
+
+// ============================================================================
+// Helper functions
+// ============================================================================

 
 BOOL CALLBACK DisplayCloseButton(HWND hwnd, LPARAM lParam)
 {
 
 BOOL CALLBACK DisplayCloseButton(HWND hwnd, LPARAM lParam)
 {


@@ -282,7 +309,7 @@ wxProgressDialog::wxProgressDialog( const wxString& title,
       m_title(title)
 {
 #ifdef wxHAS_MSW_TASKDIALOG
       m_title(title)
 {
 #ifdef wxHAS_MSW_TASKDIALOG

-    if ( HasNativeProgressDialog() )
+    if ( HasNativeTaskDialog() )

     {
         SetMaximum(maximum);
 
     {
         SetMaximum(maximum);
 


@@ -322,55 +349,67 @@ wxProgressDialog::~wxProgressDialog()
 bool wxProgressDialog::Update(int value, const wxString& newmsg, bool *skip)
 {
 #ifdef wxHAS_MSW_TASKDIALOG
 bool wxProgressDialog::Update(int value, const wxString& newmsg, bool *skip)
 {
 #ifdef wxHAS_MSW_TASKDIALOG

-    if ( HasNativeProgressDialog() )
+    if ( HasNativeTaskDialog() )

     {
     {

-        wxCriticalSectionLocker locker(m_sharedData->m_cs);
+        {
+            wxCriticalSectionLocker locker(m_sharedData->m_cs);

 
 

-        // Do nothing in canceled state.
-        if ( !DoNativeBeforeUpdate(skip) )
-            return false;
+            // Do nothing in canceled state.
+            if ( !DoNativeBeforeUpdate(skip) )
+                return false;

 
 

-        value /= m_factor;
+            value /= m_factor;

 
 

-        wxASSERT_MSG( value <= m_maximum, wxT("invalid progress value") );
+            wxASSERT_MSG( value <= m_maximum, wxT("invalid progress value") );

 
 

-        m_sharedData->m_value = value;
-        m_sharedData->m_notifications |= wxSPDD_VALUE_CHANGED;
+            m_sharedData->m_value = value;
+            m_sharedData->m_notifications |= wxSPDD_VALUE_CHANGED;

 
 

-        if ( !newmsg.empty() )
-        {
-            m_message = newmsg;
-            m_sharedData->m_message = newmsg;
-            m_sharedData->m_notifications |= wxSPDD_MESSAGE_CHANGED;
-        }
+            if ( !newmsg.empty() )
+            {
+                m_message = newmsg;
+                m_sharedData->m_message = newmsg;
+                m_sharedData->m_notifications |= wxSPDD_MESSAGE_CHANGED;
+            }

 
 

-        if ( m_sharedData->m_progressBarMarquee )
-        {
-            m_sharedData->m_progressBarMarquee = false;
-            m_sharedData->m_notifications |= wxSPDD_PBMARQUEE_CHANGED;
-        }
+            if ( m_sharedData->m_progressBarMarquee )
+            {
+                m_sharedData->m_progressBarMarquee = false;
+                m_sharedData->m_notifications |= wxSPDD_PBMARQUEE_CHANGED;
+            }

 
 

-        UpdateExpandedInformation( value );
+            UpdateExpandedInformation( value );

 
 

-        // Has the progress bar finished?
-        if ( value == m_maximum )
-        {
-            if ( m_state == Finished )
-                return true;
+            // If we didn't just reach the finish, all we have to do is to
+            // return true if the dialog wasn't cancelled and false otherwise.
+            if ( value != m_maximum || m_state == Finished )
+                return m_sharedData->m_state != Canceled;

 
 

+
+            // On finishing, the dialog without wxPD_AUTO_HIDE style becomes a
+            // modal one meaning that we must block here until the user
+            // dismisses it.

             m_state = Finished;
             m_sharedData->m_state = Finished;
             m_sharedData->m_notifications |= wxSPDD_FINISHED;
             m_state = Finished;
             m_sharedData->m_state = Finished;
             m_sharedData->m_notifications |= wxSPDD_FINISHED;

-            if( !HasPDFlag(wxPD_AUTO_HIDE) && newmsg.empty() )
+            if ( HasPDFlag(wxPD_AUTO_HIDE) )
+                return true;
+
+            if ( newmsg.empty() )

             {
                 // Provide the finishing message if the application didn't.
                 m_message = _("Done.");
                 m_sharedData->m_message = m_message;
                 m_sharedData->m_notifications |= wxSPDD_MESSAGE_CHANGED;
             }
             {
                 // Provide the finishing message if the application didn't.
                 m_message = _("Done.");
                 m_sharedData->m_message = m_message;
                 m_sharedData->m_notifications |= wxSPDD_MESSAGE_CHANGED;
             }

-        }
-
-        return m_sharedData->m_state != Canceled;
+        } // unlock m_sharedData->m_cs
+
+        // We only get here when we need to wait for the dialog to terminate so
+        // do just this by running a custom event loop until the dialog is
+        // dismissed.
+        wxProgressDialogModalLoop loop(*m_sharedData);
+        loop.Run();
+        return true;

     }
 #endif // wxHAS_MSW_TASKDIALOG
 
     }
 #endif // wxHAS_MSW_TASKDIALOG
 


@@ -380,7 +419,7 @@ bool wxProgressDialog::Update(int value, const wxString& newmsg, bool *skip)
 bool wxProgressDialog::Pulse(const wxString& newmsg, bool *skip)
 {
 #ifdef wxHAS_MSW_TASKDIALOG
 bool wxProgressDialog::Pulse(const wxString& newmsg, bool *skip)
 {
 #ifdef wxHAS_MSW_TASKDIALOG

-    if ( HasNativeProgressDialog() )
+    if ( HasNativeTaskDialog() )

     {
         wxCriticalSectionLocker locker(m_sharedData->m_cs);
 
     {
         wxCriticalSectionLocker locker(m_sharedData->m_cs);
 


@@ -415,7 +454,7 @@ bool wxProgressDialog::Pulse(const wxString& newmsg, bool *skip)
 bool wxProgressDialog::DoNativeBeforeUpdate(bool *skip)
 {
 #ifdef wxHAS_MSW_TASKDIALOG
 bool wxProgressDialog::DoNativeBeforeUpdate(bool *skip)
 {
 #ifdef wxHAS_MSW_TASKDIALOG

-    if ( HasNativeProgressDialog() )
+    if ( HasNativeTaskDialog() )

     {
         if ( m_sharedData->m_skipped  )
         {
     {
         if ( m_sharedData->m_skipped  )
         {


@@ -445,7 +484,7 @@ void wxProgressDialog::Resume()
     wxGenericProgressDialog::Resume();
 
 #ifdef wxHAS_MSW_TASKDIALOG
     wxGenericProgressDialog::Resume();
 
 #ifdef wxHAS_MSW_TASKDIALOG

-    if ( HasNativeProgressDialog() )
+    if ( HasNativeTaskDialog() )

     {
         HWND hwnd;
 
     {
         HWND hwnd;
 


@@ -457,7 +496,8 @@ void wxProgressDialog::Resume()
             // it now.
             m_sharedData->m_notifications |= wxSPDD_ENABLE_SKIP;
 
             // it now.
             m_sharedData->m_notifications |= wxSPDD_ENABLE_SKIP;
 

-            if ( !UsesCloseButtonOnly(GetPDStyle()) )
+            // Also re-enable "Cancel" itself
+            if ( HasPDFlag(wxPD_CAN_ABORT) )

                 m_sharedData->m_notifications |= wxSPDD_ENABLE_ABORT;
 
             hwnd = m_sharedData->m_hwnd;
                 m_sharedData->m_notifications |= wxSPDD_ENABLE_ABORT;
 
             hwnd = m_sharedData->m_hwnd;


@@ -481,7 +521,7 @@ void wxProgressDialog::Resume()
 int wxProgressDialog::GetValue() const
 {
 #ifdef wxHAS_MSW_TASKDIALOG
 int wxProgressDialog::GetValue() const
 {
 #ifdef wxHAS_MSW_TASKDIALOG

-    if ( HasNativeProgressDialog() )
+    if ( HasNativeTaskDialog() )

     {
         wxCriticalSectionLocker locker(m_sharedData->m_cs);
         return m_sharedData->m_value;
     {
         wxCriticalSectionLocker locker(m_sharedData->m_cs);
         return m_sharedData->m_value;


@@ -494,7 +534,7 @@ int wxProgressDialog::GetValue() const
 wxString wxProgressDialog::GetMessage() const
 {
 #ifdef wxHAS_MSW_TASKDIALOG
 wxString wxProgressDialog::GetMessage() const
 {
 #ifdef wxHAS_MSW_TASKDIALOG

-    if ( HasNativeProgressDialog() )
+    if ( HasNativeTaskDialog() )

         return m_message;
 #endif // wxHAS_MSW_TASKDIALOG
 
         return m_message;
 #endif // wxHAS_MSW_TASKDIALOG
 


@@ -504,7 +544,7 @@ wxString wxProgressDialog::GetMessage() const
 void wxProgressDialog::SetRange(int maximum)
 {
 #ifdef wxHAS_MSW_TASKDIALOG
 void wxProgressDialog::SetRange(int maximum)
 {
 #ifdef wxHAS_MSW_TASKDIALOG

-    if ( HasNativeProgressDialog() )
+    if ( HasNativeTaskDialog() )

     {
         SetMaximum(maximum);
 
     {
         SetMaximum(maximum);
 


@@ -523,7 +563,7 @@ void wxProgressDialog::SetRange(int maximum)
 bool wxProgressDialog::WasSkipped() const
 {
 #ifdef wxHAS_MSW_TASKDIALOG
 bool wxProgressDialog::WasSkipped() const
 {
 #ifdef wxHAS_MSW_TASKDIALOG

-    if ( HasNativeProgressDialog() )
+    if ( HasNativeTaskDialog() )

     {
         if ( !m_sharedData )
         {
     {
         if ( !m_sharedData )
         {


@@ -542,7 +582,7 @@ bool wxProgressDialog::WasSkipped() const
 bool wxProgressDialog::WasCancelled() const
 {
 #ifdef wxHAS_MSW_TASKDIALOG
 bool wxProgressDialog::WasCancelled() const
 {
 #ifdef wxHAS_MSW_TASKDIALOG

-    if ( HasNativeProgressDialog() )
+    if ( HasNativeTaskDialog() )

     {
         wxCriticalSectionLocker locker(m_sharedData->m_cs);
         return m_sharedData->m_state == Canceled;
     {
         wxCriticalSectionLocker locker(m_sharedData->m_cs);
         return m_sharedData->m_state == Canceled;


@@ -555,7 +595,7 @@ bool wxProgressDialog::WasCancelled() const
 void wxProgressDialog::SetTitle(const wxString& title)
 {
 #ifdef wxHAS_MSW_TASKDIALOG
 void wxProgressDialog::SetTitle(const wxString& title)
 {
 #ifdef wxHAS_MSW_TASKDIALOG

-    if ( HasNativeProgressDialog() )
+    if ( HasNativeTaskDialog() )

     {
         m_title = title;
 
     {
         m_title = title;
 


@@ -574,7 +614,7 @@ void wxProgressDialog::SetTitle(const wxString& title)
 wxString wxProgressDialog::GetTitle() const
 {
 #ifdef wxHAS_MSW_TASKDIALOG
 wxString wxProgressDialog::GetTitle() const
 {
 #ifdef wxHAS_MSW_TASKDIALOG

-    if ( HasNativeProgressDialog() )
+    if ( HasNativeTaskDialog() )

         return m_title;
 #endif // wxHAS_MSW_TASKDIALOG
 
         return m_title;
 #endif // wxHAS_MSW_TASKDIALOG
 


@@ -584,7 +624,7 @@ wxString wxProgressDialog::GetTitle() const
 bool wxProgressDialog::Show(bool show)
 {
 #ifdef wxHAS_MSW_TASKDIALOG
 bool wxProgressDialog::Show(bool show)
 {
 #ifdef wxHAS_MSW_TASKDIALOG

-    if ( HasNativeProgressDialog() )
+    if ( HasNativeTaskDialog() )

     {
         // The dialog can't be hidden at all and showing it again after it had
         // been shown before doesn't do anything.
     {
         // The dialog can't be hidden at all and showing it again after it had
         // been shown before doesn't do anything.


@@ -602,14 +642,17 @@ bool wxProgressDialog::Show(bool show)
         m_sharedData->m_range = m_maximum;
         m_sharedData->m_state = Uncancelable;
         m_sharedData->m_style = GetPDStyle();
         m_sharedData->m_range = m_maximum;
         m_sharedData->m_state = Uncancelable;
         m_sharedData->m_style = GetPDStyle();

+        m_sharedData->m_parent = GetTopParent();

 
         if ( HasPDFlag(wxPD_CAN_ABORT) )
         {
             m_sharedData->m_state = Continue;
             m_sharedData->m_labelCancel = _("Cancel");
         }
 
         if ( HasPDFlag(wxPD_CAN_ABORT) )
         {
             m_sharedData->m_state = Continue;
             m_sharedData->m_labelCancel = _("Cancel");
         }

-        else if ( !HasPDFlag(wxPD_AUTO_HIDE) )
+        else // Dialog can't be cancelled.

         {
         {

+            // We still must have at least a single button in the dialog so
+            // just don't call it "Cancel" in this case.

             m_sharedData->m_labelCancel = _("Close");
         }
 
             m_sharedData->m_labelCancel = _("Close");
         }
 


@@ -642,22 +685,6 @@ bool wxProgressDialog::Show(bool show)
     return wxGenericProgressDialog::Show( show );
 }
 
     return wxGenericProgressDialog::Show( show );
 }
 

-bool wxProgressDialog::HasNativeProgressDialog() const
-{
-#ifdef wxHAS_MSW_TASKDIALOG
-    // Native task dialog, if available, can't be used without any buttons so
-    // we fall back to the generic one if none of "Skip", "Cancel" and "Close"
-    // buttons is used.
-    return HasNativeTaskDialog()
-            && (HasPDFlag(wxPD_CAN_SKIP | wxPD_CAN_ABORT) ||
-                    !HasPDFlag(wxPD_AUTO_HIDE));
-#else // !wxHAS_MSW_TASKDIALOG
-    // This shouldn't be even called in !wxHAS_MSW_TASKDIALOG case but as we
-    // still must define the function as returning something, return false.
-    return false;
-#endif // wxHAS_MSW_TASKDIALOG/!wxHAS_MSW_TASKDIALOG
-}
-

 void wxProgressDialog::UpdateExpandedInformation(int value)
 {
 #ifdef wxHAS_MSW_TASKDIALOG
 void wxProgressDialog::UpdateExpandedInformation(int value)
 {
 #ifdef wxHAS_MSW_TASKDIALOG


@@ -749,12 +776,8 @@ void* wxProgressDialogTaskRunner::Entry()
 
         // Use a Cancel button when requested or use a Close button when
         // the dialog does not automatically hide.
 
         // Use a Cancel button when requested or use a Close button when
         // the dialog does not automatically hide.

-        if ( (m_sharedData.m_style & wxPD_CAN_ABORT)
-             || !(m_sharedData.m_style & wxPD_AUTO_HIDE) )
-        {
-            wxTdc.AddTaskDialogButton( tdc, IDCANCEL, 0,
-                                       m_sharedData.m_labelCancel );
-        }
+        wxTdc.AddTaskDialogButton( tdc, IDCANCEL, 0,
+                                   m_sharedData.m_labelCancel );

 
         tdc.dwFlags |= TDF_CALLBACK_TIMER | TDF_SHOW_PROGRESS_BAR;
 
 
         tdc.dwFlags |= TDF_CALLBACK_TIMER | TDF_SHOW_PROGRESS_BAR;
 


@@ -774,6 +797,10 @@ void* wxProgressDialogTaskRunner::Entry()
     if ( FAILED(hr) )
         wxLogApiError( "TaskDialogIndirect", hr );
 
     if ( FAILED(hr) )
         wxLogApiError( "TaskDialogIndirect", hr );
 

+    // If the main thread is waiting for us to exit inside the event loop in
+    // Update(), wake it up so that it checks our status again.
+    wxWakeUpIdle();
+

     return NULL;
 }
 
     return NULL;
 }
 


@@ -805,7 +832,30 @@ wxProgressDialogTaskRunner::TaskDialogCallbackProc
                            0,
                            MAKELPARAM(0, sharedData->m_range) );
 
                            0,
                            MAKELPARAM(0, sharedData->m_range) );
 

-            if ( UsesCloseButtonOnly(sharedData->m_style) )
+            // We always create this task dialog with NULL parent because our
+            // parent in wx sense is a window created from a different thread
+            // and so can't be used as our real parent. However we still center
+            // this window on the parent one as the task dialogs do with their
+            // real parent usually.
+            if ( sharedData->m_parent )
+            {
+                wxRect rect(wxRectFromRECT(wxGetWindowRect(hwnd)));
+                rect = rect.CentreIn(sharedData->m_parent->GetRect());
+                ::SetWindowPos(hwnd,
+                               NULL,
+                               rect.x,
+                               rect.y,
+                               -1,
+                               -1,
+                               SWP_NOACTIVATE |
+                               SWP_NOOWNERZORDER |
+                               SWP_NOSIZE |
+                               SWP_NOZORDER);
+            }
+
+            // If we can't be aborted, the "Close" button will only be enabled
+            // when the progress ends (and not even then with wxPD_AUTO_HIDE).
+            if ( !(sharedData->m_style & wxPD_CAN_ABORT) )

                 ::SendMessage( hwnd, TDM_ENABLE_BUTTON, IDCANCEL, FALSE );
             break;
 
                 ::SendMessage( hwnd, TDM_ENABLE_BUTTON, IDCANCEL, FALSE );
             break;
 


@@ -820,13 +870,18 @@ wxProgressDialogTaskRunner::TaskDialogCallbackProc
                 case IDCANCEL:
                     if ( sharedData->m_state == wxProgressDialog::Finished )
                     {
                 case IDCANCEL:
                     if ( sharedData->m_state == wxProgressDialog::Finished )
                     {

+                        // If the main thread is waiting for us, tell it that
+                        // we're gone (and if it doesn't wait, it's harmless).
+                        sharedData->m_state = wxProgressDialog::Dismissed;
+
+                        // Let Windows close the dialog.

                         return FALSE;
                     }
 
                     // Close button on the window triggers an IDCANCEL press,
                     // don't allow it when it should only be possible to close
                     // a finished dialog.
                         return FALSE;
                     }
 
                     // Close button on the window triggers an IDCANCEL press,
                     // don't allow it when it should only be possible to close
                     // a finished dialog.

-                    if ( !UsesCloseButtonOnly(sharedData->m_style) )
+                    if ( sharedData->m_style & wxPD_CAN_ABORT )

                     {
                         wxCHECK_MSG
                         (
                     {
                         wxCHECK_MSG
                         (


@@ -849,22 +904,19 @@ wxProgressDialogTaskRunner::TaskDialogCallbackProc
         case TDN_TIMER:
             PerformNotificationUpdates(hwnd, sharedData);
 
         case TDN_TIMER:
             PerformNotificationUpdates(hwnd, sharedData);
 

-            // End dialog in three different cases:
-            // 1. Progress finished and dialog should automatically hide.
-            // 2. The wxProgressDialog object was destructed and should
-            //    automatically hide.
-            // 3. The dialog was canceled and wxProgressDialog object
-            //    was destroyed.
-            bool isCanceled =
-                sharedData->m_state == wxGenericProgressDialog::Canceled;
-            bool isFinished =
-                sharedData->m_state == wxGenericProgressDialog::Finished;
-            bool wasDestroyed =
-                (sharedData->m_notifications & wxSPDD_DESTROYED) != 0;
-            bool shouldAutoHide = (sharedData->m_style & wxPD_AUTO_HIDE) != 0;
-
-            if ( (shouldAutoHide && (isFinished || wasDestroyed))
-                 || (wasDestroyed && isCanceled) )
+            /*
+                Decide whether we should end the dialog. This is done if either
+                the dialog object itself was destroyed or if the progress
+                finished and we were configured to hide automatically without
+                waiting for the user to dismiss us.
+
+                Notice that we do not close the dialog if it was cancelled
+                because it's up to the user code in the main thread to decide
+                whether it really wants to cancel the dialog.
+             */
+            if ( (sharedData->m_notifications & wxSPDD_DESTROYED) ||
+                    (sharedData->m_state == wxProgressDialog::Finished &&
+                        sharedData->m_style & wxPD_AUTO_HIDE) )

             {
                 ::EndDialog( hwnd, IDCLOSE );
             }
             {
                 ::EndDialog( hwnd, IDCLOSE );
             }