Include wx/timer.h according to precompiled headers of wx/wx.h (with other minor...

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

diff --git a/src/generic/progdlgg.cpp b/src/generic/progdlgg.cpp
index 0103124fac6c85a5642071f27ba4cc5e6b17808c..c261d63be45df5eac446c180fa214d1935fdad83 100644 (file)
--- a/src/generic/progdlgg.cpp
+++ b/src/generic/progdlgg.cpp
@@ -17,10 +17,6 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma implementation "progdlgg.h"
-#endif
-

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -39,18 +35,34 @@
     #include "wx/event.h"
     #include "wx/gauge.h"
     #include "wx/intl.h"
     #include "wx/event.h"
     #include "wx/gauge.h"
     #include "wx/intl.h"

-    #include "wx/settings.h"

     #include "wx/dcclient.h"
     #include "wx/timer.h"
 #endif
 
 #include "wx/generic/progdlgg.h"
     #include "wx/dcclient.h"
     #include "wx/timer.h"
 #endif
 
 #include "wx/generic/progdlgg.h"

+#include "wx/settings.h"
+
+// ---------------------------------------------------------------------------
+// macros
+// ---------------------------------------------------------------------------
+
+/* Macro for avoiding #ifdefs when value have to be different depending on size of
+   device we display on - take it from something like wxDesktopPolicy in the future
+ */
+
+#if defined(__SMARTPHONE__)
+    #define wxLARGESMALL(large,small) small
+#else
+    #define wxLARGESMALL(large,small) large
+#endif

 
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 

-#define LAYOUT_MARGIN 8
+#define LAYOUT_MARGIN wxLARGESMALL(8,2)
+
+static const int wxID_SKIP = 32000;  // whatever

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


@@ -65,6 +77,7 @@ 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_BUTTON(wxID_SKIP, wxProgressDialog::OnSkip)

 
     EVT_CLOSE(wxProgressDialog::OnClose)
 END_EVENT_TABLE()
 
     EVT_CLOSE(wxProgressDialog::OnClose)
 END_EVENT_TABLE()


@@ -84,27 +97,37 @@ wxProgressDialog::wxProgressDialog(wxString const &title,
                                    int maximum,
                                    wxWindow *parent,
                                    int style)
                                    int maximum,
                                    wxWindow *parent,
                                    int style)

-                : wxDialog(parent, wxID_ANY, title)
+                : wxDialog(parent, wxID_ANY, title),
+                  m_skip(false),
+                  m_delay(3),
+                  m_hasAbortButton(false),
+                  m_hasSkipButton(false)

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

-

     m_windowStyle |= style;
 
     m_windowStyle |= style;
 

-    bool hasAbortButton = (style & wxPD_CAN_ABORT) != 0;
+    m_hasAbortButton = (style & wxPD_CAN_ABORT) != 0;
+    m_hasSkipButton = (style & wxPD_CAN_SKIP) != 0;
+
+    bool isPda = (wxSystemSettings::GetScreenType() <= wxSYS_SCREEN_PDA);

 
 #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 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 )
+    if ( !m_hasAbortButton )

     {
         EnableCloseButton(false);
     }
 #endif // wxMSW
 
     {
         EnableCloseButton(false);
     }
 #endif // wxMSW
 

-    m_state = hasAbortButton ? Continue : Uncancelable;
+#if defined(__SMARTPHONE__)
+    SetLeftMenu();
+#endif
+
+    m_state = m_hasAbortButton ? Continue : Uncancelable;

     m_maximum = maximum;
 
 #if defined(__WXMSW__) || defined(__WXPM__)
     m_maximum = maximum;
 
 #if defined(__WXMSW__) || defined(__WXPM__)


@@ -118,11 +141,11 @@ wxProgressDialog::wxProgressDialog(wxString const &title,
 
     wxClientDC dc(this);
     dc.SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT));
 
     wxClientDC dc(this);
     dc.SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT));

-    long widthText;
+    long widthText = 0;

     dc.GetTextExtent(message, &widthText, NULL, NULL, NULL, NULL);
 
     wxBoxSizer *sizer = new wxBoxSizer(wxVERTICAL);
     dc.GetTextExtent(message, &widthText, NULL, NULL, NULL, NULL);
 
     wxBoxSizer *sizer = new wxBoxSizer(wxVERTICAL);

