qgsprocessingtoolboxtreeview.h

Go to the documentation of this file.

/***************************************************************************
    qgsprocessingtoolboxtreeview.h
    -----------------------------
    begin                : July 2018
    copyright            : (C) 2018 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 QGSPROCESSINGTOOLBOXTREEVIEW_H
#define QGSPROCESSINGTOOLBOXTREEVIEW_H
 
#include "qgis.h"
#include "qgis_gui.h"
#include "qgsprocessingtoolboxmodel.h"
 
#include <QTreeView>
 
class QgsProcessingRegistry;
class QgsProcessingRecentAlgorithmLog;
class QgsProcessingAlgorithm;
class QgsProcessingFavoriteAlgorithmManager;


class GUI_EXPORT QgsProcessingToolboxTreeView : public QTreeView
{
    Q_OBJECT
 
  public:
    QgsProcessingToolboxTreeView(
      QWidget *parent SIP_TRANSFERTHIS = nullptr,
      QgsProcessingRegistry *registry = nullptr,
      QgsProcessingRecentAlgorithmLog *recentLog = nullptr,
      QgsProcessingFavoriteAlgorithmManager *favoriteManager = nullptr
    );

    void setRegistry( QgsProcessingRegistry *registry, QgsProcessingRecentAlgorithmLog *recentLog = nullptr, QgsProcessingFavoriteAlgorithmManager *favoriteManager = nullptr );

    void setToolboxProxyModel( QgsProcessingToolboxProxyModel *model SIP_TRANSFER );

    const QgsProcessingAlgorithm *algorithmForIndex( const QModelIndex &index );

    const QgsProcessingAlgorithm *selectedAlgorithm();

    const QgsProcessingParameterType *parameterTypeForIndex( const QModelIndex &index );

    const QgsProcessingParameterType *selectedParameterType();
 

    void setFilters( QgsProcessingToolboxProxyModel::Filters filters );

    QgsProcessingToolboxProxyModel::Filters filters() const;

    void setInPlaceLayer( QgsVectorLayer *layer );

    void setFilterParameter( const QgsProcessingParameterDefinition *parameterDefinition ) SIP_SKIP;

    void setFilterOutput( const QgsProcessingOutputDefinition *outputDefinition ) SIP_SKIP;
 
 
  public slots:

    void setFilterString( const QString &filter );

    void reset() override;
 
  protected:
    void keyPressEvent( QKeyEvent *event ) override;
 
  private:
    QgsProcessingToolboxProxyModel *mModel = nullptr;
    QgsProcessingToolboxModel *mToolboxModel = nullptr;

    QModelIndex findFirstVisibleAlgorithm( const QModelIndex &parent );
 
    friend class TestQgsProcessingModel;
};

#endif // QGSPROCESSINGTOOLBOXTREEVIEW_H