progress_reporter.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 PROGRESS_REPORTER_H
#define PROGRESS_REPORTER_H
 
#include <kicommon.h>
#include <wx/wx.h>

class KICOMMON_API PROGRESS_REPORTER
{
public:
 
    PROGRESS_REPORTER()
    { }
 
    PROGRESS_REPORTER( const PROGRESS_REPORTER& ) = delete;
 
    virtual ~PROGRESS_REPORTER()
    { }

    virtual void SetNumPhases( int aNumPhases ) = 0;
    virtual void AddPhases( int aNumPhases ) = 0;

    virtual void BeginPhase( int aPhase ) = 0;

    virtual void AdvancePhase() = 0;

    virtual void AdvancePhase( const wxString& aMessage ) = 0;

    virtual void Report( const wxString& aMessage ) = 0;

    virtual void SetCurrentProgress( double aProgress ) = 0;

    virtual void SetMaxProgress( int aMaxProgress ) = 0;

    virtual void AdvanceProgress() = 0;

    virtual bool KeepRefreshing( bool aWait = false ) = 0;

    virtual void SetTitle( const wxString& aTitle ) = 0;
 
    virtual bool IsCancelled() const = 0;
};
 
 
#endif