X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c50f1fb9226d9260454ccb9c8a67d0be23c2827f..e1910715af0629ad65976e87cdeca23ede2fd6ee:/src/generic/progdlgg.cpp

diff --git a/src/generic/progdlgg.cpp b/src/generic/progdlgg.cpp
index cad525d1d3..ee2f457eff 100644
--- a/src/generic/progdlgg.cpp
+++ b/src/generic/progdlgg.cpp
@@ -9,8 +9,16 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+
 #ifdef __GNUG__
-#pragma implementation "progdlgg.h"
+    #pragma implementation "progdlgg.h"
 #endif
 
 // For compilers that support precompilation, includes "wx.h".
@@ -20,6 +28,8 @@
     #pragma hdrstop
 #endif
 
+#if wxUSE_PROGRESSDLG
+
 #ifndef WX_PRECOMP
     #include "wx/utils.h"
     #include "wx/frame.h"
@@ -31,260 +41,454 @@
     #include "wx/intl.h"
     #include "wx/settings.h"
     #include "wx/dcclient.h"
+    #include "wx/timer.h"
 #endif
 
-#if wxUSE_PROGRESSDLG
-
 #include "wx/generic/progdlgg.h"
 
+// ----------------------------------------------------------------------------
+// constants
+// ----------------------------------------------------------------------------
+
 #define LAYOUT_X_MARGIN 8
 #define LAYOUT_Y_MARGIN 8
 
-// wxTextEntryDialog
+// ----------------------------------------------------------------------------
+// private functions
+// ----------------------------------------------------------------------------
 
-#if !USE_SHARED_LIBRARY
-    BEGIN_EVENT_TABLE(wxProgressDialog, wxFrame)
-       EVT_BUTTON(-1, wxProgressDialog::OnCancel)
-       EVT_CLOSE(wxProgressDialog::OnClose)
-    END_EVENT_TABLE()
+// update the label to show the given time (in seconds)
+static void SetTimeLabel(unsigned long val, wxStaticText *label);
 
