Audacity 3.2.0
Public Member Functions | List of all members
BasicUI::ProgressDialog Class Referenceabstract

Abstraction of a progress dialog with well defined time-to-completion estimate. More...

#include <BasicUI.h>

Inheritance diagram for BasicUI::ProgressDialog:
[legend]

Public Member Functions

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...
 

Detailed Description

Abstraction of a progress dialog with well defined time-to-completion estimate.

Definition at line 153 of file BasicUI.h.

Constructor & Destructor Documentation

◆ ~ProgressDialog()

ProgressDialog::~ProgressDialog ( )
virtualdefault

Reimplemented in ProgressDialog.

Member Function Documentation

◆ Poll()

virtual ProgressResult BasicUI::ProgressDialog::Poll ( unsigned long long  numerator,
unsigned long long  denominator,
const TranslatableString message = {} 
)
pure virtual

Update the bar and poll for clicks. Call only on the main thread.

Implemented in cloud::audiocom::ShareAudioDialog::ExportProgressHelper, and ProgressDialog.

Referenced by WaveClip::Resample(), Effect::TotalProgress(), Effect::TrackGroupProgress(), and Effect::TrackProgress().

Here is the caller graph for this function:

◆ Reinit()

virtual void BasicUI::ProgressDialog::Reinit ( )
pure virtual

Reset the dialog state.

Implemented in cloud::audiocom::ShareAudioDialog::ExportProgressHelper, and ProgressDialog.

◆ SetDialogTitle()

virtual void BasicUI::ProgressDialog::SetDialogTitle ( const TranslatableString title)
pure virtual

Change the dialog's title.

Implemented in cloud::audiocom::ShareAudioDialog::ExportProgressHelper, and ProgressDialog.

◆ SetMessage()

virtual void BasicUI::ProgressDialog::SetMessage ( const TranslatableString message)
pure virtual

Change an existing dialog's message.

Implemented in cloud::audiocom::ShareAudioDialog::ExportProgressHelper, and ProgressDialog.

Referenced by EffectStereoToMono::Process().

Here is the caller graph for this function:

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