TimerProgressDialog Class Reference

#include <ProgressDialog.h>

Inheritance diagram for TimerProgressDialog:

Collaboration diagram for TimerProgressDialog:

Public Member Functions
	TimerProgressDialog (const wxLongLong_t duration, const TranslatableString &title, const MessageTable &columns, int flags=pdlgDefaultFlags, const TranslatableString &sRemainingLabelText={})
ProgressResult	UpdateProgress ()
Public Member Functions inherited from ProgressDialog
	ProgressDialog ()
	Methods for ProgressDialog. More...
	ProgressDialog (const TranslatableString &title, const TranslatableString &message={}, int flags=pdlgDefaultFlags, const TranslatableString &sRemainingLabelText={})
virtual	~ProgressDialog ()
bool	Create (const TranslatableString &title, const TranslatableString &message={}, int flags=pdlgDefaultFlags, const TranslatableString &sRemainingLabelText={})
void	Reinit () override
	Reset the dialog state. More...
void	SetDialogTitle (const TranslatableString &title) override
	Change the dialog's title. More...
ProgressResult	Update (int value, const TranslatableString &message={})
ProgressResult	Update (double current, const TranslatableString &message={})
ProgressResult	Update (double current, double total, const TranslatableString &message={})
ProgressResult	Update (wxULongLong_t current, wxULongLong_t total, const TranslatableString &message={})
ProgressResult	Update (wxLongLong current, wxLongLong total, const TranslatableString &message={})
ProgressResult	Update (wxLongLong_t current, wxLongLong_t total, const TranslatableString &message={})
ProgressResult	Update (int current, int total, const TranslatableString &message={})
ProgressResult	Poll (unsigned long long numerator, unsigned long long denominator, const TranslatableString &message={}) override
	Update the bar and poll for clicks. Call only on the main thread. More...
void	SetMessage (const TranslatableString &message) override
	Change an existing dialog's message. More...
