Refresh is necessary in earlier systems, no penalty when doing in 10.3+

[wxWidgets.git] / src / generic / progdlgg.cpp

diff --git a/src/generic/progdlgg.cpp b/src/generic/progdlgg.cpp
index 12a2aa179762458e2b88f8bee713d0d895fc4e12..10c5e65e9e5f390b35f135c9fc571ae97edcbaed 100644 (file)
--- a/src/generic/progdlgg.cpp
+++ b/src/generic/progdlgg.cpp
@@ -6,7 +6,7 @@
 // Created:     09.05.1999
 // RCS-ID:      $Id$
 // Copyright:   (c) Karsten Ballüder
 // Created:     09.05.1999
 // RCS-ID:      $Id$
 // Copyright:   (c) Karsten Ballüder

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================


@@ -17,7 +17,7 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

     #pragma implementation "progdlgg.h"
 #endif
 
     #pragma implementation "progdlgg.h"
 #endif
 


@@ -35,7 +35,7 @@
     #include "wx/frame.h"
     #include "wx/button.h"
     #include "wx/stattext.h"
     #include "wx/frame.h"
     #include "wx/button.h"
     #include "wx/stattext.h"

-    #include "wx/layout.h"
+    #include "wx/sizer.h"

     #include "wx/event.h"
     #include "wx/gauge.h"
     #include "wx/intl.h"
     #include "wx/event.h"
     #include "wx/gauge.h"
     #include "wx/intl.h"


@@ -50,8 +50,7 @@
 // constants
 // ----------------------------------------------------------------------------
 
 // constants
 // ----------------------------------------------------------------------------
 

-#define LAYOUT_X_MARGIN 8
-#define LAYOUT_Y_MARGIN 8
+#define LAYOUT_MARGIN 8

 
 // ----------------------------------------------------------------------------
 // private functions
 
 // ----------------------------------------------------------------------------
 // private functions


@@ -67,19 +66,17 @@ static void SetTimeLabel(unsigned long val, wxStaticText *label);
 BEGIN_EVENT_TABLE(wxProgressDialog, wxDialog)
     EVT_BUTTON(wxID_CANCEL, wxProgressDialog::OnCancel)
 
 BEGIN_EVENT_TABLE(wxProgressDialog, wxDialog)
     EVT_BUTTON(wxID_CANCEL, wxProgressDialog::OnCancel)
 

-    EVT_SHOW(wxProgressDialog::OnShow)
-

     EVT_CLOSE(wxProgressDialog::OnClose)
 END_EVENT_TABLE()
 
 IMPLEMENT_CLASS(wxProgressDialog, wxDialog)
 
 // ============================================================================
     EVT_CLOSE(wxProgressDialog::OnClose)
 END_EVENT_TABLE()
 
 IMPLEMENT_CLASS(wxProgressDialog, wxDialog)
 
 // ============================================================================

-// implementation
+// wxProgressDialog implementation

 // ============================================================================
 
 // ----------------------------------------------------------------------------
 // ============================================================================
 
 // ----------------------------------------------------------------------------