-       
+

     m_msg = new wxStaticText(this, wxID_ANY, message);
     sizer->Add(m_msg, 0, wxLEFT | wxTOP, 2*LAYOUT_MARGIN);
 
     m_msg = new wxStaticText(this, wxID_ANY, message);
     sizer->Add(m_msg, 0, wxLEFT | wxTOP, 2*LAYOUT_MARGIN);
 


@@ -132,12 +155,12 @@ wxProgressDialog::wxProgressDialog(wxString const &title,
 
     if ( maximum > 0 )
     {
 
     if ( maximum > 0 )
     {

-        // 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.
+        int gauge_style = wxGA_HORIZONTAL;
+        if ( ( style & wxPD_SMOOTH ) == wxPD_SMOOTH )
+            gauge_style |= wxGA_SMOOTH;

         m_gauge = new wxGauge(this, wxID_ANY, m_maximum,
                               wxDefaultPosition, wxDefaultSize,
         m_gauge = new wxGauge(this, wxID_ANY, m_maximum,
                               wxDefaultPosition, wxDefaultSize,

-                              wxGA_HORIZONTAL);
+                              gauge_style );

 
         sizer->Add(m_gauge, 0, wxLEFT | wxRIGHT | wxTOP | wxEXPAND, 2*LAYOUT_MARGIN);
         m_gauge->SetValue(0);
 
         sizer->Add(m_gauge, 0, wxLEFT | wxRIGHT | wxTOP | wxEXPAND, 2*LAYOUT_MARGIN);
         m_gauge->SetValue(0);


@@ -150,6 +173,8 @@ 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;

+    m_display_estimated = m_last_timeupdate = m_break = 0;
+    m_ctdelay = 0;

 
     // if we are going to have at least one label, remmeber it in this var
     wxStaticText *label = NULL;
 
     // if we are going to have at least one label, remmeber it in this var
     wxStaticText *label = NULL;


@@ -188,32 +213,59 @@ wxProgressDialog::wxProgressDialog(wxString const &title,
         sizeDlg.y += nTimeLabels * (label->GetSize().y + LAYOUT_MARGIN);
     }
 
         sizeDlg.y += nTimeLabels * (label->GetSize().y + LAYOUT_MARGIN);
     }
 

-    if ( hasAbortButton )
-    {
-        m_btnAbort = new wxButton(this, wxID_CANCEL);
-
-        // Windows dialogs usually have buttons in the lower right corner
+#if defined(__SMARTPHONE__)
+    if ( m_hasSkipButton )
+        SetRightMenu(wxID_SKIP, _("Skip"));
+    if ( m_hasAbortButton )
+        SetLeftMenu(wxID_CANCEL);
+#else
+    m_btnAbort = m_btnSkip = (wxButton *)NULL;
+    bool sizeDlgModified = false;
+    wxBoxSizer *buttonSizer = new wxBoxSizer(wxHORIZONTAL);
+
+    const int sizerFlags =

 #if defined(__WXMSW__) || defined(__WXPM__)
 #if defined(__WXMSW__) || defined(__WXPM__)

-        sizer->Add(m_btnAbort, 0, wxALIGN_RIGHT | wxALL, 2*LAYOUT_MARGIN);
+                           wxALIGN_RIGHT | wxALL

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

-        sizer->Add(m_btnAbort, 0, wxALIGN_CENTER_HORIZONTAL | wxBOTTOM | wxTOP, 2*LAYOUT_MARGIN);
+                           wxALIGN_CENTER_HORIZONTAL | wxBOTTOM | wxTOP

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

+                           ;
+
+    if ( m_hasSkipButton )
+    {
+        m_btnSkip = new wxButton(this, wxID_SKIP, _("Skip"));
+
+        // Windows dialogs usually have buttons in the lower right corner
+        buttonSizer->Add(m_btnSkip, 0, sizerFlags, LAYOUT_MARGIN);

         sizeDlg.y += 2*LAYOUT_MARGIN + wxButton::GetDefaultSize().y;
         sizeDlg.y += 2*LAYOUT_MARGIN + wxButton::GetDefaultSize().y;

+        sizeDlgModified = true;

     }
     }

-    else // no "Cancel" button
+
+    if ( m_hasAbortButton )

     {
     {

-        m_btnAbort = (wxButton *)NULL;
+        m_btnAbort = new wxButton(this, wxID_CANCEL);
+
+        // Windows dialogs usually have buttons in the lower right corner
+        buttonSizer->Add(m_btnAbort, 0, sizerFlags, LAYOUT_MARGIN);
+        if(!sizeDlgModified)
+            sizeDlg.y += 2*LAYOUT_MARGIN + wxButton::GetDefaultSize().y;

     }
 
     }
 

+    sizer->Add(buttonSizer, 0, sizerFlags, LAYOUT_MARGIN );
+#endif // __SMARTPHONE__/!__SMARTPHONE__
+

     SetSizerAndFit(sizer);
 
     SetSizerAndFit(sizer);
 

-    sizeDlg.y += 2*LAYOUT_MARGIN;
+    if (!isPda)
+    {
+        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);
-    sizeDlg.x *= 3;
-    sizeDlg.x /= 2;
-    SetClientSize(sizeDlg);
+        // try to make the dialog not square but rectangular of reasonable width
+        sizeDlg.x = (wxCoord)wxMax(widthText, 4*sizeDlg.y/3);
+        sizeDlg.x *= 3;
+        sizeDlg.x /= 2;
+        SetClientSize(sizeDlg);
+    }

 
     Centre(wxCENTER_FRAME | wxBOTH);
 
 
     Centre(wxCENTER_FRAME | wxBOTH);
 


@@ -245,22 +297,28 @@ wxProgressDialog::wxProgressDialog(wxString const &title,
 wxStaticText *wxProgressDialog::CreateLabel(const wxString& text,
                                             wxSizer *sizer)
 {
 wxStaticText *wxProgressDialog::CreateLabel(const wxString& text,
                                             wxSizer *sizer)
 {

-    wxBoxSizer *locsizer = new wxBoxSizer(wxHORIZONTAL);
+    wxBoxSizer *locsizer = new wxBoxSizer(wxLARGESMALL(wxHORIZONTAL,wxVERTICAL));

 
 

-    wxStaticText *dummy = new wxStaticText(this, -1, text);
+    wxStaticText *dummy = new wxStaticText(this, wxID_ANY, text);

     wxStaticText *label = new wxStaticText(this, wxID_ANY, _("unknown"));
 
     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
-#if defined(__WXMSW__) || defined(__WXPM__) || defined(__WXMAC__)
-    locsizer->Add(dummy, 1, wxALIGN_RIGHT);
+    // select placement most native or nice on target GUI
+#if defined(__SMARTPHONE__)
+    // label and time to the left in two rows
+    locsizer->Add(dummy, 1, wxALIGN_LEFT);
+    locsizer->Add(label, 1, wxALIGN_LEFT);
+    sizer->Add(locsizer, 0, wxALIGN_LEFT | wxTOP | wxLEFT, LAYOUT_MARGIN);
+#elif defined(__WXMSW__) || defined(__WXPM__) || defined(__WXMAC__)
+    // label and time centered in one row
+    locsizer->Add(dummy, 1, wxLARGESMALL(wxALIGN_RIGHT,wxALIGN_LEFT));

     locsizer->Add(label, 1, wxALIGN_LEFT | wxLEFT, LAYOUT_MARGIN);
     sizer->Add(locsizer, 0, wxALIGN_CENTER_HORIZONTAL | wxTOP, LAYOUT_MARGIN);
     locsizer->Add(label, 1, wxALIGN_LEFT | wxLEFT, LAYOUT_MARGIN);
     sizer->Add(locsizer, 0, wxALIGN_CENTER_HORIZONTAL | wxTOP, LAYOUT_MARGIN);

-#else // !MSW
+#else
+    // label and time to the right in one row

     sizer->Add(locsizer, 0, wxALIGN_RIGHT | wxRIGHT | wxTOP, LAYOUT_MARGIN);
     locsizer->Add(dummy);
     locsizer->Add(label, 0, wxLEFT, LAYOUT_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

 
     return label;
 }
 
     return label;
 }


@@ -270,7 +328,7 @@ wxStaticText *wxProgressDialog::CreateLabel(const wxString& text,
 // ----------------------------------------------------------------------------
 
 bool
 // ----------------------------------------------------------------------------
 
 bool

-wxProgressDialog::Update(int value, const wxString& newmsg)
+wxProgressDialog::Update(int value, const wxString& newmsg, bool *skip)

 {
     wxASSERT_MSG( value == -1 || m_gauge, wxT("cannot update non existent dialog") );
 
 {
     wxASSERT_MSG( value == -1 || m_gauge, wxT("cannot update non existent dialog") );
 


@@ -287,7 +345,7 @@ wxProgressDialog::Update(int value, const wxString& newmsg)
         m_gauge->SetValue(value == m_maximum ? value : value + 1);
     }
 
         m_gauge->SetValue(value == m_maximum ? value : value + 1);
     }
 

-    if ( !newmsg.IsEmpty() )
+    if ( !newmsg.empty() && newmsg != m_msg->GetLabel() )

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


@@ -297,34 +355,75 @@ wxProgressDialog::Update(int value, const wxString& newmsg)
     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 = (unsigned long)(( (double) elapsed * m_maximum ) / ((double)value)) ;
-        unsigned long remaining = estimated - elapsed;
+        if (    m_last_timeupdate < elapsed
+             || value == m_maximum
+           )
+        {
+            m_last_timeupdate = elapsed;
+            unsigned long estimated = m_break +
+                  (unsigned long)(( (double) (elapsed-m_break) * m_maximum ) / ((double)value)) ;
+            if (    estimated > m_display_estimated
+                 && m_ctdelay >= 0
+               )
+            {
+                ++m_ctdelay;
+            }
+            else if (    estimated < m_display_estimated
+                      && m_ctdelay <= 0
+                    )
+            {
+                --m_ctdelay;
+            }
+            else
+            {
+                m_ctdelay = 0;
+            }
+            if (    m_ctdelay >= m_delay          // enough confirmations for a higher value
+                 || m_ctdelay <= (m_delay*-1)     // enough confirmations for a lower value
+                 || value == m_maximum            // to stay consistent
+                 || elapsed > m_display_estimated // to stay consistent
+                 || ( elapsed > 0 && elapsed < 4 ) // additional updates in the beginning
+               )
+            {
+                m_display_estimated = estimated;
+                m_ctdelay = 0;
+            }
+        }
+
+        long display_remaining = m_display_estimated - elapsed;
+        if ( display_remaining < 0 )
+        {
+            display_remaining = 0;
+        }

 
         SetTimeLabel(elapsed, m_elapsed);
 
         SetTimeLabel(elapsed, m_elapsed);

-        SetTimeLabel(estimated, m_estimated);
-        SetTimeLabel(remaining, m_remaining);
+        SetTimeLabel(m_display_estimated, m_estimated);
+        SetTimeLabel(display_remaining, m_remaining);

     }
 
     if ( value == m_maximum )
     {
     }
 
     if ( value == m_maximum )
     {

+        if ( m_state == Finished )
+        {
+            // ignore multiple calls to Update(m_maximum): it may sometimes be
+            // troublesome to ensure that Update() is not called twice with the
+            // same value (e.g. because of the rounding errors) and if we don't
+            // return now we're going to generate asserts below
+            return true;
+        }
+

         // so that we return true below and that out [Cancel] handler knew what
         // to do
         m_state = Finished;
         if( !(GetWindowStyle() & wxPD_AUTO_HIDE) )
         {
         // 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"));
-            }
+            EnableClose();
+            DisableSkip();

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

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

 #endif // __WXMSW__
 
 #endif // __WXMSW__
 

-            if ( !newmsg )
+            if ( newmsg.empty() )

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


@@ -347,8 +446,15 @@ wxProgressDialog::Update(int value, const wxString& newmsg)
     else
     {
         // we have to yield because not only we want to update the display but
     else
     {
         // we have to yield because not only we want to update the display but

-        // also to process the clicks on the cancel button
+        // also to process the clicks on the cancel and skip buttons

         wxYieldIfNeeded() ;
         wxYieldIfNeeded() ;

+
+        if ( (m_skip) && (skip != NULL) && (*skip == false) )
+        {
+            *skip = true;
+            m_skip = false;
+            EnableSkip();
+        }

     }
 
     // update the display in case yielding above didn't do it
     }
 
     // update the display in case yielding above didn't do it


@@ -360,10 +466,12 @@ wxProgressDialog::Update(int value, const wxString& newmsg)
 void wxProgressDialog::Resume()
 {
     m_state = Continue;
 void wxProgressDialog::Resume()
 {
     m_state = Continue;

+    m_ctdelay = m_delay; // force an update of the elapsed/estimated/remaining time
+    m_break += wxGetCurrentTime()-m_timeStop;

 
 

-    // it may have been disabled by OnCancel(), so enable it back to let the
-    // user interrupt us again if needed
-    m_btnAbort->Enable();
+    EnableAbort();
+    EnableSkip();
+    m_skip = false;

 }
 
 bool wxProgressDialog::Show( bool show )
 }
 
 bool wxProgressDialog::Show( bool show )


@@ -395,12 +503,22 @@ void wxProgressDialog::OnCancel(wxCommandEvent& event)
         // will handle it
         m_state = Canceled;
 
         // will handle it
         m_state = Canceled;
 

-        // update the button state immediately so that the user knows that the
+        // update the buttons state immediately so that the user knows that the

         // request has been noticed
         // request has been noticed

-        m_btnAbort->Disable();
+        DisableAbort();
+        DisableSkip();
+
+        // save the time when the dialog was stopped
+        m_timeStop = wxGetCurrentTime();

     }
 }
 
     }
 }
 

