qgsfeedback.h

Go to the documentation of this file.

/***************************************************************************
  qgsfeedback.h
  --------------------------------------
  Date                 : July 2016
  Copyright            : (C) 2016 by Martin Dobias
  Email                : wonder dot sk at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSFEEDBACK_H
#define QGSFEEDBACK_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QObject>

class CORE_EXPORT QgsFeedback : public QObject
{
    Q_OBJECT
  public:
    QgsFeedback( QObject *parent SIP_TRANSFERTHIS = nullptr )
      : QObject( parent )
    {}
 
    ~QgsFeedback() override;
 
    // clang-format off
    bool isCanceled() const SIP_HOLDGIL { return mCanceled; }
    // clang-format on

    void setProgress( double progress )
    {
      // avoid flooding with too many events
      if ( static_cast< int >( mProgress * 10 ) != static_cast< int >( progress * 10 ) )
        emit progressChanged( progress );
 
      mProgress = progress;
    }

    double progress() const SIP_HOLDGIL { return mProgress; }

    unsigned long long processedCount() const SIP_HOLDGIL { return mProcessedCount; }

    void setProcessedCount( unsigned long long processedCount )
    {
      mProcessedCount = processedCount;
      emit processedCountChanged( processedCount );
    }

    static std::unique_ptr<QgsFeedback> createScaledFeedback(
      QgsFeedback *parentFeedback, double startPercentage, double endPercentage );
 
  public slots:

    void cancel()
    {
      if ( mCanceled )
        return;  // only emit the signal once
      mCanceled = true;
      emit canceled();
    }
 
  signals:
    void canceled();

    void progressChanged( double progress );

    void processedCountChanged( unsigned long long processedCount );
 
  private:
    bool mCanceled = false;
 
    double mProgress = 0.0;
    unsigned long long mProcessedCount = 0;
};
 
 
#endif // QGSFEEDBACK_H