-// wxProgressDialog
+// wxProgressDialog creation

 // ----------------------------------------------------------------------------
 
 wxProgressDialog::wxProgressDialog(wxString const &title,
 // ----------------------------------------------------------------------------
 
 wxProgressDialog::wxProgressDialog(wxString const &title,


@@ -87,8 +84,11 @@ wxProgressDialog::wxProgressDialog(wxString const &title,
                                    int maximum,
                                    wxWindow *parent,
                                    int style)
                                    int maximum,
                                    wxWindow *parent,
                                    int style)

-                : wxDialog(parent, -1, title)
+                : wxDialog(parent, wxID_ANY, title)

 {
 {

+    // we may disappear at any moment, let the others know about it
+    SetExtraStyle(GetExtraStyle() | wxWS_EX_TRANSIENT);
+

     m_windowStyle |= style;
 
     bool hasAbortButton = (style & wxPD_CAN_ABORT) != 0;
     m_windowStyle |= style;
 
     bool hasAbortButton = (style & wxPD_CAN_ABORT) != 0;


@@ -100,59 +100,50 @@ wxProgressDialog::wxProgressDialog(wxString const &title,
     // FIXME: should probably have a (extended?) window style for this
     if ( !hasAbortButton )
     {
     // FIXME: should probably have a (extended?) window style for this
     if ( !hasAbortButton )
     {

-        EnableCloseButton(FALSE);
+        EnableCloseButton(false);

     }
 #endif // wxMSW
 
     m_state = hasAbortButton ? Continue : Uncancelable;
     m_maximum = maximum;
 
     }
 #endif // wxMSW
 
     m_state = hasAbortButton ? Continue : Uncancelable;
     m_maximum = maximum;
 

-    m_parentTop = parent;
-    while ( m_parentTop && m_parentTop->GetParent() )
-    {
-        m_parentTop = m_parentTop->GetParent();
-    }
+#if defined(__WXMSW__) || defined(__WXPM__)
+    // we can't have values > 65,536 in the progress control under Windows, so
+    // scale everything down
+    m_factor = m_maximum / 65536 + 1;
+    m_maximum /= m_factor;
+#endif // __WXMSW__

 
 

-    wxLayoutConstraints *c;
+    m_parentTop = wxGetTopLevelParent(parent);

 
     wxClientDC dc(this);
 
     wxClientDC dc(this);

-    dc.SetFont(wxSystemSettings::GetSystemFont(wxSYS_DEFAULT_GUI_FONT));
+    dc.SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT));

     long widthText;
     dc.GetTextExtent(message, &widthText, NULL, NULL, NULL, NULL);
 
     long widthText;
     dc.GetTextExtent(message, &widthText, NULL, NULL, NULL, NULL);
 

-    m_msg = new wxStaticText(this, -1, message);
-    c = new wxLayoutConstraints;
-    c->left.SameAs(this, wxLeft, 2*LAYOUT_X_MARGIN);
-    c->top.SameAs(this, wxTop, 2*LAYOUT_Y_MARGIN);
-    c->width.AsIs();
-    c->height.AsIs();
-    m_msg->SetConstraints(c);
-
-    wxSize sizeDlg, sizeLabel = m_msg->GetSize();
-    sizeDlg.y = 2*LAYOUT_Y_MARGIN + sizeLabel.y;
+    wxBoxSizer *sizer = new wxBoxSizer(wxVERTICAL);
+       
+    m_msg = new wxStaticText(this, wxID_ANY, message);
+    sizer->Add(m_msg, 0, wxLEFT | wxTOP, 2*LAYOUT_MARGIN);

 
 

-    wxWindow *lastWindow = m_msg;
+    wxSize sizeDlg,
+           sizeLabel = m_msg->GetSize();
+    sizeDlg.y = 2*LAYOUT_MARGIN + sizeLabel.y;

 
     if ( maximum > 0 )
     {
 
     if ( maximum > 0 )
     {

-        // note that we can't use wxGA_SMOOTH because it happens to also mean
-        // wxDIALOG_MODAL and will cause the dialog to be modal. Have an extra
+        // note that we can't use wxGA_SMOOTH because it happens to
+        // cause the dialog to be modal. Have an extra

         // style argument to wxProgressDialog, perhaps.
         // style argument to wxProgressDialog, perhaps.

-        m_gauge = new wxGauge(this, -1, maximum,
+        m_gauge = new wxGauge(this, wxID_ANY, m_maximum,

                               wxDefaultPosition, wxDefaultSize,
                               wxGA_HORIZONTAL);
 
                               wxDefaultPosition, wxDefaultSize,
                               wxGA_HORIZONTAL);
 

-        c = new wxLayoutConstraints;
-        c->left.SameAs(this, wxLeft, 2*LAYOUT_X_MARGIN);
-        c->top.Below(m_msg, 2*LAYOUT_Y_MARGIN);
-        c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
-        c->height.AsIs();
-        m_gauge->SetConstraints(c);
+        sizer->Add(m_gauge, 0, wxLEFT | wxRIGHT | wxTOP | wxEXPAND, 2*LAYOUT_MARGIN);

         m_gauge->SetValue(0);
         m_gauge->SetValue(0);

-        lastWindow = m_gauge;

 
         wxSize sizeGauge = m_gauge->GetSize();
 
         wxSize sizeGauge = m_gauge->GetSize();

-        sizeDlg.y += 2*LAYOUT_Y_MARGIN + sizeGauge.y;
+        sizeDlg.y += 2*LAYOUT_MARGIN + sizeGauge.y;

     }
     else
         m_gauge = (wxGauge *)NULL;
     }
     else
         m_gauge = (wxGauge *)NULL;


@@ -160,63 +151,63 @@ wxProgressDialog::wxProgressDialog(wxString const &title,
     // create the estimated/remaining/total time zones if requested
     m_elapsed = m_estimated = m_remaining = (wxStaticText*)NULL;
 
     // create the estimated/remaining/total time zones if requested
     m_elapsed = m_estimated = m_remaining = (wxStaticText*)NULL;
 

-    int nTimeLabels = 0;
+    // if we are going to have at least one label, remmeber it in this var
+    wxStaticText *label = NULL;
+
+    // also count how many labels we really have
+    size_t nTimeLabels = 0;
+

     if ( style & wxPD_ELAPSED_TIME )
     {
         nTimeLabels++;
 
     if ( style & wxPD_ELAPSED_TIME )
     {
         nTimeLabels++;
 

-        m_elapsed = CreateLabel(_("Elapsed time : "), &lastWindow);
+        label =
+        m_elapsed = CreateLabel(_("Elapsed time : "), sizer);

     }
 
     if ( style & wxPD_ESTIMATED_TIME )
     {
         nTimeLabels++;
 
     }
 
     if ( style & wxPD_ESTIMATED_TIME )
     {
         nTimeLabels++;
 

-        m_estimated = CreateLabel(_("Estimated time : "), &lastWindow);
+        label =
+        m_estimated = CreateLabel(_("Estimated time : "), sizer);

     }
 
     if ( style & wxPD_REMAINING_TIME )
     {
         nTimeLabels++;
 
     }
 
     if ( style & wxPD_REMAINING_TIME )
     {
         nTimeLabels++;
 

-        m_remaining = CreateLabel(_("Remaining time : "), &lastWindow);
+        label =
+        m_remaining = CreateLabel(_("Remaining time : "), sizer);

     }
 
     if ( nTimeLabels > 0 )
     {
         // set it to the current time
         m_timeStart = wxGetCurrentTime();
     }
 
     if ( nTimeLabels > 0 )
     {
         // set it to the current time
         m_timeStart = wxGetCurrentTime();

-        sizeDlg.y += nTimeLabels * (sizeLabel.y + LAYOUT_Y_MARGIN);
+        sizeDlg.y += nTimeLabels * (label->GetSize().y + LAYOUT_MARGIN);

     }
 
     if ( hasAbortButton )
     {
         m_btnAbort = new wxButton(this, wxID_CANCEL, _("Cancel"));
     }
 
     if ( hasAbortButton )
     {
         m_btnAbort = new wxButton(this, wxID_CANCEL, _("Cancel"));

-        c = new wxLayoutConstraints;

 
         // Windows dialogs usually have buttons in the lower right corner
 
         // Windows dialogs usually have buttons in the lower right corner

-#ifdef __WXMSW__
-        c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
+#if defined(__WXMSW__) || defined(__WXPM__)
+        sizer->Add(m_btnAbort, 0, wxALIGN_RIGHT | wxALL, 2*LAYOUT_MARGIN);

 #else // !MSW
 #else // !MSW

-        c->centreX.SameAs(this, wxCentreX);
+        sizer->Add(m_btnAbort, 0, wxALIGN_CENTER_HORIZONTAL | wxBOTTOM | wxTOP, 2*LAYOUT_MARGIN);

 #endif // MSW/!MSW
 #endif // MSW/!MSW

-        c->bottom.SameAs(this, wxBottom, 2*LAYOUT_Y_MARGIN);
-
-        wxSize sizeBtn = wxButton::GetDefaultSize();
-        c->width.Absolute(sizeBtn.x);
-        c->height.Absolute(sizeBtn.y);
-
-        m_btnAbort->SetConstraints(c);
-
-        sizeDlg.y += 2*LAYOUT_Y_MARGIN + sizeBtn.y;
+        sizeDlg.y += 2*LAYOUT_MARGIN + wxButton::GetDefaultSize().y;

     }
     }

-    else
+    else // no "Cancel" button
+    {

         m_btnAbort = (wxButton *)NULL;
         m_btnAbort = (wxButton *)NULL;

+    }

 
 

-    SetAutoLayout(TRUE);
-    Layout();
+    SetSizerAndFit(sizer);

 
 

-    sizeDlg.y += 2*LAYOUT_Y_MARGIN;
+    sizeDlg.y += 2*LAYOUT_MARGIN;

 
     // try to make the dialog not square but rectangular of reasonabel width
     sizeDlg.x = (wxCoord)wxMax(widthText, 4*sizeDlg.y/3);
 
     // try to make the dialog not square but rectangular of reasonabel width
     sizeDlg.x = (wxCoord)wxMax(widthText, 4*sizeDlg.y/3);


@@ -233,12 +224,12 @@ wxProgressDialog::wxProgressDialog(wxString const &title,
     else
     {
         if ( m_parentTop )
     else
     {
         if ( m_parentTop )

-            m_parentTop->Enable(FALSE);
+            m_parentTop->Disable();

         m_winDisabler = NULL;
     }
 
         m_winDisabler = NULL;
     }
 

-    Show(TRUE);
-    Enable(TRUE); // enable this window
+    Show();
+    Enable();

 
     // this one can be initialized even if the others are unknown for now
     //
 
     // this one can be initialized even if the others are unknown for now
     //


@@ -248,73 +239,65 @@ wxProgressDialog::wxProgressDialog(wxString const &title,
         SetTimeLabel(0, m_elapsed);
     }
 
         SetTimeLabel(0, m_elapsed);
     }
 

-    // Update the display (especially on X, GTK)
-    wxYield();
-
-#ifdef __WXMAC__
-    MacUpdateImmediately();
-#endif
+    Update();

 }
 
 wxStaticText *wxProgressDialog::CreateLabel(const wxString& text,
 }
 
 wxStaticText *wxProgressDialog::CreateLabel(const wxString& text,

-                                            wxWindow **lastWindow)
+                                            wxSizer *sizer)

 {
 {

-    wxLayoutConstraints *c;
+    wxBoxSizer *locsizer = new wxBoxSizer(wxHORIZONTAL);

 
 

-    wxStaticText *label = new wxStaticText(this, -1, _("unknown"));
-    c = new wxLayoutConstraints;
+    wxStaticText *dummy = new wxStaticText(this, -1, text);
+    wxStaticText *label = new wxStaticText(this, wxID_ANY, _("unknown"));

 
     // VZ: I like the labels be centered - if the others don't mind, you may
     //     remove "#ifdef __WXMSW__" and use it for all ports
 
     // VZ: I like the labels be centered - if the others don't mind, you may
     //     remove "#ifdef __WXMSW__" and use it for all ports

-#ifdef __WXMSW__
-    c->left.SameAs(this, wxCentreX, LAYOUT_X_MARGIN);
+#if defined(__WXMSW__) || defined(__WXPM__) || defined(__WXMAC__)
+    locsizer->Add(dummy, 1, wxALIGN_RIGHT);
+    locsizer->Add(label, 1, wxALIGN_LEFT | wxLEFT, LAYOUT_MARGIN);
+    sizer->Add(locsizer, 0, wxALIGN_CENTER_HORIZONTAL | wxTOP, LAYOUT_MARGIN);

 #else // !MSW
 #else // !MSW

-    c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
+    sizer->Add(locsizer, 0, wxALIGN_RIGHT | wxRIGHT | wxTOP, LAYOUT_MARGIN);
+    locsizer->Add(dummy);
+    locsizer->Add(label, 0, wxLEFT, LAYOUT_MARGIN);

 #endif // MSW/!MSW
 #endif // MSW/!MSW

-    c->top.Below(*lastWindow, LAYOUT_Y_MARGIN);
-    c->width.AsIs();
-    c->height.AsIs();
-    label->SetConstraints(c);
-
-    wxStaticText *dummy = new wxStaticText(this, -1, text);
-    c = new wxLayoutConstraints;
-    c->right.LeftOf(label);
-    c->top.SameAs(label, wxTop, 0);
-    c->width.AsIs();
-    c->height.AsIs();
-    dummy->SetConstraints(c);
-
-    *lastWindow = label;

 
     return label;
 }
 
 
     return label;
 }
 

+// ----------------------------------------------------------------------------
+// wxProgressDialog operations
+// ----------------------------------------------------------------------------
+

 bool
 wxProgressDialog::Update(int value, const wxString& newmsg)
 {
     wxASSERT_MSG( value == -1 || m_gauge, wxT("cannot update non existent dialog") );
 bool
 wxProgressDialog::Update(int value, const wxString& newmsg)
 {
     wxASSERT_MSG( value == -1 || m_gauge, wxT("cannot update non existent dialog") );

+
+#ifdef __WXMSW__
+    value /= m_factor;
+#endif // __WXMSW__
+

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

-    if ( m_gauge )
-        m_gauge->SetValue(value + 1);
+    // fill up the gauge if value == maximum because this means that the dialog
+    // is going to close and the gauge shouldn't be partly empty in this case
+    if ( m_gauge && value <= m_maximum )
+    {
+        m_gauge->SetValue(value == m_maximum ? value : value + 1);
+    }

 
     if ( !newmsg.IsEmpty() )
     {
 
     if ( !newmsg.IsEmpty() )
     {

-#ifdef __WXMSW__
-        // this seems to be necessary or garbage is left when the new label is
-        // longer than the old one
-        m_msg->SetLabel(wxEmptyString);
-#endif // MSW
-

         m_msg->SetLabel(newmsg);
 
         m_msg->SetLabel(newmsg);
 

-        wxYield();
+        wxYieldIfNeeded() ;

     }
 
     if ( (m_elapsed || m_remaining || m_estimated) && (value != 0) )
     {
         unsigned long elapsed = wxGetCurrentTime() - m_timeStart;
     }
 
     if ( (m_elapsed || m_remaining || m_estimated) && (value != 0) )
     {
         unsigned long elapsed = wxGetCurrentTime() - m_timeStart;

-        unsigned long estimated = elapsed * m_maximum / value;
+        unsigned long estimated = (unsigned long)(( (double) elapsed * m_maximum ) / ((double)value)) ;

         unsigned long remaining = estimated - elapsed;
 
         SetTimeLabel(elapsed, m_elapsed);
         unsigned long remaining = estimated - elapsed;
 
         SetTimeLabel(elapsed, m_elapsed);


@@ -322,47 +305,78 @@ wxProgressDialog::Update(int value, const wxString& newmsg)
         SetTimeLabel(remaining, m_remaining);
     }
 
         SetTimeLabel(remaining, m_remaining);
     }
 

-    if ( (value == m_maximum ) && !(GetWindowStyle() & wxPD_AUTO_HIDE) )
+    if ( value == m_maximum )

     {
     {

-        if ( m_btnAbort )
+        // so that we return true below and that out [Cancel] handler knew what
+        // to do
+        m_state = Finished;
+        if( !(GetWindowStyle() & wxPD_AUTO_HIDE) )

         {
         {

-            // tell the user what he should do...
-            m_btnAbort->SetLabel(_("Close"));
-        }
+            if ( m_btnAbort )
+            {
+                // tell the user what he should do...
+                m_btnAbort->SetLabel(_("Close"));
+            }

 #if defined(__WXMSW__) && !defined(__WXUNIVERSAL__)
 #if defined(__WXMSW__) && !defined(__WXUNIVERSAL__)

-        else // enable the close button to give the user a way to close the dlg
-        {
-            EnableCloseButton(TRUE);
-        }
+            else // enable the button to give the user a way to close the dlg
+            {
+                EnableCloseButton();
+            }

 #endif // __WXMSW__
 
 #endif // __WXMSW__
 

-        if ( !newmsg )
-        {
-            // also provide the finishing message if the application didn't
-            m_msg->SetLabel(_("Done."));
-        }
+            if ( !newmsg )
+            {
+                // also provide the finishing message if the application didn't
+                m_msg->SetLabel(_("Done."));
+            }

 
 

-        // so that we return TRUE below and that out [Cancel] handler knew what
-        // to do
-        m_state = Finished;
+            wxYieldIfNeeded() ;

 
 

-        wxYield();
+            (void)ShowModal();
+        }
+        else // auto hide
+        {
+            // reenable other windows before hiding this one because otherwise
+            // Windows wouldn't give the focus back to the window which had
+            // been previously focused because it would still be disabled
+            ReenableOtherWindows();

 
 

-        (void)ShowModal();
+            Hide();
+        }

     }
     else
     {
     }
     else
     {

-        // update the display
-        wxYield();
+        // we have to yield because not only we want to update the display but
+        // also to process the clicks on the cancel button
+        wxYieldIfNeeded() ;

     }
 
     }
 

-#ifdef __WXMAC__
-    MacUpdateImmediately();
-#endif
+    // update the display in case yielding above didn't do it
+    Update();

 
     return m_state != Canceled;
 }
 
 
     return m_state != Canceled;
 }
 

+void wxProgressDialog::Resume()
+{
+    m_state = Continue;
+
+    // it may have been disabled by OnCancel(), so enable it back to let the
+    // user interrupt us again if needed
+    m_btnAbort->Enable();
+}
+
+bool wxProgressDialog::Show( bool show )
+{
+    // reenable other windows before hiding this one because otherwise
+    // Windows wouldn't give the focus back to the window which had
+    // been previously focused because it would still be disabled
+    if(!show)
+        ReenableOtherWindows();
+
+    return wxDialog::Show(show);
+}
+

 // ----------------------------------------------------------------------------
 // event handlers
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // event handlers
 // ----------------------------------------------------------------------------


@@ -392,7 +406,7 @@ void wxProgressDialog::OnClose(wxCloseEvent& event)
     if ( m_state == Uncancelable )
     {
         // can't close this dialog
     if ( m_state == Uncancelable )
     {
         // can't close this dialog

-        event.Veto(TRUE);
+        event.Veto();

     }
     else if ( m_state == Finished )
     {
     }
     else if ( m_state == Finished )
     {


@@ -406,16 +420,6 @@ void wxProgressDialog::OnClose(wxCloseEvent& event)
     }
 }
 
     }
 }
 

-void wxProgressDialog::OnShow(wxShowEvent& event)
-{
-    // if the dialog is being hidden, it was closed, so reenable other windows
-    // now
-    if ( event.GetShow() )
-    {
-        ReenableOtherWindows();
-    }
-}
-

 // ----------------------------------------------------------------------------
 // destruction
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // destruction
 // ----------------------------------------------------------------------------


@@ -436,7 +440,7 @@ void wxProgressDialog::ReenableOtherWindows()
     else
     {
         if ( m_parentTop )
     else
     {
         if ( m_parentTop )

-            m_parentTop->Enable(TRUE);
+            m_parentTop->Enable();

     }
 }
 
     }
 }