X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ef8698d677c97b2d662ee1c5adbdaadf58103e0e..76f91e7741e1f9f34aa246a37816a8ae0fe222e4:/src/generic/progdlgg.cpp diff --git a/src/generic/progdlgg.cpp b/src/generic/progdlgg.cpp index e9c031ab2a..6f4fec1fe8 100644 --- a/src/generic/progdlgg.cpp +++ b/src/generic/progdlgg.cpp @@ -1,12 +1,12 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: progdlgg.h +// Name: src/generic/progdlgg.cpp // Purpose: wxProgressDialog class -// Author: Karsten Ballüder +// Author: Karsten Ballueder // Modified by: // Created: 09.05.1999 // RCS-ID: $Id$ -// Copyright: (c) Karsten Ballüder -// Licence: wxWindows license +// Copyright: (c) Karsten Ballueder +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// // ============================================================================ @@ -17,10 +17,6 @@ // headers // ---------------------------------------------------------------------------- -#ifdef __GNUG__ - #pragma implementation "progdlgg.h" -#endif - // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" @@ -35,23 +31,38 @@ #include "wx/frame.h" #include "wx/button.h" #include "wx/stattext.h" - #include "wx/layout.h" + #include "wx/sizer.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" + #include "wx/settings.h" #endif -#include "wx/generic/progdlgg.h" +#include "wx/progdlg.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 // ---------------------------------------------------------------------------- -#define LAYOUT_X_MARGIN 8 -#define LAYOUT_Y_MARGIN 8 +#define LAYOUT_MARGIN wxLARGESMALL(8,2) + +static const int wxID_SKIP = 32000; // whatever // ---------------------------------------------------------------------------- // private functions @@ -66,8 +77,7 @@ static void SetTimeLabel(unsigned long val, wxStaticText *label); BEGIN_EVENT_TABLE(wxProgressDialog, wxDialog) EVT_BUTTON(wxID_CANCEL, wxProgressDialog::OnCancel) - - EVT_SHOW(wxProgressDialog::OnShow) + EVT_BUTTON(wxID_SKIP, wxProgressDialog::OnSkip) EVT_CLOSE(wxProgressDialog::OnClose) END_EVENT_TABLE() @@ -75,142 +85,180 @@ END_EVENT_TABLE() IMPLEMENT_CLASS(wxProgressDialog, wxDialog) // ============================================================================ -// implementation +// wxProgressDialog implementation // ============================================================================ // ---------------------------------------------------------------------------- -// wxProgressDialog +// wxProgressDialog creation // ---------------------------------------------------------------------------- -wxProgressDialog::wxProgressDialog(wxString const &title, - wxString const &message, +wxProgressDialog::wxProgressDialog(const wxString& title, + const wxString& message, int maximum, wxWindow *parent, int style) - : wxDialog(parent, -1, title) + : wxDialog(GetParentForModalDialog(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); m_windowStyle |= style; - bool hasAbortButton = (style & wxPD_CAN_ABORT) != 0; - m_state = hasAbortButton ? Continue : Uncancelable; - m_maximum = maximum; + m_hasAbortButton = (style & wxPD_CAN_ABORT) != 0; + m_hasSkipButton = (style & wxPD_CAN_SKIP) != 0; - m_parentTop = parent; - while ( m_parentTop && m_parentTop->GetParent() ) +#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 ( !m_hasAbortButton ) { - m_parentTop = m_parentTop->GetParent(); + EnableCloseButton(false); } +#endif // wxMSW - wxLayoutConstraints *c; +#if defined(__SMARTPHONE__) + SetLeftMenu(); +#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::GetSystemFont(wxSYS_DEFAULT_GUI_FONT)); - long widthText; + dc.SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT)); + wxCoord widthText = 0; 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); + // top-level sizerTop + wxSizer * const sizerTop = new wxBoxSizer(wxVERTICAL); - wxSize sizeDlg, sizeLabel = m_msg->GetSize(); - sizeDlg.y = 2*LAYOUT_Y_MARGIN + sizeLabel.y; - - wxWindow *lastWindow = m_msg; + m_msg = new wxStaticText(this, wxID_ANY, message); + sizerTop->Add(m_msg, 0, wxLEFT | wxTOP, 2*LAYOUT_MARGIN); + wxSize sizeLabel = m_msg->GetSize(); if ( maximum > 0 ) { - m_gauge = new wxGauge(this, -1, maximum, - wxDefaultPosition, wxDefaultSize, - wxGA_HORIZONTAL | wxRAISED_BORDER); -// Sorry, but wxGA_SMOOTH happens to also mean wxDIALOG_MODAL and will -// cause the dialog to be modal. Have an extra style argument to wxProgressDialog, -// perhaps. -// wxGA_HORIZONTAL | wxRAISED_BORDER | (style & wxGA_SMOOTH)); - 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); + 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); - lastWindow = m_gauge; - - wxSize sizeGauge = m_gauge->GetSize(); - sizeDlg.y += 2*LAYOUT_Y_MARGIN + sizeGauge.y; } else - m_gauge = (wxGauge *)NULL; + { + m_gauge = NULL; + } // create the estimated/remaining/total time zones if requested - m_elapsed = m_estimated = m_remaining = (wxStaticText*)NULL; + m_elapsed = + m_estimated = + m_remaining = NULL; + m_display_estimated = + m_last_timeupdate = + m_break = 0; + m_ctdelay = 0; + + // if we are going to have at least one label, remember it in this var + wxStaticText *label = NULL; + + // also count how many labels we really have + size_t nTimeLabels = 0; + + wxSizer * const sizerLabels = new wxFlexGridSizer(2); - int nTimeLabels = 0; if ( style & wxPD_ELAPSED_TIME ) { nTimeLabels++; - m_elapsed = CreateLabel(_("Elapsed time : "), &lastWindow); + label = + m_elapsed = CreateLabel(_("Elapsed time:"), sizerLabels); } if ( style & wxPD_ESTIMATED_TIME ) { nTimeLabels++; - m_estimated = CreateLabel(_("Estimated time : "), &lastWindow); + label = + m_estimated = CreateLabel(_("Estimated time:"), sizerLabels); } if ( style & wxPD_REMAINING_TIME ) { nTimeLabels++; - m_remaining = CreateLabel(_("Remaining time : "), &lastWindow); + label = + m_remaining = CreateLabel(_("Remaining time:"), sizerLabels); } + sizerTop->Add(sizerLabels, 0, wxALIGN_CENTER_HORIZONTAL | wxTOP, LAYOUT_MARGIN); if ( nTimeLabels > 0 ) { // set it to the current time m_timeStart = wxGetCurrentTime(); - sizeDlg.y += nTimeLabels * (sizeLabel.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); +#if defined(__SMARTPHONE__) + if ( m_hasSkipButton ) + SetRightMenu(wxID_SKIP, _("Skip")); + if ( m_hasAbortButton ) + SetLeftMenu(wxID_CANCEL); +#else + m_btnAbort = + m_btnSkip = NULL; + + wxBoxSizer *buttonSizer = new wxBoxSizer(wxHORIZONTAL); + + // Windows dialogs usually have buttons in the lower right corner + const int sizerFlags = +#if defined(__WXMSW__) || defined(__WXPM__) + wxALIGN_RIGHT | wxALL #else // !MSW - c->centreX.SameAs(this, wxCentreX); + wxALIGN_CENTER_HORIZONTAL | wxBOTTOM | wxTOP #endif // MSW/!MSW - c->bottom.SameAs(this, wxBottom, 2*LAYOUT_Y_MARGIN); - - wxSize sizeBtn = wxButton::GetDefaultSize(); - c->width.Absolute(sizeBtn.x); - c->height.Absolute(sizeBtn.y); + ; - m_btnAbort->SetConstraints(c); + if ( m_hasSkipButton ) + { + m_btnSkip = new wxButton(this, wxID_SKIP, _("&Skip")); - sizeDlg.y += 2*LAYOUT_Y_MARGIN + sizeBtn.y; + buttonSizer->Add(m_btnSkip, 0, sizerFlags, LAYOUT_MARGIN); } - else - m_btnAbort = (wxButton *)NULL; - SetAutoLayout(TRUE); - Layout(); + if ( m_hasAbortButton ) + { + m_btnAbort = new wxButton(this, wxID_CANCEL); + + buttonSizer->Add(m_btnAbort, 0, sizerFlags, LAYOUT_MARGIN); + } - sizeDlg.y += 2*LAYOUT_Y_MARGIN; + sizerTop->Add(buttonSizer, 0, sizerFlags, LAYOUT_MARGIN ); +#endif // __SMARTPHONE__/!__SMARTPHONE__ - // 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); + SetSizerAndFit(sizerTop); Centre(wxCENTER_FRAME | wxBOTH); @@ -221,122 +269,231 @@ wxProgressDialog::wxProgressDialog(wxString const &title, else { if ( m_parentTop ) - m_parentTop->Enable(FALSE); + m_parentTop->Disable(); m_winDisabler = NULL; } - Show(TRUE); - Enable(TRUE); // enable this window + Show(); + Enable(); - // Update the display (especially on X, GTK) - wxYield(); + // 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); + } -#ifdef __WXMAC__ - MacUpdateImmediately(); -#endif + Update(); } -wxStaticText *wxProgressDialog::CreateLabel(const wxString& text, - wxWindow **lastWindow) +wxStaticText * +wxProgressDialog::CreateLabel(const wxString& text, wxSizer *sizer) { - wxLayoutConstraints *c; - - wxStaticText *label = new wxStaticText(this, -1, _("unknown")); - c = new wxLayoutConstraints; + wxStaticText *label = new wxStaticText(this, wxID_ANY, text); + wxStaticText *value = new wxStaticText(this, wxID_ANY, _("unknown")); + + // select placement most native or nice on target GUI +#if defined(__SMARTPHONE__) + // value and time to the left in two rows + sizer->Add(label, 1, wxALIGN_LEFT); + sizer->Add(value, 1, wxALIGN_LEFT); +#elif defined(__WXMSW__) || defined(__WXPM__) || defined(__WXMAC__) || defined(__WXGTK20__) + // value and time centered in one row + sizer->Add(label, 1, wxLARGESMALL(wxALIGN_RIGHT,wxALIGN_LEFT) | wxTOP | wxRIGHT, LAYOUT_MARGIN); + sizer->Add(value, 1, wxALIGN_LEFT | wxTOP, LAYOUT_MARGIN); +#else + // value and time to the right in one row + sizer->Add(label); + sizer->Add(value, 0, wxLEFT, LAYOUT_MARGIN); +#endif - // 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; + return value; } +// ---------------------------------------------------------------------------- +// wxProgressDialog operations +// ---------------------------------------------------------------------------- + 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 <= m_maximum, wxT("invalid progress value") ); - - if ( m_gauge ) - m_gauge->SetValue(value + 1); - if ( !newmsg.IsEmpty() ) - { #ifdef __WXMSW__ - // this seems to be necessary or garbage is left when the new label is - // longer than the old one - m_msg->SetLabel(wxEmptyString); -#endif // MSW + value /= m_factor; +#endif // __WXMSW__ - m_msg->SetLabel(newmsg); + wxASSERT_MSG( value <= m_maximum, wxT("invalid progress value") ); - wxYield(); - } + if ( m_gauge ) + m_gauge->SetValue(value); + + UpdateMessage(newmsg); 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; + 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(estimated, m_estimated); - SetTimeLabel(remaining, m_remaining); + SetTimeLabel(m_display_estimated, m_estimated); + SetTimeLabel(display_remaining, m_remaining); } - if ( (value == m_maximum ) && !(GetWindowStyle() & wxPD_AUTO_HIDE) ) + if ( value == m_maximum ) { - if ( m_btnAbort ) + if ( m_state == Finished ) { - // tell the user what he should do... - m_btnAbort->SetLabel(_("Close")); + // 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; } - if ( !newmsg ) - { - // also provide the finishing message if the application didn't - m_msg->SetLabel(_("Done.")); - } - - // so that we return TRUE below and that out [Cancel] handler knew what + // so that we return true below and that out [Cancel] handler knew what // to do m_state = Finished; + if( !(GetWindowStyle() & wxPD_AUTO_HIDE) ) + { + EnableClose(); + DisableSkip(); +#if defined(__WXMSW__) && !defined(__WXUNIVERSAL__) + EnableCloseButton(); +#endif // __WXMSW__ + + if ( newmsg.empty() ) + { + // also provide the finishing message if the application didn't + m_msg->SetLabel(_("Done.")); + } - wxYield(); + wxYieldIfNeeded() ; - (void)ShowModal(); + (void)ShowModal(); + } + else // auto hide + { + // reenable other windows before hiding this one because otherwise + // Windows wouldn't give the focus back to the window which had + // been previously focused because it would still be disabled + ReenableOtherWindows(); + + Hide(); + } } - else + else // not at maximum yet { - // update the display - wxYield(); + return DoAfterUpdate(skip); } -#ifdef __WXMAC__ - MacUpdateImmediately(); -#endif + // update the display in case yielding above didn't do it + Update(); 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; + m_ctdelay = m_delay; // force an update of the elapsed/estimated/remaining time + m_break += wxGetCurrentTime()-m_timeStop; + + EnableAbort(); + EnableSkip(); + m_skip = false; +} + +bool wxProgressDialog::Show( bool show ) +{ + // reenable other windows before hiding this one because otherwise + // Windows wouldn't give the focus back to the window which had + // been previously focused because it would still be disabled + if(!show) + ReenableOtherWindows(); + + return wxDialog::Show(show); +} + // ---------------------------------------------------------------------------- // event handlers // ---------------------------------------------------------------------------- @@ -355,18 +512,28 @@ void wxProgressDialog::OnCancel(wxCommandEvent& event) // 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 - 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 ) { // can't close this dialog - event.Veto(TRUE); + event.Veto(); } else if ( m_state == Finished ) { @@ -377,16 +544,10 @@ void wxProgressDialog::OnClose(wxCloseEvent& event) { // next Update() will notice it m_state = Canceled; - } -} + DisableAbort(); + DisableSkip(); -void wxProgressDialog::OnShow(wxShowEvent& event) -{ - // if the dialog is being hidden, it was closed, so reenable other windows - // now - if ( event.GetShow() ) - { - ReenableOtherWindows(); + m_timeStop = wxGetCurrentTime(); } } @@ -410,7 +571,7 @@ void wxProgressDialog::ReenableOtherWindows() else { if ( m_parentTop ) - m_parentTop->Enable(TRUE); + m_parentTop->Enable(); } } @@ -423,14 +584,80 @@ 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) +{ + 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 + } +} + +void wxProgressDialog::UpdateMessage(const wxString &newmsg) +{ + if ( !newmsg.empty() && newmsg != m_msg->GetLabel() ) + { + m_msg->SetLabel(newmsg); + + wxYieldIfNeeded() ; + } +} + #endif // wxUSE_PROGRESSDLG