X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/dde19c2180ef8d6415af7bb2492bfcb0a2d5c7e4..827833e2e270012069312431aadaf58096286329:/src/generic/progdlgg.cpp diff --git a/src/generic/progdlgg.cpp b/src/generic/progdlgg.cpp index 6677a2ea33..a3f0df2b4b 100644 --- a/src/generic/progdlgg.cpp +++ b/src/generic/progdlgg.cpp @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: src/generic/progdlgg.cpp -// Purpose: wxProgressDialog class +// Purpose: wxGenericProgressDialog class // Author: Karsten Ballueder // Modified by: // Created: 09.05.1999 @@ -66,49 +66,112 @@ static const int wxID_SKIP = 32000; // whatever -// ---------------------------------------------------------------------------- -// private functions -// ---------------------------------------------------------------------------- - -// update the label to show the given time (in seconds) -static void SetTimeLabel(unsigned long val, wxStaticText *label); - // ---------------------------------------------------------------------------- // event tables // ---------------------------------------------------------------------------- -BEGIN_EVENT_TABLE(wxProgressDialog, wxDialog) - EVT_BUTTON(wxID_CANCEL, wxProgressDialog::OnCancel) - EVT_BUTTON(wxID_SKIP, wxProgressDialog::OnSkip) +BEGIN_EVENT_TABLE(wxGenericProgressDialog, wxDialog) + EVT_BUTTON(wxID_CANCEL, wxGenericProgressDialog::OnCancel) + EVT_BUTTON(wxID_SKIP, wxGenericProgressDialog::OnSkip) - EVT_CLOSE(wxProgressDialog::OnClose) + EVT_CLOSE(wxGenericProgressDialog::OnClose) END_EVENT_TABLE() -IMPLEMENT_CLASS(wxProgressDialog, wxDialog) - // ============================================================================ -// wxProgressDialog implementation +// wxGenericProgressDialog implementation // ============================================================================ +wxIMPLEMENT_CLASS(wxProgressDialog, wxDialog) + // ---------------------------------------------------------------------------- -// wxProgressDialog creation +// wxGenericProgressDialog creation // ---------------------------------------------------------------------------- -wxProgressDialog::wxProgressDialog(const wxString& title, - const wxString& message, - int maximum, - wxWindow *parent, - int style) - : wxDialog(GetParentForModalDialog(parent), wxID_ANY, title), - m_skip(false), - m_delay(3), - m_hasAbortButton(false), - m_hasSkipButton(false) +void wxGenericProgressDialog::Init(wxWindow *parent, int maximum, 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); m_windowStyle |= style; + m_parentTop = wxGetTopLevelParent(parent); + + + // 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_timeStart = wxGetCurrentTime(); + m_timeStop = (unsigned long)-1; + m_break = 0; + + m_skip = false; + + m_display_estimated = + m_last_timeupdate = + m_ctdelay = 0; + + m_delay = 3; + + m_hasAbortButton = + m_hasSkipButton = false; + + m_winDisabler = NULL; + m_tempEventLoop = NULL; +} + +wxGenericProgressDialog::wxGenericProgressDialog(wxWindow *parent, + int maximum, + int style) + : wxDialog() +{ + Init(parent, maximum, style); +} + +wxGenericProgressDialog::wxGenericProgressDialog(const wxString& title, + const wxString& message, + int maximum, + wxWindow *parent, + int style) + : wxDialog() +{ + Init(parent, maximum, style); + + Create( title, message, maximum, parent, style ); +} + +void wxGenericProgressDialog::Create( const wxString& title, + const wxString& message, + int maximum, + wxWindow *parent, + int style ) +{ + wxDialog::Create(GetParentForModalDialog(parent, style), wxID_ANY, title); + + SetParent( GetParentForModalDialog(parent, style) ); + SetTitle( title ); + + // 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 + // commonly during the program initialization, e.g. for the progress + // dialogs shown from overridden wxApp::OnInit()). + if ( !wxEventLoopBase::GetActive() ) + { + m_tempEventLoop = new wxEventLoop; + wxEventLoop::SetActive(m_tempEventLoop); + } + m_hasAbortButton = (style & wxPD_CAN_ABORT) != 0; m_hasSkipButton = (style & wxPD_CAN_SKIP) != 0; @@ -128,21 +191,6 @@ wxProgressDialog::wxProgressDialog(const wxString& title, #endif m_state = m_hasAbortButton ? Continue : 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_parentTop = wxGetTopLevelParent(parent); - - wxClientDC dc(this); - dc.SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT)); - wxCoord widthText = 0; - dc.GetTextExtent(message, &widthText, NULL, NULL, NULL, NULL); // top-level sizerTop wxSizer * const sizerTop = new wxBoxSizer(wxVERTICAL); @@ -178,10 +226,6 @@ wxProgressDialog::wxProgressDialog(const wxString& title, m_elapsed = m_estimated = m_remaining = NULL; - m_display_estimated = - m_last_timeupdate = - m_break = 0; - m_ctdelay = 0; // also count how many labels we really have size_t nTimeLabels = 0; @@ -192,30 +236,24 @@ wxProgressDialog::wxProgressDialog(const wxString& title, { nTimeLabels++; - m_elapsed = CreateLabel(_("Elapsed time:"), sizerLabels); + m_elapsed = CreateLabel(GetElapsedLabel(), sizerLabels); } if ( style & wxPD_ESTIMATED_TIME ) { nTimeLabels++; - m_estimated = CreateLabel(_("Estimated time:"), sizerLabels); + m_estimated = CreateLabel(GetEstimatedLabel(), sizerLabels); } if ( style & wxPD_REMAINING_TIME ) { nTimeLabels++; - m_remaining = CreateLabel(_("Remaining time:"), sizerLabels); + m_remaining = CreateLabel(GetRemainingLabel(), sizerLabels); } sizerTop->Add(sizerLabels, 0, wxALIGN_CENTER_HORIZONTAL | wxTOP, LAYOUT_MARGIN); - if ( nTimeLabels > 0 ) - { - // set it to the current time - m_timeStart = wxGetCurrentTime(); - } - #if defined(__SMARTPHONE__) if ( m_hasSkipButton ) SetRightMenu(wxID_SKIP, _("Skip")); @@ -250,6 +288,9 @@ wxProgressDialog::wxProgressDialog(const wxString& title, buttonSizer->Add(m_btnAbort, 0, sizerFlags, LAYOUT_MARGIN); } + if (!m_hasSkipButton && !m_hasAbortButton) + buttonSizer->AddSpacer(LAYOUT_MARGIN); + sizerTop->Add(buttonSizer, 0, sizerFlags, LAYOUT_MARGIN ); #endif // __SMARTPHONE__/!__SMARTPHONE__ @@ -257,16 +298,7 @@ wxProgressDialog::wxProgressDialog(const wxString& title, Centre(wxCENTER_FRAME | wxBOTH); - if ( style & wxPD_APP_MODAL ) - { - m_winDisabler = new wxWindowDisabler(this); - } - else - { - if ( m_parentTop ) - m_parentTop->Disable(); - m_winDisabler = NULL; - } + DisableOtherWindows(); Show(); Enable(); @@ -282,8 +314,82 @@ wxProgressDialog::wxProgressDialog(const wxString& title, Update(); } +void wxGenericProgressDialog::UpdateTimeEstimates(int value, + unsigned long &elapsedTime, + unsigned long &estimatedTime, + unsigned long &remainingTime) +{ + unsigned long elapsed = wxGetCurrentTime() - m_timeStart; + if ( value != 0 && (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; + } + } + + if ( value != 0 ) + { + long display_remaining = m_display_estimated - elapsed; + if ( display_remaining < 0 ) + { + display_remaining = 0; + } + + estimatedTime = m_display_estimated; + remainingTime = display_remaining; + } + + elapsedTime = elapsed; +} + +// static +wxString wxGenericProgressDialog::GetFormattedTime(unsigned long timeInSec) +{ + wxString timeAsHMS; + + if ( timeInSec == (unsigned long)-1 ) + { + timeAsHMS = _("Unknown"); + } + else + { + unsigned hours = timeInSec / 3600; + unsigned minutes = (timeInSec % 3600) / 60; + unsigned seconds = timeInSec % 60; + timeAsHMS.Printf("%u:%02u:%02u", hours, minutes, seconds); + } + + return timeAsHMS; +} + wxStaticText * -wxProgressDialog::CreateLabel(const wxString& text, wxSizer *sizer) +wxGenericProgressDialog::CreateLabel(const wxString& text, wxSizer *sizer) { wxStaticText *label = new wxStaticText(this, wxID_ANY, text); wxStaticText *value = new wxStaticText(this, wxID_ANY, _("unknown")); @@ -307,12 +413,15 @@ wxProgressDialog::CreateLabel(const wxString& text, wxSizer *sizer) } // ---------------------------------------------------------------------------- -// wxProgressDialog operations +// wxGenericProgressDialog operations // ---------------------------------------------------------------------------- bool -wxProgressDialog::Update(int value, const wxString& newmsg, bool *skip) +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") ); #ifdef __WXMSW__ @@ -328,47 +437,13 @@ wxProgressDialog::Update(int value, const wxString& newmsg, bool *skip) if ( (m_elapsed || m_remaining || m_estimated) && (value != 0) ) { - unsigned long elapsed = wxGetCurrentTime() - m_timeStart; - 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; - } - } + unsigned long elapsed; + unsigned long display_remaining; - long display_remaining = m_display_estimated - elapsed; - if ( display_remaining < 0 ) - { - display_remaining = 0; - } + UpdateTimeEstimates( value, + elapsed, + m_display_estimated, + display_remaining ); SetTimeLabel(elapsed, m_elapsed); SetTimeLabel(m_display_estimated, m_estimated); @@ -403,8 +478,14 @@ wxProgressDialog::Update(int value, const wxString& newmsg, bool *skip) m_msg->SetLabel(_("Done.")); } + // allow the window to repaint: + // NOTE: since we yield only for UI events with this call, there + // should be no side-effects wxEventLoopBase::GetActive()->YieldFor(wxEVT_CATEGORY_UI); + // NOTE: this call results in a new event loop being created + // and to a call to ProcessPendingEvents() (which may generate + // unwanted re-entrancies). (void)ShowModal(); } else // auto hide @@ -419,7 +500,7 @@ wxProgressDialog::Update(int value, const wxString& newmsg, bool *skip) } else // not at maximum yet { - return DoAfterUpdate(skip); + DoAfterUpdate(); } // update the display in case yielding above didn't do it @@ -428,8 +509,11 @@ wxProgressDialog::Update(int value, const wxString& newmsg, bool *skip) return m_state != Canceled; } -bool wxProgressDialog::Pulse(const wxString& newmsg, bool *skip) +bool wxGenericProgressDialog::Pulse(const wxString& newmsg, bool *skip) { + if ( !DoBeforeUpdate(skip) ) + return false; + wxASSERT_MSG( m_gauge, wxT("cannot update non existent dialog") ); // show a bit of progress @@ -446,13 +530,17 @@ bool wxProgressDialog::Pulse(const wxString& newmsg, bool *skip) SetTimeLabel((unsigned long)-1, m_remaining); } - return DoAfterUpdate(skip); + DoAfterUpdate(); + + return m_state != Canceled; } -bool wxProgressDialog::DoAfterUpdate(bool *skip) +bool wxGenericProgressDialog::DoBeforeUpdate(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 + // NOTE: using YieldFor() this call shouldn't give re-entrancy problems + // for event handlers not interested to UI/user-input events. wxEventLoopBase::GetActive()->YieldFor(wxEVT_CATEGORY_UI|wxEVT_CATEGORY_USER_INPUT); Update(); @@ -467,7 +555,15 @@ bool wxProgressDialog::DoAfterUpdate(bool *skip) return m_state != Canceled; } -void wxProgressDialog::Resume() +void wxGenericProgressDialog::DoAfterUpdate() +{ + // allow the window to repaint: + // NOTE: since we yield only for UI events with this call, there + // should be no side-effects + wxEventLoopBase::GetActive()->YieldFor(wxEVT_CATEGORY_UI); +} + +void wxGenericProgressDialog::Resume() { m_state = Continue; m_ctdelay = m_delay; // force an update of the elapsed/estimated/remaining time @@ -478,7 +574,7 @@ void wxProgressDialog::Resume() m_skip = false; } -bool wxProgressDialog::Show( bool show ) +bool wxGenericProgressDialog::Show( bool show ) { // reenable other windows before hiding this one because otherwise // Windows wouldn't give the focus back to the window which had @@ -489,30 +585,79 @@ bool wxProgressDialog::Show( bool show ) return wxDialog::Show(show); } -int wxProgressDialog::GetValue() const +int wxGenericProgressDialog::GetValue() const { if (m_gauge) return m_gauge->GetValue(); return wxNOT_FOUND; } -int wxProgressDialog::GetRange() const +int wxGenericProgressDialog::GetRange() const { if (m_gauge) return m_gauge->GetRange(); return wxNOT_FOUND; } -wxString wxProgressDialog::GetMessage() const +wxString wxGenericProgressDialog::GetMessage() const { return m_msg->GetLabel(); } +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"); + + m_gauge->SetRange(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__ +} + + +bool wxGenericProgressDialog::WasCancelled() const +{ + return m_hasAbortButton && m_state == Canceled; +} + +bool wxGenericProgressDialog::WasSkipped() const +{ + return m_hasSkipButton && m_skip; +} + +// static +void wxGenericProgressDialog::SetTimeLabel(unsigned long val, + wxStaticText *label) +{ + if ( label ) + { + wxString s; + + if (val != (unsigned long)-1) + { + s = GetFormattedTime(val); + } + else + { + s = _("Unknown"); + } + + if ( s != label->GetLabel() ) + label->SetLabel(s); + } +} + // ---------------------------------------------------------------------------- // event handlers // ---------------------------------------------------------------------------- -void wxProgressDialog::OnCancel(wxCommandEvent& event) +void wxGenericProgressDialog::OnCancel(wxCommandEvent& event) { if ( m_state == Finished ) { @@ -536,13 +681,13 @@ void wxProgressDialog::OnCancel(wxCommandEvent& event) } } -void wxProgressDialog::OnSkip(wxCommandEvent& WXUNUSED(event)) +void wxGenericProgressDialog::OnSkip(wxCommandEvent& WXUNUSED(event)) { DisableSkip(); m_skip = true; } -void wxProgressDialog::OnClose(wxCloseEvent& event) +void wxGenericProgressDialog::OnClose(wxCloseEvent& event) { if ( m_state == Uncancelable ) { @@ -569,19 +714,38 @@ void wxProgressDialog::OnClose(wxCloseEvent& event) // destruction // ---------------------------------------------------------------------------- -wxProgressDialog::~wxProgressDialog() +wxGenericProgressDialog::~wxGenericProgressDialog() { // normally this should have been already done, but just in case ReenableOtherWindows(); + + if ( m_tempEventLoop ) + { + wxEventLoopBase::SetActive(NULL); + delete m_tempEventLoop; + } } -void wxProgressDialog::ReenableOtherWindows() +void wxGenericProgressDialog::DisableOtherWindows() { if ( HasFlag(wxPD_APP_MODAL) ) { - delete m_winDisabler; + m_winDisabler = new wxWindowDisabler(this); + } + else + { + if ( m_parentTop ) + m_parentTop->Disable(); m_winDisabler = NULL; } +} + +void wxGenericProgressDialog::ReenableOtherWindows() +{ + if ( HasFlag(wxPD_APP_MODAL) ) + { + wxDELETE(m_winDisabler); + } else { if ( m_parentTop ) @@ -593,30 +757,7 @@ void wxProgressDialog::ReenableOtherWindows() // private functions // ---------------------------------------------------------------------------- -static void SetTimeLabel(unsigned long val, wxStaticText *label) -{ - 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); - } - else - { - s = _("Unknown"); - } - - if ( s != label->GetLabel() ) - label->SetLabel(s); - } -} - -void wxProgressDialog::EnableSkip(bool enable) +void wxGenericProgressDialog::EnableSkip(bool enable) { if(m_hasSkipButton) { @@ -632,7 +773,7 @@ void wxProgressDialog::EnableSkip(bool enable) } } -void wxProgressDialog::EnableAbort(bool enable) +void wxGenericProgressDialog::EnableAbort(bool enable) { if(m_hasAbortButton) { @@ -648,7 +789,7 @@ void wxProgressDialog::EnableAbort(bool enable) } } -void wxProgressDialog::EnableClose() +void wxGenericProgressDialog::EnableClose() { if(m_hasAbortButton) { @@ -664,14 +805,15 @@ void wxProgressDialog::EnableClose() } } -void wxProgressDialog::UpdateMessage(const wxString &newmsg) +void wxGenericProgressDialog::UpdateMessage(const wxString &newmsg) { if ( !newmsg.empty() && newmsg != m_msg->GetLabel() ) { m_msg->SetLabel(newmsg); - Fit(); // adapt to the new label size - + // allow the window to repaint: + // NOTE: since we yield only for UI events with this call, there + // should be no side-effects wxEventLoopBase::GetActive()->YieldFor(wxEVT_CATEGORY_UI); } }