Audacity  2.2.0
ProgressDialog Class Reference

ProgressDialog Class. More...

#include <ProgressDialog.h>

Inheritance diagram for ProgressDialog:
wxTabTraversalWrapper< Base > TimerProgressDialog

Public Member Functions

 ProgressDialog ()
 Methods for ProgressDialog. More...
 
 ProgressDialog (const wxString &title, const wxString &message=wxEmptyString, int flags=pdlgDefaultFlags, const wxString &sRemainingLabelText=wxEmptyString)
 
virtual ~ProgressDialog ()
 
virtual bool Create (const wxString &title, const wxString &message=wxEmptyString, int flags=pdlgDefaultFlags, const wxString &sRemainingLabelText=wxEmptyString)
 
ProgressResult Update (int value, const wxString &message=wxEmptyString)
 
ProgressResult Update (double current, const wxString &message=wxEmptyString)
 
ProgressResult Update (double current, double total, const wxString &message=wxEmptyString)
 
ProgressResult Update (wxULongLong_t current, wxULongLong_t total, const wxString &message=wxEmptyString)
 
ProgressResult Update (wxLongLong current, wxLongLong total, const wxString &message=wxEmptyString)
 
ProgressResult Update (wxLongLong_t current, wxLongLong_t total, const wxString &message=wxEmptyString)
 
ProgressResult Update (int current, int total, const wxString &message=wxEmptyString)
 
void SetMessage (const wxString &message)
 
- Public Member Functions inherited from wxTabTraversalWrapper< Base >
template<typename... Args>
 wxTabTraversalWrapper (Args &&...args)
 
 ~wxTabTraversalWrapper ()
 

Static Public Attributes

static const wxChar ColoumnSplitMarker = (char)23
 

Protected Attributes

wxWindow * mHadFocus
 
wxStaticText * mElapsed
 
wxStaticText * mRemaining
 
wxGauge * mGauge
 
wxLongLong_t mStartTime
 
wxLongLong_t mLastUpdate
 
wxLongLong_t mYieldTimer
 
int mLastValue
 
bool mCancel
 
bool mStop
 
bool mIsTransparent
 
bool m_bShowElapsedTime = true
 
bool m_bConfirmAction = false
 

Private Member Functions

void Init ()
 
bool SearchForWindow (const wxWindowList &list, const wxWindow *searchfor) const
 
void OnCancel (wxCommandEvent &e)
 
void OnStop (wxCommandEvent &e)
 
void OnCloseWindow (wxCloseEvent &e)
 
void Beep () const
 
bool ConfirmAction (const wxString &sPrompt, const wxString &sTitle, int iButtonID=-1)
 
void AddMessageAsColumn (wxBoxSizer *pSizer, const wxString &sText, bool bFirstColumn)
 

Private Attributes

wxEventLoopGuarantor mLoop
 
std::unique_ptr< wxWindowDisabler > mDisable
 
wxStaticText * mMessage
 
int mLastW
 
int mLastH
 

Detailed Description

ProgressDialog Class.

Custom progress dialog with Audacity specific semantics.

Constructor & Destructor Documentation

ProgressDialog::ProgressDialog ( )

Methods for ProgressDialog.

ProgressDialog::ProgressDialog ( const wxString &  title,
const wxString &  message = wxEmptyString,
int  flags = pdlgDefaultFlags,
const wxString &  sRemainingLabelText = wxEmptyString 
)

References Create(), and Init().

ProgressDialog::~ProgressDialog ( )
virtual

Member Function Documentation

void ProgressDialog::AddMessageAsColumn ( wxBoxSizer *  pSizer,
const wxString &  sText,
bool  bFirstColumn 
)
private

References mMessage, and safenew.

Referenced by Create().

void ProgressDialog::Beep ( ) const
private

References beep, gPrefs, mStartTime, and name.

Referenced by ~ProgressDialog().

bool ProgressDialog::ConfirmAction ( const wxString &  sPrompt,
const wxString &  sTitle,
int  iButtonID = -1 
)
private

References m_bConfirmAction.

Referenced by OnCancel(), OnCloseWindow(), and OnStop().

bool ProgressDialog::Create ( const wxString &  title,
const wxString &  message = wxEmptyString,
int  flags = pdlgDefaultFlags,
const wxString &  sRemainingLabelText = wxEmptyString 
)
virtual
void ProgressDialog::Init ( )
private

References mDisable, mHadFocus, mIsTransparent, and mLastValue.

Referenced by ProgressDialog().

void ProgressDialog::OnCancel ( wxCommandEvent &  e)
private

References _(), ConfirmAction(), and mCancel.

void ProgressDialog::OnCloseWindow ( wxCloseEvent &  e)
private

References _(), ConfirmAction(), and mCancel.

void ProgressDialog::OnStop ( wxCommandEvent &  e)
private

References _(), ConfirmAction(), mCancel, and mStop.

bool ProgressDialog::SearchForWindow ( const wxWindowList &  list,
const wxWindow *  searchfor 
) const
private

Referenced by ~ProgressDialog().

void ProgressDialog::SetMessage ( const wxString &  message)

References mLastH, mLastW, and mMessage.

Referenced by Update(), and TimerProgressDialog::Update().

ProgressResult ProgressDialog::Update ( double  current,
const wxString &  message = wxEmptyString 
)

References Update().

ProgressResult ProgressDialog::Update ( double  current,
double  total,
const wxString &  message = wxEmptyString 
)

References Update().

ProgressResult ProgressDialog::Update ( wxULongLong_t  current,
wxULongLong_t  total,
const wxString &  message = wxEmptyString 
)

References Update().

ProgressResult ProgressDialog::Update ( wxLongLong  current,
wxLongLong  total,
const wxString &  message = wxEmptyString 
)

References Update().

ProgressResult ProgressDialog::Update ( wxLongLong_t  current,
wxLongLong_t  total,
const wxString &  message = wxEmptyString 
)

References Update().

ProgressResult ProgressDialog::Update ( int  current,
int  total,
const wxString &  message = wxEmptyString 
)

References Update().

Member Data Documentation

const wxChar ProgressDialog::ColoumnSplitMarker = (char)23
static
bool ProgressDialog::m_bConfirmAction = false
protected

Referenced by ConfirmAction(), and Create().

bool ProgressDialog::m_bShowElapsedTime = true
protected
bool ProgressDialog::mCancel
protected
std::unique_ptr<wxWindowDisabler> ProgressDialog::mDisable
private

Referenced by Create(), Init(), and ~ProgressDialog().

wxStaticText* ProgressDialog::mElapsed
protected
wxGauge* ProgressDialog::mGauge
protected
wxWindow* ProgressDialog::mHadFocus
protected

Referenced by Init(), and ~ProgressDialog().

bool ProgressDialog::mIsTransparent
protected
int ProgressDialog::mLastH
private

Referenced by Create(), and SetMessage().

wxLongLong_t ProgressDialog::mLastUpdate
protected
int ProgressDialog::mLastValue
protected
int ProgressDialog::mLastW
private

Referenced by Create(), and SetMessage().

wxEventLoopGuarantor ProgressDialog::mLoop
private
wxStaticText* ProgressDialog::mMessage
private

Referenced by AddMessageAsColumn(), and SetMessage().

wxStaticText* ProgressDialog::mRemaining
protected
wxLongLong_t ProgressDialog::mStartTime
protected
bool ProgressDialog::mStop
protected
wxLongLong_t ProgressDialog::mYieldTimer
protected

Referenced by Create(), and Update().


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