X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d2cdad17e38fa530ea9376e1d69c1d2a8df35a08..1bab36277c418507195638ace24ea9cedc78391c:/src/generic/progdlgg.cpp diff --git a/src/generic/progdlgg.cpp b/src/generic/progdlgg.cpp index b8010a4813..77af0c76aa 100644 --- a/src/generic/progdlgg.cpp +++ b/src/generic/progdlgg.cpp @@ -1,11 +1,11 @@ ///////////////////////////////////////////////////////////////////////////// -// 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 +// Copyright: (c) Karsten Ballueder // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -17,10 +17,6 @@ // 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" @@ -39,19 +35,21 @@ #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" + #include "wx/app.h" #endif -#include "wx/generic/progdlgg.h" +#include "wx/progdlg.h" +#include "wx/evtloop.h" // --------------------------------------------------------------------------- // macros // --------------------------------------------------------------------------- /* Macro for avoiding #ifdefs when value have to be different depending on size of - device we display on + device we display on - take it from something like wxDesktopPolicy in the future */ #if defined(__SMARTPHONE__) @@ -66,6 +64,8 @@ #define LAYOUT_MARGIN wxLARGESMALL(8,2) +static const int wxID_SKIP = 32000; // whatever + // ---------------------------------------------------------------------------- // private functions // ---------------------------------------------------------------------------- @@ -79,6 +79,7 @@ static void SetTimeLabel(unsigned long val, wxStaticText *label); BEGIN_EVENT_TABLE(wxProgressDialog, wxDialog) EVT_BUTTON(wxID_CANCEL, wxProgressDialog::OnCancel) + EVT_BUTTON(wxID_SKIP, wxProgressDialog::OnSkip) EVT_CLOSE(wxProgressDialog::OnClose) END_EVENT_TABLE() @@ -93,27 +94,30 @@ IMPLEMENT_CLASS(wxProgressDialog, wxDialog) // 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, wxID_ANY, title), - m_delay(3) + : 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_hasAbortButton = (style & wxPD_CAN_ABORT) != 0; + m_hasSkipButton = (style & wxPD_CAN_SKIP) != 0; #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); } @@ -123,7 +127,7 @@ wxProgressDialog::wxProgressDialog(wxString const &title, SetLeftMenu(); #endif - m_state = hasAbortButton ? Continue : Uncancelable; + m_state = m_hasAbortButton ? Continue : Uncancelable; m_maximum = maximum; #if defined(__WXMSW__) || defined(__WXPM__) @@ -137,109 +141,119 @@ wxProgressDialog::wxProgressDialog(wxString const &title, wxClientDC dc(this); dc.SetFont(wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT)); - long widthText; + wxCoord widthText = 0; dc.GetTextExtent(message, &widthText, NULL, NULL, NULL, NULL); - wxBoxSizer *sizer = new wxBoxSizer(wxVERTICAL); + // top-level sizerTop + wxSizer * const sizerTop = new wxBoxSizer(wxVERTICAL); m_msg = new wxStaticText(this, wxID_ANY, message); - sizer->Add(m_msg, 0, wxLEFT | wxTOP, 2*LAYOUT_MARGIN); - - wxSize sizeDlg, - sizeLabel = m_msg->GetSize(); - sizeDlg.y = 2*LAYOUT_MARGIN + sizeLabel.y; + sizerTop->Add(m_msg, 0, wxLEFT | wxTOP, 2*LAYOUT_MARGIN); 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. - m_gauge = new wxGauge(this, wxID_ANY, m_maximum, - wxDefaultPosition, wxDefaultSize, - wxGA_HORIZONTAL); - - sizer->Add(m_gauge, 0, wxLEFT | wxRIGHT | wxTOP | wxEXPAND, 2*LAYOUT_MARGIN); + 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); - - wxSize sizeGauge = m_gauge->GetSize(); - sizeDlg.y += 2*LAYOUT_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_display_estimated = m_last_timeupdate = m_break = 0; + 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, remmeber 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); + if ( style & wxPD_ELAPSED_TIME ) { nTimeLabels++; - label = - m_elapsed = CreateLabel(_("Elapsed time : "), sizer); + m_elapsed = CreateLabel(_("Elapsed time:"), sizerLabels); } if ( style & wxPD_ESTIMATED_TIME ) { nTimeLabels++; - label = - m_estimated = CreateLabel(_("Estimated time : "), sizer); + m_estimated = CreateLabel(_("Estimated time:"), sizerLabels); } if ( style & wxPD_REMAINING_TIME ) { nTimeLabels++; - label = - m_remaining = CreateLabel(_("Remaining time : "), sizer); + 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 * (label->GetSize().y + LAYOUT_MARGIN); } - if ( hasAbortButton ) - { #if defined(__SMARTPHONE__) - SetLeftMenu(wxID_CANCEL, _("Cancel")); - } + if ( m_hasSkipButton ) + SetRightMenu(wxID_SKIP, _("Skip")); + if ( m_hasAbortButton ) + SetLeftMenu(wxID_CANCEL); #else - m_btnAbort = new wxButton(this, wxID_CANCEL); + m_btnAbort = + m_btnSkip = NULL; - // Windows dialogs usually have buttons in the lower right corner + wxBoxSizer *buttonSizer = new wxBoxSizer(wxHORIZONTAL); + + // Windows dialogs usually have buttons in the lower right corner + const int sizerFlags = #if defined(__WXMSW__) || defined(__WXPM__) - sizer->Add(m_btnAbort, 0, wxALIGN_RIGHT | wxALL, 2*LAYOUT_MARGIN); + wxALIGN_RIGHT | wxALL #else // !MSW - sizer->Add(m_btnAbort, 0, wxALIGN_CENTER_HORIZONTAL | wxBOTTOM | wxTOP, 2*LAYOUT_MARGIN); + wxALIGN_CENTER_HORIZONTAL | wxBOTTOM | wxTOP #endif // MSW/!MSW - sizeDlg.y += 2*LAYOUT_MARGIN + wxButton::GetDefaultSize().y; - } - else // no "Cancel" button -#endif // __SMARTPHONE__/!__SMARTPHONE__ + ; + + if ( m_hasSkipButton ) { - m_btnAbort = (wxButton *)NULL; + m_btnSkip = new wxButton(this, wxID_SKIP, _("&Skip")); + + buttonSizer->Add(m_btnSkip, 0, sizerFlags, LAYOUT_MARGIN); } - SetSizerAndFit(sizer); + if ( m_hasAbortButton ) + { + m_btnAbort = new wxButton(this, wxID_CANCEL); - sizeDlg.y += 2*LAYOUT_MARGIN; + buttonSizer->Add(m_btnAbort, 0, sizerFlags, LAYOUT_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); @@ -268,33 +282,28 @@ wxProgressDialog::wxProgressDialog(wxString const &title, Update(); } -wxStaticText *wxProgressDialog::CreateLabel(const wxString& text, - wxSizer *sizer) +wxStaticText * +wxProgressDialog::CreateLabel(const wxString& text, wxSizer *sizer) { - wxBoxSizer *locsizer = new wxBoxSizer(wxLARGESMALL(wxHORIZONTAL,wxVERTICAL)); - - wxStaticText *dummy = new wxStaticText(this, wxID_ANY, text); - wxStaticText *label = new wxStaticText(this, wxID_ANY, _("unknown")); + 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__) - // 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); + // 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 - // 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); + // value and time to the right in one row + sizer->Add(label); + sizer->Add(value, 0, wxLEFT, LAYOUT_MARGIN); #endif - return label; + return value; } // ---------------------------------------------------------------------------- @@ -302,7 +311,7 @@ wxStaticText *wxProgressDialog::CreateLabel(const wxString& text, // ---------------------------------------------------------------------------- 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") ); @@ -312,19 +321,10 @@ wxProgressDialog::Update(int value, const wxString& newmsg) wxASSERT_MSG( value <= m_maximum, wxT("invalid progress value") ); - // fill up the gauge if value == maximum because this means that the dialog - // is going to close and the gauge shouldn't be partly empty in this case - if ( m_gauge && value <= m_maximum ) - { - m_gauge->SetValue(value == m_maximum ? value : value + 1); - } - - if ( !newmsg.IsEmpty() ) - { - m_msg->SetLabel(newmsg); + if ( m_gauge ) + m_gauge->SetValue(value); - wxYieldIfNeeded() ; - } + UpdateMessage(newmsg); if ( (m_elapsed || m_remaining || m_estimated) && (value != 0) ) { @@ -389,31 +389,31 @@ wxProgressDialog::Update(int value, const wxString& newmsg) // so that we return true below and that out [Cancel] handler knew what // to do m_state = Finished; - if( !(GetWindowStyle() & wxPD_AUTO_HIDE) ) + if( !HasFlag(wxPD_AUTO_HIDE) ) { -#if defined(__SMARTPHONE__) - SetLeftMenu(wxID_CANCEL, _("Close")); -#endif - if ( m_btnAbort ) - { - // tell the user what he should do... - m_btnAbort->SetLabel(_("Close")); - } + EnableClose(); + DisableSkip(); #if defined(__WXMSW__) && !defined(__WXUNIVERSAL__) - else // enable the button to give the user a way to close the dlg - { - EnableCloseButton(); - } + EnableCloseButton(); #endif // __WXMSW__ - if ( !newmsg ) + if ( newmsg.empty() ) { // also provide the finishing message if the application didn't m_msg->SetLabel(_("Done.")); } - wxYieldIfNeeded() ; + wxCHECK_MSG(wxEventLoopBase::GetActive(), false, + "wxProgressDialog::Update needs a running event loop"); + + // 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 @@ -426,11 +426,9 @@ wxProgressDialog::Update(int value, const wxString& newmsg) 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 button - wxYieldIfNeeded() ; + return DoAfterUpdate(skip); } // update the display in case yielding above didn't do it @@ -439,19 +437,59 @@ wxProgressDialog::Update(int value, const wxString& newmsg) 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) +{ + wxCHECK_MSG(wxEventLoopBase::GetActive(), false, + "wxProgressDialog::DoAfterUpdate needs a running event loop"); + + // 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(); + + 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; - // it may have been disabled by OnCancel(), so enable it back to let the - // user interrupt us again if needed - if(m_btnAbort) - m_btnAbort->Enable(); -#if defined(__SMARTPHONE__) - SetLeftMenu(wxID_CANCEL, _("Cancel")); -#endif + EnableAbort(); + EnableSkip(); + m_skip = false; } bool wxProgressDialog::Show( bool show ) @@ -465,6 +503,41 @@ bool wxProgressDialog::Show( bool show ) return wxDialog::Show(show); } +int wxProgressDialog::GetValue() const +{ + if (m_gauge) + return m_gauge->GetValue(); + return wxNOT_FOUND; +} + +int wxProgressDialog::GetRange() const +{ + if (m_gauge) + return m_gauge->GetRange(); + return wxNOT_FOUND; +} + +wxString wxProgressDialog::GetMessage() const +{ + return m_msg->GetLabel(); +} + +void wxProgressDialog::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__ +} + // ---------------------------------------------------------------------------- // event handlers // ---------------------------------------------------------------------------- @@ -483,20 +556,22 @@ 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 - if(m_btnAbort) - m_btnAbort->Disable(); - -#if defined(__SMARTPHONE__) - SetLeftMenu(); -#endif + 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 ) @@ -513,11 +588,9 @@ void wxProgressDialog::OnClose(wxCloseEvent& event) { // next Update() will notice it m_state = Canceled; - if(m_btnAbort) - m_btnAbort->Disable(); -#if defined(__SMARTPHONE__) - SetLeftMenu(); -#endif + DisableAbort(); + DisableSkip(); + m_timeStop = wxGetCurrentTime(); } } @@ -534,10 +607,10 @@ wxProgressDialog::~wxProgressDialog() void wxProgressDialog::ReenableOtherWindows() { - if ( GetWindowStyle() & wxPD_APP_MODAL ) + if ( HasFlag(wxPD_APP_MODAL) ) { delete m_winDisabler; - m_winDisabler = (wxWindowDisabler *)NULL; + m_winDisabler = NULL; } else { @@ -555,14 +628,86 @@ static void SetTimeLabel(unsigned long val, wxStaticText *label) if ( label ) { wxString s; - 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); + + 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) +{ + wxCHECK_RET(wxEventLoopBase::GetActive(), + "wxProgressDialog::UpdateMessage needs a running event loop"); + + if ( !newmsg.empty() && newmsg != m_msg->GetLabel() ) + { + m_msg->SetLabel(newmsg); + + // 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); + } +} + #endif // wxUSE_PROGRESSDLG