document that SetValue() accepts values in 0..GetRange interval, inclusive

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

diff --git a/src/generic/progdlgg.cpp b/src/generic/progdlgg.cpp
index c261d63be45df5eac446c180fa214d1935fdad83..b6e89e568b1b2bcd23a17383ea2c3408756c90f7 100644 (file)
--- a/src/generic/progdlgg.cpp
+++ b/src/generic/progdlgg.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        progdlgg.h
+// Name:        src/generic/progdlgg.cpp

 // Purpose:     wxProgressDialog class
 // Author:      Karsten Ballüder
 // Modified by:
 // Purpose:     wxProgressDialog class
 // Author:      Karsten Ballüder
 // Modified by:


@@ -37,10 +37,10 @@
     #include "wx/intl.h"
     #include "wx/dcclient.h"
     #include "wx/timer.h"
     #include "wx/intl.h"
     #include "wx/dcclient.h"
     #include "wx/timer.h"

+    #include "wx/settings.h"

 #endif
 
 #endif
 

-#include "wx/generic/progdlgg.h"
-#include "wx/settings.h"
+#include "wx/progdlg.h"

 
 // ---------------------------------------------------------------------------
 // macros
 
 // ---------------------------------------------------------------------------
 // macros


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

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

                   m_skip(false),
                   m_delay(3),
                   m_hasAbortButton(false),
                   m_skip(false),
                   m_delay(3),
                   m_hasAbortButton(false),


@@ -141,7 +141,7 @@ 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 = 0;
+    wxCoord 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);


@@ -261,7 +261,7 @@ wxProgressDialog::wxProgressDialog(wxString const &title,
         sizeDlg.y += 2*LAYOUT_MARGIN;
 
         // try to make the dialog not square but rectangular of reasonable width
         sizeDlg.y += 2*LAYOUT_MARGIN;
 
         // try to make the dialog not square but rectangular of reasonable width

-        sizeDlg.x = (wxCoord)wxMax(widthText, 4*sizeDlg.y/3);
+        sizeDlg.x = (wxCoord)wxMax(widthText*2, 4*sizeDlg.y/3);

         sizeDlg.x *= 3;
         sizeDlg.x /= 2;
         SetClientSize(sizeDlg);
         sizeDlg.x *= 3;
         sizeDlg.x /= 2;
         SetClientSize(sizeDlg);


@@ -308,7 +308,7 @@ wxStaticText *wxProgressDialog::CreateLabel(const wxString& text,
     locsizer->Add(dummy, 1, wxALIGN_LEFT);
     locsizer->Add(label, 1, wxALIGN_LEFT);
     sizer->Add(locsizer, 0, wxALIGN_LEFT | wxTOP | wxLEFT, LAYOUT_MARGIN);
     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__)
+#elif defined(__WXMSW__) || defined(__WXPM__) || defined(__WXMAC__) || defined(__WXGTK20__)

     // 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);
     // 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);


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

-    if ( !newmsg.empty() && newmsg != m_msg->GetLabel() )
-    {
-        m_msg->SetLabel(newmsg);
-
-        wxYieldIfNeeded() ;
-    }
+    UpdateMessage(newmsg);

 
     if ( (m_elapsed || m_remaining || m_estimated) && (value != 0) )
     {
 
     if ( (m_elapsed || m_remaining || m_estimated) && (value != 0) )
     {


@@ -443,18 +438,9 @@ wxProgressDialog::Update(int value, const wxString& newmsg, bool *skip)
             Hide();
         }
     }
             Hide();
         }
     }

-    else
+    else // not at maximum yet

     {
     {

-        // we have to yield because not only we want to update the display but
-        // also to process the clicks on the cancel and skip buttons
-        wxYieldIfNeeded() ;
-
-        if ( (m_skip) && (skip != NULL) && (*skip == false) )
-        {
-            *skip = true;
-            m_skip = false;
-            EnableSkip();
-        }
+        return DoAfterUpdate(skip);

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


@@ -463,6 +449,45 @@ wxProgressDialog::Update(int value, const wxString& newmsg, bool *skip)
     return m_state != Canceled;
 }
 
     return m_state != Canceled;
 }
 

+bool wxProgressDialog::Pulse(const wxString& newmsg, bool *skip)
+{
+    wxASSERT_MSG( m_gauge, wxT("cannot update non existent dialog") );
+
+    // show a bit of progress
+    m_gauge->Pulse();
+
+    UpdateMessage(newmsg);
+
+    if (m_elapsed || m_remaining || m_estimated)
+    {
+        unsigned long elapsed = wxGetCurrentTime() - m_timeStart;
+
+        SetTimeLabel(elapsed, m_elapsed);
+        SetTimeLabel((unsigned long)-1, m_estimated);
+        SetTimeLabel((unsigned long)-1, m_remaining);
+    }
+
+    return DoAfterUpdate(skip);
+}
+
+bool wxProgressDialog::DoAfterUpdate(bool *skip)
+{
+    // we have to yield because not only we want to update the display but
+    // also to process the clicks on the cancel and skip buttons
+    wxYieldIfNeeded();
+
+    Update();
+
+    if ( m_skip && skip && !*skip )
+    {
+        *skip = true;
+        m_skip = false;
+        EnableSkip();
+    }
+
+    return m_state != Canceled;
+}
+

 void wxProgressDialog::Resume()
 {
     m_state = Continue;
 void wxProgressDialog::Resume()
 {
     m_state = Continue;


@@ -575,10 +600,18 @@ static void SetTimeLabel(unsigned long val, wxStaticText *label)
     if ( label )
     {
         wxString s;
     if ( label )
     {
         wxString s;

+
+        if (val != (unsigned long)-1)
+        {

         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);
         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);

+        }
+        else
+        {
+            s = _("Unknown");
+        }

 
         if ( s != label->GetLabel() )
             label->SetLabel(s);
 
         if ( s != label->GetLabel() )
             label->SetLabel(s);


@@ -633,4 +666,14 @@ void wxProgressDialog::EnableClose()
     }
 }
 
     }
 }
 

+void wxProgressDialog::UpdateMessage(const wxString &newmsg)
+{
+    if ( !newmsg.empty() && newmsg != m_msg->GetLabel() )
+    {
+        m_msg->SetLabel(newmsg);
+
+        wxYieldIfNeeded() ;
+    }
+}
+

 #endif // wxUSE_PROGRESSDLG
 #endif // wxUSE_PROGRESSDLG