-    IMPLEMENT_CLASS(wxProgressDialog, wxFrame)
-#endif
+// ----------------------------------------------------------------------------
+// event tables
+// ----------------------------------------------------------------------------
+
+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)
+
+// ============================================================================
+// implementation
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// wxProgressDialog
+// ----------------------------------------------------------------------------
 
 wxProgressDialog::wxProgressDialog(wxString const &title,
-                                 wxString const &message,
-                                 int maximum,
-                                 wxWindow *parent,
-                                 int style)
+                                   wxString const &message,
+                                   int maximum,
+                                   wxWindow *parent,
+                                   int style)
+                : wxDialog(parent, -1, title)
 {
-   wxWindow *lastWindow = NULL;
-   bool hasAbortButton = (style & wxPD_CAN_ABORT) != 0;
-   m_state = hasAbortButton ? Continue : Uncancelable;
-   m_disableParentOnly = (style & wxPD_APP_MODAL) == 0;
-   m_parent = parent;
-   m_maximum = maximum;
-
-   m_elapsed = m_estimated = m_remaining = NULL;
-   if ((style & (wxPD_ELAPSED_TIME | wxPD_ESTIMATED_TIME | wxPD_REMAINING_TIME)) != 0) m_time = new wxTime;
-   else m_time = NULL;
-
-   wxFrame::Create(m_parent, -1, title, wxDefaultPosition,
-                   wxDefaultSize, wxDEFAULT_DIALOG_STYLE);
-   SetBackgroundColour(wxSystemSettings::GetSystemColour(wxSYS_COLOUR_3DFACE));
-
-   wxLayoutConstraints *c;
-
-   wxClientDC dc(this);
-   dc.SetFont(wxSystemSettings::GetSystemFont(wxSYS_DEFAULT_GUI_FONT));
-   long widthText;
-   dc.GetTextExtent(message, &widthText, NULL);
-
-   m_msg = new wxStaticText(this, -1, message);
-   c = new wxLayoutConstraints;
-   c->left.SameAs(this, wxLeft, 10);
-   c->top.SameAs(this, wxTop, 10);
-   c->width.AsIs();
-   c->height.AsIs();
-   m_msg->SetConstraints(c);
-   lastWindow = m_msg;
-
-   if ( maximum > 0 )
-   {
-      m_gauge = new wxGauge(this, -1, maximum,
-                            wxDefaultPosition, wxDefaultSize,
-                            wxGA_HORIZONTAL | wxRAISED_BORDER);
-      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);
-      m_gauge->SetValue(0);
-      lastWindow = m_gauge;
-   }
-   else
-      m_gauge = (wxGauge *)NULL;
-
-   
-   if ( style & wxPD_ELAPSED_TIME )
-   {
-      m_elapsed = new wxStaticText(this, -1, "");
-      c = new wxLayoutConstraints;
-      c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
-      c->top.Below(lastWindow, LAYOUT_Y_MARGIN);
-      c->width.Absolute(60);
-      c->height.AsIs();
-      m_elapsed->SetConstraints(c);
-
-      wxStaticText *dummy = new wxStaticText(this, -1, _T("Elapsed time : "));
-      c = new wxLayoutConstraints;
-      c->right.LeftOf(m_elapsed);
-      c->top.SameAs(m_elapsed, wxTop, 0);
-      c->width.AsIs();
-      c->height.AsIs();
-      dummy->SetConstraints(c);      
-
-      lastWindow = m_elapsed;
-   }
-
-   if ( style & wxPD_ESTIMATED_TIME )
-   {
-      m_estimated = new wxStaticText(this, -1, "");
-      c = new wxLayoutConstraints;
-      c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
-      c->top.Below(lastWindow, 0);
-      c->width.Absolute(60);
-      c->height.AsIs();
-      m_estimated->SetConstraints(c);
-
-      wxStaticText *dummy = new wxStaticText(this, -1, _T("Estimated time : "));
-      c = new wxLayoutConstraints;
-      c->right.LeftOf(m_estimated);
-      c->top.SameAs(m_estimated, wxTop, 0);
-      c->width.AsIs();
-      c->height.AsIs();
-      dummy->SetConstraints(c);      
-
-      lastWindow = m_estimated;
-   }
-
-   if ( style & wxPD_REMAINING_TIME )
-   {
-      m_remaining = new wxStaticText(this, -1, "");
-      c = new wxLayoutConstraints;
-      c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
-      c->top.Below(lastWindow, 0);
-      c->width.Absolute(60);
-      c->height.AsIs();
-      m_remaining->SetConstraints(c);
-
-      wxStaticText *dummy = new wxStaticText(this, -1, _T("Remaining time : "));
-      c = new wxLayoutConstraints;
-      c->right.LeftOf(m_remaining);
-      c->top.SameAs(m_remaining, wxTop, 0);
-      c->width.AsIs();
-      c->height.AsIs();
-      dummy->SetConstraints(c);      
-
-      lastWindow = m_remaining;
-   }
-
-   if ( hasAbortButton )
-   {
-      m_btnAbort = new wxButton(this, -1, _("Cancel"));
-      c = new wxLayoutConstraints;
-      c->centreX.SameAs(this, wxCentreX);
-      c->top.Below(lastWindow, 2*LAYOUT_Y_MARGIN);
-      c->width.AsIs();
-      c->height.AsIs();
-      m_btnAbort->SetConstraints(c);
-   }
-   else
-      m_btnAbort = (wxButton *)NULL;
-
-   SetAutoLayout(TRUE);
-   Layout();
-
-   // calc the height of the dialog
-   Fit();
-   // and set the width from it - unfortunately, Fit() makes the dialog way too
-   // wide under Windows, so try to find a reasonable value for the width, not
-   // too big and not too small
-   wxSize size = GetClientSize();
-   size.x = wxMax(3*widthText/2, 2*size.y);
-   SetClientSize(size);
-
-   Show(TRUE);
-   Centre(wxCENTER_FRAME | wxBOTH);
-
-   if(m_disableParentOnly)
-      m_parent->Enable(FALSE);
-   else
-      wxEnableTopLevelWindows(FALSE);
-
-   Enable(TRUE); // enable this window
-   wxYield();
+    // 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;
+
+#if defined(__WXMSW__) && !defined(__WXUNIVERSAL__)
+    // we have to remove the "Close" button from the title bar then as it is
+    // confusing to have it - it doesn't work anyhow
+    //
+    // FIXME: should probably have a (extended?) window style for this
+    if ( !hasAbortButton )
+    {
+        EnableCloseButton(FALSE);
+    }
+#endif // wxMSW
+
+    m_state = hasAbortButton ? Continue : Uncancelable;
+    m_maximum = maximum;
+
+#ifdef __WXMSW__
+    // 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__
+
+    m_parentTop = parent;
+    while ( m_parentTop && m_parentTop->GetParent() )
+    {
+        m_parentTop = m_parentTop->GetParent();
+    }
+
+    wxLayoutConstraints *c;
+
+    wxClientDC dc(this);
+    dc.SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT));
+    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;
+
+    wxWindow *lastWindow = m_msg;
+
+    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
+        // style argument to wxProgressDialog, perhaps.
+        m_gauge = new wxGauge(this, -1, m_maximum,
+                              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);
+        m_gauge->SetValue(0);
+        lastWindow = m_gauge;
+
+        wxSize sizeGauge = m_gauge->GetSize();
+        sizeDlg.y += 2*LAYOUT_Y_MARGIN + sizeGauge.y;
+    }
+    else
+        m_gauge = (wxGauge *)NULL;
+
+    // create the estimated/remaining/total time zones if requested
+    m_elapsed = m_estimated = m_remaining = (wxStaticText*)NULL;
+
+    // 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++;
+
+        label =
+        m_elapsed = CreateLabel(_("Elapsed time : "), &lastWindow);
+    }
+
+    if ( style & wxPD_ESTIMATED_TIME )
+    {
+        nTimeLabels++;
+
+        label =
+        m_estimated = CreateLabel(_("Estimated time : "), &lastWindow);
+    }
+
+    if ( style & wxPD_REMAINING_TIME )
+    {
+        nTimeLabels++;
+
+        label =
+        m_remaining = CreateLabel(_("Remaining time : "), &lastWindow);
+    }
+
+    if ( nTimeLabels > 0 )
+    {
+        // set it to the current time
+        m_timeStart = wxGetCurrentTime();
+        sizeDlg.y += nTimeLabels * (label->GetSize().y + LAYOUT_Y_MARGIN);
+    }
+
+    if ( hasAbortButton )
+    {
+        m_btnAbort = new wxButton(this, wxID_CANCEL, _("Cancel"));
+        c = new wxLayoutConstraints;
+
+        // Windows dialogs usually have buttons in the lower right corner
+#ifdef __WXMSW__
+        c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
+#else // !MSW
+        c->centreX.SameAs(this, wxCentreX);
+#endif // MSW/!MSW
+        c->bottom.SameAs(this, wxBottom, 2*LAYOUT_Y_MARGIN);
+
+        c->width.AsIs();
+        c->height.AsIs();
+
+        m_btnAbort->SetConstraints(c);
+
+        sizeDlg.y += 2*LAYOUT_Y_MARGIN + wxButton::GetDefaultSize().y;
+    }
+    else // no "Cancel" button
+    {
+        m_btnAbort = (wxButton *)NULL;
+    }
+
+    SetAutoLayout(TRUE);
+    Layout();
+
+    sizeDlg.y += 2*LAYOUT_Y_MARGIN;
+
+    // try to make the dialog not square but rectangular of reasonabel width
+    sizeDlg.x = (wxCoord)wxMax(widthText, 4*sizeDlg.y/3);
+    sizeDlg.x *= 3;
+    sizeDlg.x /= 2;
+    SetClientSize(sizeDlg);
+
+    Centre(wxCENTER_FRAME | wxBOTH);
+
+    if ( style & wxPD_APP_MODAL )
+    {
+        m_winDisabler = new wxWindowDisabler(this);
+    }
+    else
+    {
+        if ( m_parentTop )
+            m_parentTop->Enable(FALSE);
+        m_winDisabler = NULL;
+    }
+
+    Show(TRUE);
+    Enable(TRUE); // enable this window
+
+    // this one can be initialized even if the others are unknown for now
+    //
+    // NB: do it after calling Layout() to keep the labels correctly aligned
+    if ( m_elapsed )
+    {
+        SetTimeLabel(0, m_elapsed);
+    }
+
+    // Update the display (especially on X, GTK)
+    wxYield();
+    wxYield();
+
+#ifdef __WXMAC__
+    MacUpdateImmediately();
+#endif
 }
 
