1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/generic/progdlgg.cpp
3 // Purpose: wxProgressDialog class
4 // Author: Karsten Ballueder
8 // Copyright: (c) Karsten Ballueder
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 // For compilers that support precompilation, includes "wx.h".
21 #include "wx/wxprec.h"
32 #include "wx/button.h"
33 #include "wx/stattext.h"
38 #include "wx/dcclient.h"
40 #include "wx/settings.h"
44 #include "wx/progdlg.h"
45 #include "wx/evtloop.h"
47 // ---------------------------------------------------------------------------
49 // ---------------------------------------------------------------------------
51 /* Macro for avoiding #ifdefs when value have to be different depending on size of
52 device we display on - take it from something like wxDesktopPolicy in the future
55 #if defined(__SMARTPHONE__)
56 #define wxLARGESMALL(large,small) small
58 #define wxLARGESMALL(large,small) large
61 // ----------------------------------------------------------------------------
63 // ----------------------------------------------------------------------------
65 #define LAYOUT_MARGIN wxLARGESMALL(8,2)
67 static const int wxID_SKIP
= 32000; // whatever
69 // ----------------------------------------------------------------------------
71 // ----------------------------------------------------------------------------
73 // update the label to show the given time (in seconds)
74 static void SetTimeLabel(unsigned long val
, wxStaticText
*label
);
76 // ----------------------------------------------------------------------------
78 // ----------------------------------------------------------------------------
80 BEGIN_EVENT_TABLE(wxProgressDialog
, wxDialog
)
81 EVT_BUTTON(wxID_CANCEL
, wxProgressDialog::OnCancel
)
82 EVT_BUTTON(wxID_SKIP
, wxProgressDialog::OnSkip
)
84 EVT_CLOSE(wxProgressDialog::OnClose
)
87 IMPLEMENT_CLASS(wxProgressDialog
, wxDialog
)
89 // ============================================================================
90 // wxProgressDialog implementation
91 // ============================================================================
93 // ----------------------------------------------------------------------------
94 // wxProgressDialog creation
95 // ----------------------------------------------------------------------------
97 wxProgressDialog::wxProgressDialog(const wxString
& title
,
98 const wxString
& message
,
102 : wxDialog(GetParentForModalDialog(parent
, style
), wxID_ANY
, title
),
105 m_hasAbortButton(false),
106 m_hasSkipButton(false)
108 // we may disappear at any moment, let the others know about it
109 SetExtraStyle(GetExtraStyle() | wxWS_EX_TRANSIENT
);
110 m_windowStyle
|= style
;
112 m_hasAbortButton
= (style
& wxPD_CAN_ABORT
) != 0;
113 m_hasSkipButton
= (style
& wxPD_CAN_SKIP
) != 0;
115 #if defined(__WXMSW__) && !defined(__WXUNIVERSAL__)
116 // we have to remove the "Close" button from the title bar then as it is
117 // confusing to have it - it doesn't work anyhow
119 // FIXME: should probably have a (extended?) window style for this
120 if ( !m_hasAbortButton
)
122 EnableCloseButton(false);
126 #if defined(__SMARTPHONE__)
130 m_state
= m_hasAbortButton
? Continue
: Uncancelable
;
133 #if defined(__WXMSW__) || defined(__WXPM__)
134 // we can't have values > 65,536 in the progress control under Windows, so
135 // scale everything down
136 m_factor
= m_maximum
/ 65536 + 1;
137 m_maximum
/= m_factor
;
140 m_parentTop
= wxGetTopLevelParent(parent
);
142 // top-level sizerTop
143 wxSizer
* const sizerTop
= new wxBoxSizer(wxVERTICAL
);
145 m_msg
= new wxStaticText(this, wxID_ANY
, message
);
146 sizerTop
->Add(m_msg
, 0, wxLEFT
| wxTOP
, 2*LAYOUT_MARGIN
);
150 int gauge_style
= wxGA_HORIZONTAL
;
151 if ( style
& wxPD_SMOOTH
)
152 gauge_style
|= wxGA_SMOOTH
;
153 m_gauge
= new wxGauge
159 // make the progress bar sufficiently long
160 wxSize(wxMin(wxGetClientDisplayRect().width
/3, 300), -1),
164 sizerTop
->Add(m_gauge
, 0, wxLEFT
| wxRIGHT
| wxTOP
| wxEXPAND
, 2*LAYOUT_MARGIN
);
165 m_gauge
->SetValue(0);
172 // create the estimated/remaining/total time zones if requested
176 m_display_estimated
=
181 // also count how many labels we really have
182 size_t nTimeLabels
= 0;
184 wxSizer
* const sizerLabels
= new wxFlexGridSizer(2);
186 if ( style
& wxPD_ELAPSED_TIME
)
190 m_elapsed
= CreateLabel(_("Elapsed time:"), sizerLabels
);
193 if ( style
& wxPD_ESTIMATED_TIME
)
197 m_estimated
= CreateLabel(_("Estimated time:"), sizerLabels
);
200 if ( style
& wxPD_REMAINING_TIME
)
204 m_remaining
= CreateLabel(_("Remaining time:"), sizerLabels
);
206 sizerTop
->Add(sizerLabels
, 0, wxALIGN_CENTER_HORIZONTAL
| wxTOP
, LAYOUT_MARGIN
);
208 if ( nTimeLabels
> 0 )
210 // set it to the current time
211 m_timeStart
= wxGetCurrentTime();
214 #if defined(__SMARTPHONE__)
215 if ( m_hasSkipButton
)
216 SetRightMenu(wxID_SKIP
, _("Skip"));
217 if ( m_hasAbortButton
)
218 SetLeftMenu(wxID_CANCEL
);
223 wxBoxSizer
*buttonSizer
= new wxBoxSizer(wxHORIZONTAL
);
225 // Windows dialogs usually have buttons in the lower right corner
226 const int sizerFlags
=
227 #if defined(__WXMSW__) || defined(__WXPM__)
228 wxALIGN_RIGHT
| wxALL
230 wxALIGN_CENTER_HORIZONTAL
| wxBOTTOM
| wxTOP
234 if ( m_hasSkipButton
)
236 m_btnSkip
= new wxButton(this, wxID_SKIP
, _("&Skip"));
238 buttonSizer
->Add(m_btnSkip
, 0, sizerFlags
, LAYOUT_MARGIN
);
241 if ( m_hasAbortButton
)
243 m_btnAbort
= new wxButton(this, wxID_CANCEL
);
245 buttonSizer
->Add(m_btnAbort
, 0, sizerFlags
, LAYOUT_MARGIN
);
248 sizerTop
->Add(buttonSizer
, 0, sizerFlags
, LAYOUT_MARGIN
);
249 #endif // __SMARTPHONE__/!__SMARTPHONE__
251 SetSizerAndFit(sizerTop
);
253 Centre(wxCENTER_FRAME
| wxBOTH
);
255 if ( style
& wxPD_APP_MODAL
)
257 m_winDisabler
= new wxWindowDisabler(this);
262 m_parentTop
->Disable();
263 m_winDisabler
= NULL
;
269 // this one can be initialized even if the others are unknown for now
271 // NB: do it after calling Layout() to keep the labels correctly aligned
274 SetTimeLabel(0, m_elapsed
);
281 wxProgressDialog::CreateLabel(const wxString
& text
, wxSizer
*sizer
)
283 wxStaticText
*label
= new wxStaticText(this, wxID_ANY
, text
);
284 wxStaticText
*value
= new wxStaticText(this, wxID_ANY
, _("unknown"));
286 // select placement most native or nice on target GUI
287 #if defined(__SMARTPHONE__)
288 // value and time to the left in two rows
289 sizer
->Add(label
, 1, wxALIGN_LEFT
);
290 sizer
->Add(value
, 1, wxALIGN_LEFT
);
291 #elif defined(__WXMSW__) || defined(__WXPM__) || defined(__WXMAC__) || defined(__WXGTK20__)
292 // value and time centered in one row
293 sizer
->Add(label
, 1, wxLARGESMALL(wxALIGN_RIGHT
,wxALIGN_LEFT
) | wxTOP
| wxRIGHT
, LAYOUT_MARGIN
);
294 sizer
->Add(value
, 1, wxALIGN_LEFT
| wxTOP
, LAYOUT_MARGIN
);
296 // value and time to the right in one row
298 sizer
->Add(value
, 0, wxLEFT
, LAYOUT_MARGIN
);
304 // ----------------------------------------------------------------------------
305 // wxProgressDialog operations
306 // ----------------------------------------------------------------------------
309 wxProgressDialog::Update(int value
, const wxString
& newmsg
, bool *skip
)
311 if ( !DoBeforeUpdate(skip
) )
314 wxASSERT_MSG( value
== -1 || m_gauge
, wxT("cannot update non existent dialog") );
320 wxASSERT_MSG( value
<= m_maximum
, wxT("invalid progress value") );
323 m_gauge
->SetValue(value
);
325 UpdateMessage(newmsg
);
327 if ( (m_elapsed
|| m_remaining
|| m_estimated
) && (value
!= 0) )
329 unsigned long elapsed
= wxGetCurrentTime() - m_timeStart
;
330 if ( m_last_timeupdate
< elapsed
331 || value
== m_maximum
334 m_last_timeupdate
= elapsed
;
335 unsigned long estimated
= m_break
+
336 (unsigned long)(( (double) (elapsed
-m_break
) * m_maximum
) / ((double)value
)) ;
337 if ( estimated
> m_display_estimated
343 else if ( estimated
< m_display_estimated
353 if ( m_ctdelay
>= m_delay
// enough confirmations for a higher value
354 || m_ctdelay
<= (m_delay
*-1) // enough confirmations for a lower value
355 || value
== m_maximum
// to stay consistent
356 || elapsed
> m_display_estimated
// to stay consistent
357 || ( elapsed
> 0 && elapsed
< 4 ) // additional updates in the beginning
360 m_display_estimated
= estimated
;
365 long display_remaining
= m_display_estimated
- elapsed
;
366 if ( display_remaining
< 0 )
368 display_remaining
= 0;
371 SetTimeLabel(elapsed
, m_elapsed
);
372 SetTimeLabel(m_display_estimated
, m_estimated
);
373 SetTimeLabel(display_remaining
, m_remaining
);
376 if ( value
== m_maximum
)
378 if ( m_state
== Finished
)
380 // ignore multiple calls to Update(m_maximum): it may sometimes be
381 // troublesome to ensure that Update() is not called twice with the
382 // same value (e.g. because of the rounding errors) and if we don't
383 // return now we're going to generate asserts below
387 // so that we return true below and that out [Cancel] handler knew what
390 if( !HasFlag(wxPD_AUTO_HIDE
) )
394 #if defined(__WXMSW__) && !defined(__WXUNIVERSAL__)
398 if ( newmsg
.empty() )
400 // also provide the finishing message if the application didn't
401 m_msg
->SetLabel(_("Done."));
404 wxCHECK_MSG(wxEventLoopBase::GetActive(), false,
405 "wxProgressDialog::Update needs a running event loop");
407 // allow the window to repaint:
408 // NOTE: since we yield only for UI events with this call, there
409 // should be no side-effects
410 wxEventLoopBase::GetActive()->YieldFor(wxEVT_CATEGORY_UI
);
412 // NOTE: this call results in a new event loop being created
413 // and to a call to ProcessPendingEvents() (which may generate
414 // unwanted re-entrancies).
419 // reenable other windows before hiding this one because otherwise
420 // Windows wouldn't give the focus back to the window which had
421 // been previously focused because it would still be disabled
422 ReenableOtherWindows();
427 else // not at maximum yet
432 // update the display in case yielding above didn't do it
435 return m_state
!= Canceled
;
438 bool wxProgressDialog::Pulse(const wxString
& newmsg
, bool *skip
)
440 if ( !DoBeforeUpdate(skip
) )
443 wxASSERT_MSG( m_gauge
, wxT("cannot update non existent dialog") );
445 // show a bit of progress
448 UpdateMessage(newmsg
);
450 if (m_elapsed
|| m_remaining
|| m_estimated
)
452 unsigned long elapsed
= wxGetCurrentTime() - m_timeStart
;
454 SetTimeLabel(elapsed
, m_elapsed
);
455 SetTimeLabel((unsigned long)-1, m_estimated
);
456 SetTimeLabel((unsigned long)-1, m_remaining
);
461 return m_state
!= Canceled
;
464 bool wxProgressDialog::DoBeforeUpdate(bool *skip
)
466 wxCHECK_MSG(wxEventLoopBase::GetActive(), false,
467 "wxProgressDialog::DoBeforeUpdate needs a running event loop");
469 // we have to yield because not only we want to update the display but
470 // also to process the clicks on the cancel and skip buttons
471 // NOTE: using YieldFor() this call shouldn't give re-entrancy problems
472 // for event handlers not interested to UI/user-input events.
473 wxEventLoopBase::GetActive()->YieldFor(wxEVT_CATEGORY_UI
|wxEVT_CATEGORY_USER_INPUT
);
477 if ( m_skip
&& skip
&& !*skip
)
484 return m_state
!= Canceled
;
487 void wxProgressDialog::DoAfterUpdate()
489 wxCHECK_RET(wxEventLoopBase::GetActive(),
490 "wxProgressDialog::DoAfterUpdate needs a running event loop");
492 // allow the window to repaint:
493 // NOTE: since we yield only for UI events with this call, there
494 // should be no side-effects
495 wxEventLoopBase::GetActive()->YieldFor(wxEVT_CATEGORY_UI
);
498 void wxProgressDialog::Resume()
501 m_ctdelay
= m_delay
; // force an update of the elapsed/estimated/remaining time
502 m_break
+= wxGetCurrentTime()-m_timeStop
;
509 bool wxProgressDialog::Show( bool show
)
511 // reenable other windows before hiding this one because otherwise
512 // Windows wouldn't give the focus back to the window which had
513 // been previously focused because it would still be disabled
515 ReenableOtherWindows();
517 return wxDialog::Show(show
);
520 int wxProgressDialog::GetValue() const
523 return m_gauge
->GetValue();
527 int wxProgressDialog::GetRange() const
530 return m_gauge
->GetRange();
534 wxString
wxProgressDialog::GetMessage() const
536 return m_msg
->GetLabel();
539 void wxProgressDialog::SetRange(int maximum
)
541 wxASSERT_MSG(m_gauge
, "The dialog should have been constructed with a range > 0");
542 wxASSERT_MSG(maximum
> 0, "Invalid range");
544 m_gauge
->SetRange(maximum
);
547 #if defined(__WXMSW__) || defined(__WXPM__)
548 // we can't have values > 65,536 in the progress control under Windows, so
549 // scale everything down
550 m_factor
= m_maximum
/ 65536 + 1;
551 m_maximum
/= m_factor
;
556 bool wxProgressDialog::WasCancelled() const
558 return m_hasAbortButton
&& m_state
== Canceled
;
561 bool wxProgressDialog::WasSkipped() const
563 return m_hasSkipButton
&& m_skip
;
567 // ----------------------------------------------------------------------------
569 // ----------------------------------------------------------------------------
571 void wxProgressDialog::OnCancel(wxCommandEvent
& event
)
573 if ( m_state
== Finished
)
575 // this means that the count down is already finished and we're being
576 // shown as a modal dialog - so just let the default handler do the job
581 // request to cancel was received, the next time Update() is called we
585 // update the buttons state immediately so that the user knows that the
586 // request has been noticed
590 // save the time when the dialog was stopped
591 m_timeStop
= wxGetCurrentTime();
595 void wxProgressDialog::OnSkip(wxCommandEvent
& WXUNUSED(event
))
601 void wxProgressDialog::OnClose(wxCloseEvent
& event
)
603 if ( m_state
== Uncancelable
)
605 // can't close this dialog
608 else if ( m_state
== Finished
)
610 // let the default handler close the window as we already terminated
615 // next Update() will notice it
620 m_timeStop
= wxGetCurrentTime();
624 // ----------------------------------------------------------------------------
626 // ----------------------------------------------------------------------------
628 wxProgressDialog::~wxProgressDialog()
630 // normally this should have been already done, but just in case
631 ReenableOtherWindows();
634 void wxProgressDialog::ReenableOtherWindows()
636 if ( HasFlag(wxPD_APP_MODAL
) )
638 delete m_winDisabler
;
639 m_winDisabler
= NULL
;
644 m_parentTop
->Enable();
648 // ----------------------------------------------------------------------------
650 // ----------------------------------------------------------------------------
652 static void SetTimeLabel(unsigned long val
, wxStaticText
*label
)
658 if (val
!= (unsigned long)-1)
660 unsigned long hours
= val
/ 3600;
661 unsigned long minutes
= (val
% 3600) / 60;
662 unsigned long seconds
= val
% 60;
663 s
.Printf(wxT("%lu:%02lu:%02lu"), hours
, minutes
, seconds
);
670 if ( s
!= label
->GetLabel() )
675 void wxProgressDialog::EnableSkip(bool enable
)
679 #ifdef __SMARTPHONE__
681 SetRightMenu(wxID_SKIP
, _("Skip"));
686 m_btnSkip
->Enable(enable
);
691 void wxProgressDialog::EnableAbort(bool enable
)
695 #ifdef __SMARTPHONE__
697 SetLeftMenu(wxID_CANCEL
); // stock buttons makes Cancel label
702 m_btnAbort
->Enable(enable
);
707 void wxProgressDialog::EnableClose()
711 #ifdef __SMARTPHONE__
712 SetLeftMenu(wxID_CANCEL
, _("Close"));
716 m_btnAbort
->Enable();
717 m_btnAbort
->SetLabel(_("Close"));
723 void wxProgressDialog::UpdateMessage(const wxString
&newmsg
)
725 wxCHECK_RET(wxEventLoopBase::GetActive(),
726 "wxProgressDialog::UpdateMessage needs a running event loop");
728 if ( !newmsg
.empty() && newmsg
!= m_msg
->GetLabel() )
730 m_msg
->SetLabel(newmsg
);
732 // allow the window to repaint:
733 // NOTE: since we yield only for UI events with this call, there
734 // should be no side-effects
735 wxEventLoopBase::GetActive()->YieldFor(wxEVT_CATEGORY_UI
);
739 #endif // wxUSE_PROGRESSDLG