KiCad PCB EDA Suite
APP_PROGRESS_DIALOG Class Reference

wxProgressDialog with the option to also update the application progress on the taskbar More...

#include <app_progress_dialog.h>

Inheritance diagram for APP_PROGRESS_DIALOG:

Public Member Functions

 APP_PROGRESS_DIALOG (const wxString &aTitle, const wxString &aMessage, int aMaximum=100, wxWindow *aParent=nullptr, bool aIndeterminateTaskBarStatus=false, int aStyle=wxPD_APP_MODAL|wxPD_AUTO_HIDE)
 
virtual bool Update (int aValue, const wxString &aNewMsg=wxEmptyString, bool *aSkip=nullptr) override
 

Detailed Description

wxProgressDialog with the option to also update the application progress on the taskbar

Definition at line 36 of file app_progress_dialog.h.

Constructor & Destructor Documentation

◆ APP_PROGRESS_DIALOG()

APP_PROGRESS_DIALOG::APP_PROGRESS_DIALOG ( const wxString &  aTitle,
const wxString &  aMessage,
int  aMaximum = 100,
wxWindow *  aParent = nullptr,
bool  aIndeterminateTaskBarStatus = false,
int  aStyle = wxPD_APP_MODAL | wxPD_AUTO_HIDE 
)

Definition at line 28 of file app_progress_dialog.cpp.

31 : wxProgressDialog( aTitle,
32 aMessage == wxEmptyString ? wxString( wxT( " " ) ) : aMessage,
33 aMaximum, aParent, aStyle )
34#if wxCHECK_VERSION( 3, 1, 0 )
35 ,
36 m_appProgressIndicator( aParent, aMaximum ),
37 m_indeterminateTaskBarStatus( aIndeterminateTaskBarStatus )
38#endif
39
40{
41#if wxCHECK_VERSION( 3, 1, 0 )
42 if( m_indeterminateTaskBarStatus )
43 {
44 m_appProgressIndicator.Pulse();
45 }
46#endif
47}

Member Function Documentation

◆ Update()

bool APP_PROGRESS_DIALOG::Update ( int  aValue,
const wxString &  aNewMsg = wxEmptyString,
bool *  aSkip = nullptr 
)
overridevirtual

Definition at line 50 of file app_progress_dialog.cpp.

51{
52#if wxCHECK_VERSION( 3, 1, 0 )
53 if( !m_indeterminateTaskBarStatus )
54 {
55 m_appProgressIndicator.SetValue( aValue );
56 }
57#endif
58
59 return wxProgressDialog::Update( aValue, aNewMsg, aSkip );
60}

Referenced by SYMBOL_LIBS::LoadAllLibraries(), KICAD_MANAGER_FRAME::OnIdle(), and SYMBOL_EDIT_FRAME::SyncLibraries().


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