KiCad PCB EDA Suite
Loading...
Searching...
No Matches
git_progress.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 The 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 3
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/gpl-3.0.html
19 * or you may search the http://www.gnu.org website for the version 3 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 GIT_PROGRESS_H_
25#define GIT_PROGRESS_H_
26
28#include <import_export.h>
29
30#include <memory>
31
33{
34public:
37 {
38 m_progressReporter.reset();
39 }
40
41 void SetProgressReporter( std::unique_ptr<WX_PROGRESS_REPORTER> aProgressReporter )
42 {
43 m_progressReporter = std::move( aProgressReporter );
44 }
45
46 void ReportProgress( int aCurrent, int aTotal, const wxString& aMessage )
47 {
48
50 {
51 if( aCurrent == m_previousProgress || aTotal == 0 )
52 {
53 m_progressReporter->Pulse( aMessage );
54 }
55 else
56 {
57 m_progressReporter->SetCurrentProgress( static_cast<double>( aCurrent ) / aTotal );
58 m_progressReporter->Report( aMessage );
59 }
60
61 m_previousProgress = aCurrent;
62 m_progressReporter->KeepRefreshing();
63 }
64 }
65
66 virtual void UpdateProgress( int aCurrent, int aTotal, const wxString& aMessage ) {};
67
68
69protected:
71
72 std::unique_ptr<WX_PROGRESS_REPORTER> m_progressReporter;
73};
74
75#endif // GIT_PROGRESS_H__
void ReportProgress(int aCurrent, int aTotal, const wxString &aMessage)
int m_previousProgress
void SetProgressReporter(std::unique_ptr< WX_PROGRESS_REPORTER > aProgressReporter)
virtual void UpdateProgress(int aCurrent, int aTotal, const wxString &aMessage)
std::unique_ptr< WX_PROGRESS_REPORTER > m_progressReporter
#define APIEXPORT
Macros which export functions from a DLL/DSO.