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=NULL, bool aIndeterminateTaskBarStatus=false, int aStyle=wxPD_APP_MODAL|wxPD_AUTO_HIDE)
 
virtual bool Update (int aValue, const wxString &aNewMsg=wxEmptyString, bool *aSkip=NULL) override
 

Detailed Description

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

Definition at line 35 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 = NULL,
bool  aIndeterminateTaskBarStatus = false,
int  aStyle = wxPD_APP_MODAL | wxPD_AUTO_HIDE 
)

Definition at line 28 of file app_progress_dialog.cpp.

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

Member Function Documentation

◆ Update()

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

Definition at line 48 of file app_progress_dialog.cpp.

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

Referenced by SYMBOL_TREE_MODEL_ADAPTER::AddLibraries(), PART_LIBS::LoadAllLibraries(), and KICAD_MANAGER_FRAME::OnIdle().


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