wx_progress_reporters.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2017 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * Author: Tomasz Wlostowski <[email protected]>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef WX_PROGRESS_REPORTERS_H
#define WX_PROGRESS_REPORTERS_H
 
#include <wx/progdlg.h>
#include <wx/gauge.h>
#include <wx/appprogress.h>
 
#include <core/throttle.h>
#include <widgets/progress_reporter_base.h>
 
#define PR_NO_ABORT 0
#define PR_CAN_ABORT wxPD_CAN_ABORT
 
 
#if defined( _WIN32 ) && wxCHECK_VERSION( 3, 3, 0 )
// In order to get a dark mode compatible progress dialog on Windows with wx 3.3
#define WX_PROGRESS_REPORTER_BASE wxGenericProgressDialog
#else
#define WX_PROGRESS_REPORTER_BASE wxProgressDialog
#endif

class WX_PROGRESS_REPORTER : public PROGRESS_REPORTER_BASE, public WX_PROGRESS_REPORTER_BASE
{
public:
    WX_PROGRESS_REPORTER( wxWindow* aParent, const wxString& aTitle, int aNumPhases, int aCanAbort,
                          bool aReserveSpaceForMessage = true );
    ~WX_PROGRESS_REPORTER();

    void SetTitle( const wxString& aTitle ) override
    {
        WX_PROGRESS_REPORTER_BASE::SetTitle( aTitle );
    }

    static bool shouldRefresh( int aProgress, int aMaxProgress, int aPhase, int aNumPhases,
                               THROTTLE& aThrottle )
    {
        bool finalTick = aMaxProgress > 0 && aProgress >= aMaxProgress && aPhase + 1 >= aNumPhases;
 
        return finalTick || aThrottle.Ready();
    }
 
private:
    bool updateUI() override;
 
private:
    wxAppProgressIndicator m_appProgressIndicator;
    int                    m_messageWidth;
 
    // Rate-limit expensive dialog repaint and event draining.
    THROTTLE               m_updateThrottle;
    std::atomic_bool       m_lastUpdateResult;
};
 
 
class GAUGE_PROGRESS_REPORTER : public PROGRESS_REPORTER_BASE, public wxGauge
{
public:
    GAUGE_PROGRESS_REPORTER( wxWindow* aParent, int aNumPhases );
 
private:
    bool updateUI() override;
};
 
#endif