Public Member Functions inherited from wxDialogWrapper
	wxDialogWrapper ()
	wxDialogWrapper (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
bool	Create (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
void	SetTitle (const TranslatableString &title)
void	SetLabel (const TranslatableString &title)
void	SetName (const TranslatableString &title)
void	SetName ()
Public Member Functions inherited from wxTabTraversalWrapper< wxDialog >
	wxTabTraversalWrapper (Args &&... args)
	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete
wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete
virtual	~ProgressDialog ()
virtual ProgressResult	Poll (unsigned long long numerator, unsigned long long denominator, const TranslatableString &message={})=0
	Update the bar and poll for clicks. Call only on the main thread. More...
virtual void	SetMessage (const TranslatableString &message)=0
	Change an existing dialog's message. More...
virtual void	SetDialogTitle (const TranslatableString &title)=0
	Change the dialog's title. More...
virtual void	Reinit ()=0
	Reset the dialog state. More...

Protected Member Functions
ProgressResult	Update (int value, const TranslatableString &message={})
ProgressResult	Update (double current, const TranslatableString &message={})
ProgressResult	Update (double current, double total, const TranslatableString &message={})
ProgressResult	Update (wxULongLong_t current, wxULongLong_t total, const TranslatableString &message={})
ProgressResult	Update (wxLongLong current, wxLongLong total, const TranslatableString &message={})
ProgressResult	Update (wxLongLong_t current, wxLongLong_t total, const TranslatableString &message={})
ProgressResult	Update (int current, int total, const TranslatableString &message={})
Protected Member Functions inherited from ProgressDialog
	ProgressDialog (const TranslatableString &title, const MessageTable &columns, int flags=pdlgDefaultFlags, const TranslatableString &sRemainingLabelText={})
bool	Create (const TranslatableString &title, const MessageTable &columns, int flags=pdlgDefaultFlags, const TranslatableString &sRemainingLabelText={})

Protected Attributes
wxLongLong_t	mDuration
Protected Attributes inherited from ProgressDialog
wxWindowRef	mHadFocus
wxStaticText *	mElapsed
wxStaticText *	mRemaining
wxGauge *	mGauge
wxLongLong_t	mStartTime
wxLongLong_t	mLastUpdate
wxLongLong_t	mYieldTimer
wxLongLong_t	mElapsedTime {}
int	mLastValue
bool	mCancel
bool	mStop
bool	mIsTransparent
bool	m_bShowElapsedTime = true
bool	m_bConfirmAction = false

Additional Inherited Members
Public Types inherited from ProgressDialog
using	MessageColumn = std::vector< TranslatableString >
using	MessageTable = std::vector< MessageColumn >

Detailed Description

Definition at line 165 of file ProgressDialog.h.

Constructor & Destructor Documentation

TimerProgressDialog()

TimerProgressDialog::TimerProgressDialog	(	const wxLongLong_t	duration,
		const TranslatableString &	title,
		const MessageTable &	columns,
		int	flags = pdlgDefaultFlags,
		const TranslatableString &	sRemainingLabelText = {}
	)

Definition at line 1712 of file ProgressDialog.cpp.

: ProgressDialog(title, columns, flags, sRemainingLabelText)
{
   mDuration = duration;
}

References mDuration.

Member Function Documentation

Update() [1/7]

ProgressResult ProgressDialog::Update ( double  current, const TranslatableString &  message = {}  )

protected

Definition at line 97 of file ProgressDialog.cpp.

{
   return Update((int)(current * 1000), message);
}

Update() [2/7]

ProgressResult ProgressDialog::Update ( double  current, double  total, const TranslatableString &  message = {}  )

protected

Definition at line 98 of file ProgressDialog.cpp.

{
   if (total != 0)
   {
      return Update((int)(current * 1000.0 / total), message);
   }
   else
   {
      return Update(1000, message);
   }
}

Update() [3/7]

ProgressResult ProgressDialog::Update ( int  current, int  total, const TranslatableString &  message = {}  )

protected

Definition at line 102 of file ProgressDialog.cpp.

{
   if (total != 0)
   {
      return Update((int)(current *  ((double)(1000.0 / total))), message);
   }
   else
   {
      return Update(1000, message);
   }
}

Update() [4/7]

ProgressResult ProgressDialog::Update ( int  value, const TranslatableString &  message = {}  )

protected

Definition at line 96 of file ProgressDialog.cpp.

{
   using namespace std::chrono;
   auto updatePollTime = finally([this, pollStart = high_resolution_clock::now()] {
         mTotalPollTime += high_resolution_clock::now() - pollStart;
   });
 
   mPollsCount++;
   
   if (mCancel)
   {
      // for compatibility with old Update, that returned false on cancel
      return ProgressResult::Cancelled;
   }
   else if (mStop)
   {
      return ProgressResult::Stopped;
   }
 
   wxLongLong_t now = wxGetUTCTimeMillis().GetValue();
   mElapsedTime = now - mStartTime;
 
   if (mElapsedTime < 500)
   {
      return ProgressResult::Success;
   }
 
   if (mIsTransparent)
   {
      SetTransparent(255);
      mIsTransparent = false;
   }
 
   if (value <= 0)
   {
      value = 1;
   }
 
   if (value > 1000)
   {
      value = 1000;
   }
 
   wxLongLong_t estimate = mElapsedTime * 1000ll / value;
   wxLongLong_t remains = (estimate + mStartTime) - now;
 
   SetMessage(message);
 
   if (value != mLastValue)
   {
      mGauge->SetValue(value);
      mGauge->Update();
      mLastValue = value;
   }
 
   // Only update if a full second has passed or track progress is complete
   if ((now - mLastUpdate > 1000) || (value == 1000))
   {
      if (m_bShowElapsedTime) {
         wxTimeSpan tsElapsed(0, 0, 0, mElapsedTime);
         mElapsed->SetLabel(tsElapsed.Format(wxT("%H:%M:%S")));
         mElapsed->SetName(mElapsed->GetLabel()); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
         mElapsed->Update();
      }
 
      wxTimeSpan tsRemains(0, 0, 0, remains);
      mRemaining->SetLabel(tsRemains.Format(wxT("%H:%M:%S")));
      mRemaining->SetName(mRemaining->GetLabel()); // fix for bug 577 (NVDA/Narrator screen readers do not read static text in dialogs)
      mRemaining->Update();
 
      mLastUpdate = now;
   }
 
   wxDialogWrapper::Update();
 
   // Copied from wx 3.0.2 generic progress dialog
   //
   // 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.
   //
   // LL:  Added timer category to prevent extreme delays when processing effects
   //      (and probably other things).  I do not yet know why this happens and
   //      I'm not too keen on having timer events processed here, but you do
   //      what you have to do.
 
   // Nyquist effects call Update on every callback, but YieldFor is
   // quite slow on Linux / Mac, so don't call too frequently. (bug 1575)
   if ((now - mYieldTimer > 50) || (value == 1000)) {
      const auto yieldStart = high_resolution_clock::now();
      mYieldsCount++;
      wxEventLoopBase::GetActive()->YieldFor(wxEVT_CATEGORY_UI | wxEVT_CATEGORY_USER_INPUT | wxEVT_CATEGORY_TIMER);
      mTotalYieldTime += high_resolution_clock::now() - yieldStart;
      mYieldTimer = now;
   }
 
   return ProgressResult::Success;
}

Update() [5/7]

ProgressResult ProgressDialog::Update ( wxLongLong  current, wxLongLong  total, const TranslatableString &  message = {}  )

protected

Definition at line 100 of file ProgressDialog.cpp.

{
   if (total.GetValue() != 0)
   {
      return Update((int)(current.GetValue() * 1000ll / total.GetValue()), message);
   }
   else
   {
      return Update(1000, message);
   }
}

Update() [6/7]

ProgressResult ProgressDialog::Update ( wxLongLong_t  current, wxLongLong_t  total, const TranslatableString &  message = {}  )

protected

Definition at line 101 of file ProgressDialog.cpp.

{
   if (total != 0)
   {
      return Update((int)(current * 1000ll / total), message);
   }
   else
   {
      return Update(1000, message);
   }
}

Update() [7/7]

ProgressResult ProgressDialog::Update ( wxULongLong_t  current, wxULongLong_t  total, const TranslatableString &  message = {}  )

protected

Definition at line 99 of file ProgressDialog.cpp.

{
   if (total != 0)
   {
      return Update((int)(current * 1000 / total), message);
   }
   else
   {
      return Update(1000, message);
   }
}

UpdateProgress()

ProgressResult TimerProgressDialog::UpdateProgress

(

)

Definition at line 1722 of file ProgressDialog.cpp.

{
   if (mCancel)
   {
      // for compatibility with old Update, that returned false on cancel
      return ProgressResult::Cancelled;
   }
   else if (mStop)
   {
      return ProgressResult::Stopped;
   }
 
   wxLongLong_t now = wxGetUTCTimeMillis().GetValue();
   wxLongLong_t elapsed = now - mStartTime;
 
   if (elapsed < 500)
   {
      return ProgressResult::Success;
   }
 
   if (mIsTransparent)
   {
      SetTransparent(255);
      mIsTransparent = false;
   }
 
   wxLongLong_t remains = mStartTime + mDuration - now;
 
   int nGaugeValue = (1000 * elapsed) / mDuration; // range = [0,1000]
   // Running in TimerRecordDialog::RunWaitDialog(), for some unknown reason, 
   // nGaugeValue here is often a little over 1000. 
   // From testing, it's never shown bigger than 1009, but 
   // give it a little extra, to 1010. 
   //   wxASSERT((nGaugeValue >= 0) && (nGaugeValue <= 1000)); // This ought to work. 
   // wxASSERT((nGaugeValue >= 0) && (nGaugeValue <= 1010));
   //
   // stf. Update was being called after wxMilliSleep(<ms>), which could be up to <ms>
   // beyond the completion time. My guess is that the microsleep in RunWaitDialog was originally 10 ms
   // (same as other uses of Update) but was updated to kTimerInterval = 50 ms, thus triggering
   // the Assert (Bug 1367). By calling Update() before sleeping then I think nGaugeValue <= 1000 should work.
   wxASSERT((nGaugeValue >= 0) && (nGaugeValue <= 1000));
 
   if (nGaugeValue != mLastValue)
   {
      mGauge->SetValue(nGaugeValue);
      mGauge->Update();
      mLastValue = nGaugeValue;
   }
 
   // Only update if a full second has passed.
   if (now - mLastUpdate > 1000)
   {
      // Bug 1952:
      // wxTimeSpan will assert on ridiculously large values.
      // We silently wrap the displayed range at one day.
      // You'll only see the remaining hours, mins and secs.
      // With a + sign, if the time was wrapped.
      const wxLongLong_t wrapTime = 24 * 60 * 60 * 1000;
      if (m_bShowElapsedTime) {
         wxTimeSpan tsElapsed(0, 0, 0, elapsed % wrapTime);
         mElapsed->SetLabel(tsElapsed.Format(wxT("%H:%M:%S")) + ((elapsed >= wrapTime) ? " +":""));
         mElapsed->Update();
      }
 
      wxTimeSpan tsRemains(0, 0, 0, remains % wrapTime);
      mRemaining->SetLabel(tsRemains.Format(wxT("%H:%M:%S")) + ((remains >= wrapTime) ? " +":""));
      mRemaining->Update();
 
      mLastUpdate = now;
   }
 
   // Copied from wx 3.0.2 generic progress dialog
   //
   // 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.
   //
   // LL:  Added timer category to prevent extreme delays when processing effects
   //      (and probably other things).  I do not yet know why this happens and
   //      I'm not too keen on having timer events processed here, but you do
   //      what you have to do.
   // JKC: Added thread category, since blocking a thread message could cause things 
   //      to gum up.  
   //      See http://trac.wxwidgets.org/ticket/14027 for discussion of why
   //      YieldFor is flaky.  
   //      Conclusion...  use wxEVT_CATEGORY_ALL since with the list below, we 
   //      are pretty much there already.
   //           wxEVT_CATEGORY_UI |
   //           wxEVT_CATEGORY_USER_INPUT |
   //           wxEVT_CATEGORY_TIMER |
   //           wxEVT_CATEGORY_THREAD
 
   wxEventLoopBase::GetActive()->YieldFor(wxEVT_CATEGORY_ALL );
   // JKC: Yielding twice, because e.g. a timer can build up a lot of events, and we 
   //      really want to make sure they are worked through.
   wxEventLoopBase::GetActive()->YieldFor(wxEVT_CATEGORY_ALL );
 
   // MY: Added this after the YieldFor to check we haven't changed the outcome based on buttons pressed...
   auto iReturn = ProgressResult::Success;
   if (mCancel)
   {
      iReturn = ProgressResult::Cancelled;
   }
   else if (mStop)
   {
      iReturn = ProgressResult::Stopped;
   }
   return iReturn;
}

References BasicUI::Cancelled, ProgressDialog::m_bShowElapsedTime, ProgressDialog::mCancel, mDuration, ProgressDialog::mElapsed, ProgressDialog::mGauge, ProgressDialog::mIsTransparent, ProgressDialog::mLastUpdate, ProgressDialog::mLastValue, ProgressDialog::mRemaining, ProgressDialog::mStartTime, ProgressDialog::mStop, BasicUI::Stopped, BasicUI::Success, and wxT().

Referenced by TimerRecordDialog::PreActionDelay(), TimerRecordDialog::RunWaitDialog(), and TimerRecordDialog::WaitForStart().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mDuration

wxLongLong_t TimerProgressDialog::mDuration

protected

Definition at line 179 of file ProgressDialog.h.

Referenced by TimerProgressDialog(), and UpdateProgress().

---

The documentation for this class was generated from the following files:

• ProgressDialog.h
• ProgressDialog.cpp