qgstaskmanagerwidget.h

Go to the documentation of this file.

/***************************************************************************
                             qgstaskmanagerwidget.h
                             ----------------------
    begin                : April 2016
    copyright            : (C) 2016 by Nyall Dawson
    email                : nyall dot dawson 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 QGSTASKMANAGERWIDGET_H
#define QGSTASKMANAGERWIDGET_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsfloatingwidget.h"
#include "qgstaskmanager.h"
 
#include <QStyledItemDelegate>
#include <QToolButton>
 
class QgsTaskManager;
class QgsTask;
class QTreeView;
class QProgressBar;
class QgsTaskManagerModel;

class GUI_EXPORT QgsTaskManagerWidget : public QWidget
{
    Q_OBJECT
 
  public:
    QgsTaskManagerWidget( QgsTaskManager *manager, QWidget *parent SIP_TRANSFERTHIS = nullptr );
 
    ~QgsTaskManagerWidget() override;
 
  private slots:
 
    void modelRowsInserted( const QModelIndex &index, int start, int end );
    void clicked( const QModelIndex &index );
 
  private:
    QgsTaskManager *mManager = nullptr;
    QTreeView *mTreeView = nullptr;
    QgsTaskManagerModel *mModel = nullptr;
};
 
#ifndef SIP_RUN


class GUI_EXPORT QgsTaskManagerFloatingWidget : public QgsFloatingWidget
{
    Q_OBJECT
 
  public:
    QgsTaskManagerFloatingWidget( QgsTaskManager *manager, QWidget *parent = nullptr );
};

class GUI_EXPORT QgsTaskManagerStatusBarWidget : public QToolButton
{
    Q_OBJECT
 
  public:
    QgsTaskManagerStatusBarWidget( QgsTaskManager *manager, QWidget *parent = nullptr );
 
    QSize sizeHint() const override;
 
  protected:
    void changeEvent( QEvent *event ) override;
 
  private slots:
 
    void toggleDisplay();
    void overallProgressChanged( double progress );
    void countActiveTasksChanged( int count );
    void allFinished();
    void showButton();
 
  private:
    QgsTaskManagerFloatingWidget *mFloatingWidget = nullptr;
    QProgressBar *mProgressBar = nullptr;
    QgsTaskManager *mManager = nullptr;
};

class GUI_EXPORT QgsTaskManagerModel : public QAbstractItemModel
{
    Q_OBJECT
 
  public:
    enum Columns
    {
      Description = 0,
      Progress = 1,
      Status = 2,
    };
 
    // *INDENT-OFF*

    enum class CustomRole SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsTaskManagerModel, Roles ) : int
    {
      Status SIP_MONKEYPATCH_COMPAT_NAME( StatusRole ) = Qt::UserRole, 
    };
    Q_ENUM( CustomRole )
    // *INDENT-ON*
 
    
    explicit QgsTaskManagerModel( QgsTaskManager *manager, QObject *parent = nullptr );
 
    //reimplemented QAbstractItemModel methods
    QModelIndex index( int row, int column, const QModelIndex &parent = QModelIndex() ) const override;
    QModelIndex parent( const QModelIndex &index ) const override;
    int rowCount( const QModelIndex &parent = QModelIndex() ) const override;
    int columnCount( const QModelIndex &parent = QModelIndex() ) const override;
    QVariant data( const QModelIndex &index, int role = Qt::DisplayRole ) const override;
    Qt::ItemFlags flags( const QModelIndex &index ) const override;
    bool setData( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole ) override;

    QgsTask *indexToTask( const QModelIndex &index ) const;
 
  private slots:
 
    void taskAdded( long id );
    void taskDeleted( long id );
    void progressChanged( long id, double progress );
    void statusChanged( long id, int status );
 
  private:
    enum ToolTipType
    {
      ToolTipDescription,
      ToolTipStatus,
      ToolTipProgress,
    };
 
    QgsTaskManager *mManager = nullptr;
 
    QList<long> mRowToTaskIdList;
 
 
    int idToRow( long id ) const;
    QModelIndex idToIndex( long id, int column ) const;
    static QString createTooltip( QgsTask *task, ToolTipType type );
 
    friend class QgsTaskManagerStatusBarWidget;
};

class GUI_EXPORT QgsTaskStatusWidget : public QWidget
{
    Q_OBJECT
 
  public:
    QgsTaskStatusWidget( QWidget *parent = nullptr, QgsTask::TaskStatus status = QgsTask::Queued, bool canCancel = true );
 
 
    QSize sizeHint() const override;
 
    //bool editorEvent( QEvent * event, QAbstractItemModel * model, const QStyleOptionViewItem & option, const QModelIndex & index ) override;
 
  public slots:

    void setStatus( int status );
 
  signals:

    void cancelClicked();
 
  protected:
    void paintEvent( QPaintEvent *e ) override;
    void mousePressEvent( QMouseEvent *e ) override;
    void mouseMoveEvent( QMouseEvent *e ) override;
    void leaveEvent( QEvent *e ) override;
 
  private:
    bool mCanCancel;
    QgsTask::TaskStatus mStatus;
    bool mInside = false;
};

 
#endif
 
#endif //QGSTASKMANAGERWIDGET_H