KiCad PCB EDA Suite
app_progress_dialog.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KiCad, a free EDA CAD application.
3  *
4  * Copyright (C) 2020-2021 KiCad Developers, see AUTHORS.txt for contributors.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, you may find one here:
18  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19  * or you may search the http://www.gnu.org website for the version 2 license,
20  * or you may write to the Free Software Foundation, Inc.,
21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22  */
23 
24 #ifndef __APP_PROGRESS_REPORTER
25 #define __APP_PROGRESS_REPORTER
26 
27 #include <wx/progdlg.h>
28 
29 #if wxCHECK_VERSION( 3, 1, 0 )
30 #include <wx/appprogress.h>
31 #endif
32 
36 class APP_PROGRESS_DIALOG : public wxProgressDialog
37 {
38 public:
39  APP_PROGRESS_DIALOG( const wxString& aTitle, const wxString& aMessage, int aMaximum = 100,
40  wxWindow* aParent = nullptr, bool aIndeterminateTaskBarStatus = false,
41  int aStyle = wxPD_APP_MODAL | wxPD_AUTO_HIDE );
42 
43  virtual bool Update( int aValue, const wxString& aNewMsg = wxEmptyString,
44  bool* aSkip = nullptr ) override;
45 
46 
47 private:
48 #if wxCHECK_VERSION( 3, 1, 0 )
49  wxAppProgressIndicator m_appProgressIndicator;
50  bool m_indeterminateTaskBarStatus;
51 #endif
52 };
53 
54 #endif
virtual bool Update(int aValue, const wxString &aNewMsg=wxEmptyString, bool *aSkip=nullptr) override
wxProgressDialog with the option to also update the application progress on the taskbar
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)