From 2de77c6a543caf44069b275dd154d4fc692ad29d Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Fri, 10 Sep 2010 17:25:58 +0000 Subject: [PATCH] Fix errors in handling of maximum field in wxGenericProgressDialog. Provide a SetMaximum() function for setting just m_maximum and return its value from GetRange() instead of using m_gauge->GetRange() which doesn't work when the native MSW version is used nor when the range is > USHRT_MAX under MSW in any case. More generally, this should fix a lot of bugs for progress dialogs using such range as the values were not interpreted correctly in many places. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@65506 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- include/wx/generic/progdlgg.h | 10 +++- src/generic/progdlgg.cpp | 108 +++++++++++++++++----------------- src/msw/progdlg.cpp | 12 +++- 3 files changed, 70 insertions(+), 60 deletions(-) diff --git a/include/wx/generic/progdlgg.h b/include/wx/generic/progdlgg.h index a58ee786b2..9c957e7ebf 100644 --- a/include/wx/generic/progdlgg.h +++ b/include/wx/generic/progdlgg.h @@ -67,7 +67,7 @@ public: protected: // This ctor is used by the native MSW implementation only. - wxGenericProgressDialog(wxWindow *parent, int maximum, int style); + wxGenericProgressDialog(wxWindow *parent, int style); void Create(const wxString& title, const wxString& message, @@ -75,6 +75,12 @@ protected: wxWindow *parent, int style); + // Update just the m_maximum field, this is used by public SetRange() but, + // unlike it, doesn't update the controls state. This makes it useful for + // both this class and its derived classes that don't use m_gauge to + // display progress. + void SetMaximum(int maximum); + // Return the labels to use for showing the elapsed/estimated/remaining // times respectively. static wxString GetElapsedLabel() { return _("Elapsed time:"); } @@ -144,7 +150,7 @@ private: static void SetTimeLabel(unsigned long val, wxStaticText *label); // common part of all ctors - void Init(wxWindow *parent, int maximum, int style); + void Init(wxWindow *parent, int style); // create the label with given text and another one to show the time nearby // as the next windows in the sizer, returns the created control diff --git a/src/generic/progdlgg.cpp b/src/generic/progdlgg.cpp index 391942015c..b1bb1c6e3e 100644 --- a/src/generic/progdlgg.cpp +++ b/src/generic/progdlgg.cpp @@ -87,29 +87,26 @@ wxIMPLEMENT_CLASS(wxProgressDialog, wxDialog) // wxGenericProgressDialog creation // ---------------------------------------------------------------------------- -void wxGenericProgressDialog::Init(wxWindow *parent, int maximum, int style) +void wxGenericProgressDialog::Init(wxWindow *parent, int style) { - // Initialize the inherited members that we always use (even when we don't - // create a valid window here). - // we may disappear at any moment, let the others know about it SetExtraStyle(GetExtraStyle() | wxWS_EX_TRANSIENT); + + // Initialize all our members that we always use (even when we don't + // create a valid window in this class). + m_pdStyle = style; m_parentTop = wxGetTopLevelParent(parent); + m_gauge = NULL; + m_msg = NULL; + m_elapsed = + m_estimated = + m_remaining = NULL; - // Initialize our own members. m_state = Uncancelable; - m_maximum = maximum; - -#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__ - + m_maximum = 0; m_timeStart = wxGetCurrentTime(); m_timeStop = (unsigned long)-1; @@ -127,12 +124,10 @@ void wxGenericProgressDialog::Init(wxWindow *parent, int maximum, int style) m_tempEventLoop = NULL; } -wxGenericProgressDialog::wxGenericProgressDialog(wxWindow *parent, - int maximum, - int style) +wxGenericProgressDialog::wxGenericProgressDialog(wxWindow *parent, int style) : wxDialog() { - Init(parent, maximum, style); + Init(parent, style); } wxGenericProgressDialog::wxGenericProgressDialog(const wxString& title, @@ -142,7 +137,7 @@ wxGenericProgressDialog::wxGenericProgressDialog(const wxString& title, int style) : wxDialog() { - Init(parent, maximum, style); + Init(parent, style); Create( title, message, maximum, parent, style ); } @@ -158,6 +153,8 @@ void wxGenericProgressDialog::Create( const wxString& title, SetParent( GetParentForModalDialog(parent, style) ); SetTitle( title ); + SetMaximum(maximum); + // We need a running event loop in order to update the dialog and be able // to process clicks on its buttons, so ensure that there is one running // even if this means we have to start it ourselves (this happens most @@ -192,29 +189,27 @@ void wxGenericProgressDialog::Create( const wxString& title, m_msg = new wxStaticText(this, wxID_ANY, message); sizerTop->Add(m_msg, 0, wxLEFT | wxTOP, 2*LAYOUT_MARGIN); - if ( maximum > 0 ) - { - int gauge_style = wxGA_HORIZONTAL; - if ( style & wxPD_SMOOTH ) - gauge_style |= wxGA_SMOOTH; - m_gauge = new wxGauge - ( - this, - wxID_ANY, - m_maximum, - wxDefaultPosition, - // make the progress bar sufficiently long - wxSize(wxMin(wxGetClientDisplayRect().width/3, 300), -1), - gauge_style - ); - - sizerTop->Add(m_gauge, 0, wxLEFT | wxRIGHT | wxTOP | wxEXPAND, 2*LAYOUT_MARGIN); - m_gauge->SetValue(0); - } - else - { - m_gauge = NULL; - } + int gauge_style = wxGA_HORIZONTAL; + if ( style & wxPD_SMOOTH ) + gauge_style |= wxGA_SMOOTH; + +#ifdef __WXMSW__ + maximum /= m_factor; +#endif + + m_gauge = new wxGauge + ( + this, + wxID_ANY, + maximum, + wxDefaultPosition, + // make the progress bar sufficiently long + wxSize(wxMin(wxGetClientDisplayRect().width/3, 300), -1), + gauge_style + ); + + sizerTop->Add(m_gauge, 0, wxLEFT | wxRIGHT | wxTOP | wxEXPAND, 2*LAYOUT_MARGIN); + m_gauge->SetValue(0); // create the estimated/remaining/total time zones if requested m_elapsed = @@ -416,7 +411,7 @@ wxGenericProgressDialog::Update(int value, const wxString& newmsg, bool *skip) if ( !DoBeforeUpdate(skip) ) return false; - wxASSERT_MSG( value == -1 || m_gauge, wxT("cannot update non existent dialog") ); + wxCHECK_MSG( m_gauge, false, "dialog should be fully created" ); #ifdef __WXMSW__ value /= m_factor; @@ -424,8 +419,7 @@ wxGenericProgressDialog::Update(int value, const wxString& newmsg, bool *skip) wxASSERT_MSG( value <= m_maximum, wxT("invalid progress value") ); - if ( m_gauge ) - m_gauge->SetValue(value); + m_gauge->SetValue(value); UpdateMessage(newmsg); @@ -508,7 +502,7 @@ bool wxGenericProgressDialog::Pulse(const wxString& newmsg, bool *skip) if ( !DoBeforeUpdate(skip) ) return false; - wxASSERT_MSG( m_gauge, wxT("cannot update non existent dialog") ); + wxCHECK_MSG( m_gauge, false, "dialog should be fully created" ); // show a bit of progress m_gauge->Pulse(); @@ -581,16 +575,14 @@ bool wxGenericProgressDialog::Show( bool show ) int wxGenericProgressDialog::GetValue() const { - if (m_gauge) - return m_gauge->GetValue(); - return wxNOT_FOUND; + wxCHECK_MSG( m_gauge, -1, "dialog should be fully created" ); + + return m_gauge->GetValue(); } int wxGenericProgressDialog::GetRange() const { - if (m_gauge) - return m_gauge->GetRange(); - return wxNOT_FOUND; + return m_maximum; } wxString wxGenericProgressDialog::GetMessage() const @@ -600,17 +592,23 @@ wxString wxGenericProgressDialog::GetMessage() const void wxGenericProgressDialog::SetRange(int maximum) { - wxASSERT_MSG(m_gauge, "The dialog should have been constructed with a range > 0"); - wxASSERT_MSG(maximum > 0, "Invalid range"); + wxCHECK_RET( m_gauge, "dialog should be fully created" ); + + wxCHECK_RET( maximum > 0, "Invalid range" ); m_gauge->SetRange(maximum); + + SetMaximum(maximum); +} + +void wxGenericProgressDialog::SetMaximum(int maximum) +{ m_maximum = maximum; #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__ } diff --git a/src/msw/progdlg.cpp b/src/msw/progdlg.cpp index 948b14bbb8..1aa5298b24 100644 --- a/src/msw/progdlg.cpp +++ b/src/msw/progdlg.cpp @@ -275,7 +275,7 @@ wxProgressDialog::wxProgressDialog( const wxString& title, int maximum, wxWindow *parent, int style ) - : wxGenericProgressDialog(parent, maximum, style), + : wxGenericProgressDialog(parent, style), m_taskDialogRunner(NULL), m_sharedData(NULL), m_message(message), @@ -284,6 +284,8 @@ wxProgressDialog::wxProgressDialog( const wxString& title, #ifdef wxHAS_MSW_TASKDIALOG if ( HasNativeProgressDialog() ) { + SetMaximum(maximum); + Show(); DisableOtherWindows(); @@ -501,17 +503,21 @@ wxString wxProgressDialog::GetMessage() const void wxProgressDialog::SetRange(int maximum) { - wxGenericProgressDialog::SetRange( maximum ); - #ifdef wxHAS_MSW_TASKDIALOG if ( HasNativeProgressDialog() ) { + SetMaximum(maximum); + wxCriticalSectionLocker locker(m_sharedData->m_cs); m_sharedData->m_range = maximum; m_sharedData->m_notifications |= wxSPDD_RANGE_CHANGED; + + return; } #endif // wxHAS_MSW_TASKDIALOG + + wxGenericProgressDialog::SetRange( maximum ); } bool wxProgressDialog::WasSkipped() const -- 2.45.2