+wxStaticText *wxProgressDialog::CreateLabel(const wxString& text,
+                                            wxWindow **lastWindow)
+{
+    wxLayoutConstraints *c;
+
+    wxStaticText *label = new wxStaticText(this, -1, _("unknown"));
+    c = new wxLayoutConstraints;
+
+    // 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);
+#else // !MSW
+    c->right.SameAs(this, wxRight, 2*LAYOUT_X_MARGIN);
+#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;
+}
 
 bool
 wxProgressDialog::Update(int value, const wxString& newmsg)
 {
-   wxASSERT_MSG( value == -1 || m_gauge, _T("can't update non existent dialog") );
-   wxASSERT_MSG( value < m_maximum, _T("invalid progress value") );
-
-
-   if( m_gauge )
-      m_gauge->SetValue(value + 1);
-
-   if( !newmsg.IsEmpty() )
-      m_msg->SetLabel(newmsg);
-
-   if ( (m_elapsed || m_remaining || m_estimated) && (value != 0) )
-   {
-      wxTime timenow;
-      wxTime diff = timenow -  *m_time;
-      unsigned long secs = diff.GetSecond() + 60 * diff.GetMinute() + 60 * 60 * diff.GetHour();
-      unsigned long estim = secs * m_maximum / value; 
-      unsigned long remai = estim - secs; 
-      wxString s;
-
-      if (m_elapsed) 
-      {
-         s.Printf("%i:%02i:%02i", diff.GetHour(), diff.GetMinute(), diff.GetSecond());
-         if (s != m_elapsed->GetLabel()) m_elapsed->SetLabel(s);
-      }
-      if (m_estimated) 
-      {
-         s.Printf("%i:%02i:%02i", estim / (60 * 60), (estim / 60) % 60, estim % 60);
-         if (s != m_estimated->GetLabel()) m_estimated->SetLabel(s);
-      }
-      if (m_remaining) 
-      {
-         s.Printf("%i:%02i:%02i", remai / (60 * 60), (remai / 60) % 60, remai % 60);
-         if (s != m_remaining->GetLabel()) m_remaining->SetLabel(s);
-      }
-   }
-
-   if ( (value == m_maximum - 1) && !(GetWindowStyleFlag() & wxPD_AUTO_HIDE) )
-   {
-       if ( m_btnAbort )
-       {
-           // tell the user what he should do...
-           m_btnAbort->SetLabel(_("Close"));
-       }
-
-       if ( !newmsg )
-       {
-           // also provide the finishing message if the application didn't
-           m_msg->SetLabel(_("Done."));
-       }
-
-       m_state = Finished;
-
-       // so that we return TRUE below
-       m_state = Finished;
-   }
-
-   return m_state != Canceled;
+    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") );
+
+    if ( m_gauge )
+    {
+        m_gauge->SetValue(value + 1);
+    }
+
+    if ( !newmsg.IsEmpty() )
+    {
+        m_msg->SetLabel(newmsg);
+
+        wxYield();
+        wxYield();
+    }
+
+    if ( (m_elapsed || m_remaining || m_estimated) && (value != 0) )
+    {
+        unsigned long elapsed = wxGetCurrentTime() - m_timeStart;
+        unsigned long estimated = elapsed * m_maximum / value;
+        unsigned long remaining = estimated - elapsed;
+
+        SetTimeLabel(elapsed, m_elapsed);
+        SetTimeLabel(estimated, m_estimated);
+        SetTimeLabel(remaining, m_remaining);
+    }
+
+    if ( (value == m_maximum ) )
+    {
+        // so that we return TRUE below and that out [Cancel] handler knew what
+        // to do
+        m_state = Finished;
+        if( !(GetWindowStyle() & wxPD_AUTO_HIDE) )
+        {
+            if ( m_btnAbort )
+            {
+                // tell the user what he should do...
+                m_btnAbort->SetLabel(_("Close"));
+            }
+#if defined(__WXMSW__) && !defined(__WXUNIVERSAL__)
+            else // enable the close button to give the user a way to close the dlg
+            {
+                EnableCloseButton(TRUE);
+            }
+#endif // __WXMSW__
+
+            if ( !newmsg )
+            {
+                // also provide the finishing message if the application didn't
+                m_msg->SetLabel(_("Done."));
+            }
+
+            wxYield();
+            wxYield();
+
+            (void)ShowModal();
+        }
+        else
+        {
+            Hide();
+            ReenableOtherWindows();
+        }
+    }
+    else
+    {
+        // update the display
+        wxYield();
+        wxYield();
+    }
+
+#ifdef __WXMAC__
+    MacUpdateImmediately();
+#endif
+
+    return m_state != Canceled;
+}
+
+// ----------------------------------------------------------------------------
+// event handlers
+// ----------------------------------------------------------------------------
+
+void wxProgressDialog::OnCancel(wxCommandEvent& event)
+{
+    if ( m_state == Finished )
+    {
+        // this means that the count down is already finished and we're being
+        // shown as a modal dialog - so just let the default handler do the job
+        event.Skip();
+    }
+    else
+    {
+        // request to cancel was received, the next time Update() is called we
+        // will handle it
+        m_state = Canceled;
+
+        // update the button state immediately so that the user knows that the
+        // request has been noticed
+        m_btnAbort->Disable();
+    }
 }
 
 void wxProgressDialog::OnClose(wxCloseEvent& event)
 {
-   if ( m_state == Uncancelable )
-      event.Veto(TRUE);
-   else
-      m_state = Canceled;
+    if ( m_state == Uncancelable )
+    {
+        // can't close this dialog
+        event.Veto(TRUE);
+    }
+    else if ( m_state == Finished )
+    {
+        // let the default handler close the window as we already terminated
+        event.Skip();
+    }
+    else
+    {
+        // next Update() will notice it
+        m_state = Canceled;
+    }
+}
+
+void wxProgressDialog::OnShow(wxShowEvent& event)
+{
+    // if the dialog is being hidden, it was closed, so reenable other windows
+    // now
+    if ( event.GetShow() )
+    {
+        ReenableOtherWindows();
+    }
 }
 