+void wxProgressDialog::OnSkip(wxCommandEvent& WXUNUSED(event))
+{
+    DisableSkip();
+    m_skip = true;
+}
+

 void wxProgressDialog::OnClose(wxCloseEvent& event)
 {
     if ( m_state == Uncancelable )
 void wxProgressDialog::OnClose(wxCloseEvent& event)
 {
     if ( m_state == Uncancelable )


@@ -417,6 +535,10 @@ void wxProgressDialog::OnClose(wxCloseEvent& event)
     {
         // next Update() will notice it
         m_state = Canceled;
     {
         // next Update() will notice it
         m_state = Canceled;

+        DisableAbort();
+        DisableSkip();
+
+        m_timeStop = wxGetCurrentTime();

     }
 }
 
     }
 }
 


@@ -463,4 +585,52 @@ static void SetTimeLabel(unsigned long val, wxStaticText *label)
     }
 }
 
     }
 }
 

+void wxProgressDialog::EnableSkip(bool enable)
+{
+    if(m_hasSkipButton)
+    {
+#ifdef __SMARTPHONE__
+        if(enable)
+            SetRightMenu(wxID_SKIP, _("Skip"));
+        else
+            SetRightMenu();
+#else
+        if(m_btnSkip)
+            m_btnSkip->Enable(enable);
+#endif
+    }
+}
+
+void wxProgressDialog::EnableAbort(bool enable)
+{
+    if(m_hasAbortButton)
+    {
+#ifdef __SMARTPHONE__
+        if(enable)
+            SetLeftMenu(wxID_CANCEL); // stock buttons makes Cancel label
+        else
+            SetLeftMenu();
+#else
+        if(m_btnAbort)
+            m_btnAbort->Enable(enable);
+#endif
+    }
+}
+
+void wxProgressDialog::EnableClose()
+{
+    if(m_hasAbortButton)
+    {
+#ifdef __SMARTPHONE__
+        SetLeftMenu(wxID_CANCEL, _("Close"));
+#else
+        if(m_btnAbort)
+        {
+            m_btnAbort->Enable();
+            m_btnAbort->SetLabel(_("Close"));
+        }
+#endif
+    }
+}
+

 #endif // wxUSE_PROGRESSDLG
 #endif // wxUSE_PROGRESSDLG