+// ----------------------------------------------------------------------------
+// destruction
+// ----------------------------------------------------------------------------
 
 wxProgressDialog::~wxProgressDialog()
 {
-   if ( m_disableParentOnly )
-      m_parent->Enable(TRUE);
-   else
-      wxEnableTopLevelWindows(TRUE);
-   if (m_time) delete m_time;
+    // normally this should have been already done, but just in case
+    ReenableOtherWindows();
 }
 
-#endif
+void wxProgressDialog::ReenableOtherWindows()
+{
+    if ( GetWindowStyle() & wxPD_APP_MODAL )
+    {
+        delete m_winDisabler;
+        m_winDisabler = (wxWindowDisabler *)NULL;
+    }
+    else
+    {
+        if ( m_parentTop )
+            m_parentTop->Enable(TRUE);
+    }
+}
+
+// ----------------------------------------------------------------------------
+// private functions
+// ----------------------------------------------------------------------------
+
+static void SetTimeLabel(unsigned long val, wxStaticText *label)
+{
+    if ( label )
+    {
+        wxString s;
+        unsigned long hours = val / 3600;
+        unsigned long minutes = (val % 3600) / 60;
+        unsigned long seconds = val % 60;
+        s.Printf(wxT("%lu:%02lu:%02lu"), hours, minutes, seconds);
+
+        if ( s != label->GetLabel() )
+            label->SetLabel(s);
+    }
+}
+
+#endif // wxUSE_PROGRESSDLG