qgsprocessingaggregatewidgets.h

Go to the documentation of this file.

/***************************************************************************
  qgsprocessingaggregatewidgets.h
  ---------------------
  Date                 : June 2020
  Copyright            : (C) 2020 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 QGSPROCESSINGAGGREGATEWIDGETS_H
#define QGSPROCESSINGAGGREGATEWIDGETS_H
 
#include "qgsexpressioncontextgenerator.h"
#include "qgsfieldmappingmodel.h"
#include "qgsfields.h"
#include "qgspanelwidget.h"
 
#include <QAbstractTableModel>
#include <QPointer>
#include <QStyledItemDelegate>
 
class QLineEdit;
class QToolButton;
class QItemSelectionModel;
class QTableView;
 

class GUI_EXPORT QgsAggregateMappingModel : public QAbstractTableModel
{
    Q_OBJECT
 
  public:
    enum class ColumnDataIndex : int
    {
      SourceExpression,     
      Aggregate,            
      Delimiter,            
      DestinationName,      
      DestinationType,      
      DestinationLength,    
      DestinationPrecision, 
    };
 
    Q_ENUM( ColumnDataIndex );

    struct Aggregate
    {
        QString source;

        QString aggregate;

        QString delimiter;

        QgsField field;
    };

    QgsAggregateMappingModel( const QgsFields &sourceFields = QgsFields(), QObject *parent = nullptr );

    QgsFields sourceFields() const;

    QList<QgsAggregateMappingModel::Aggregate> mapping() const;

    void setMapping( const QList<QgsAggregateMappingModel::Aggregate> &mapping );

    void appendField( const QgsField &field, const QString &source = QString(), const QString &aggregate = QString() );

    bool removeField( const QModelIndex &index );

    bool moveUp( const QModelIndex &index );

    bool moveDown( const QModelIndex &index );

    void setSourceFields( const QgsFields &sourceFields );

    QgsExpressionContextGenerator *contextGenerator() const;

    void setBaseExpressionContextGenerator( const QgsExpressionContextGenerator *generator );
 
    // QAbstractItemModel interface
    int rowCount( const QModelIndex &parent = QModelIndex() ) const override;
    int columnCount( const QModelIndex &parent = QModelIndex() ) const override;
    QVariant data( const QModelIndex &index, int role ) const override;
    QVariant headerData( int section, Qt::Orientation orientation, int role ) const override;
    Qt::ItemFlags flags( const QModelIndex &index ) const override;
    bool setData( const QModelIndex &index, const QVariant &value, int role ) override;
 
  private:
    bool moveUpOrDown( const QModelIndex &index, bool up = true );
    static QString qgsFieldToTypeName( const QgsField &field );
    static void setFieldTypeFromName( QgsField &field, const QString &name );
 
    QList<Aggregate> mMapping;
    QgsFields mSourceFields;
    std::unique_ptr<QgsFieldMappingModel::ExpressionContextGenerator> mExpressionContextGenerator;
};

class GUI_EXPORT QgsAggregateMappingWidget : public QgsPanelWidget
{
    Q_OBJECT
 
  public:
    explicit QgsAggregateMappingWidget( QWidget *parent = nullptr, const QgsFields &sourceFields = QgsFields() );

    QgsAggregateMappingModel *model() const;

    QList<QgsAggregateMappingModel::Aggregate> mapping() const;

    void setMapping( const QList<QgsAggregateMappingModel::Aggregate> &mapping );

    QItemSelectionModel *selectionModel();

    void setSourceFields( const QgsFields &sourceFields );

    void setSourceLayer( QgsVectorLayer *layer );

    QgsVectorLayer *sourceLayer();

    void scrollTo( const QModelIndex &index ) const;

    void registerExpressionContextGenerator( const QgsExpressionContextGenerator *generator );
 
  signals:

    void changed();
 
  public slots:

    void appendField( const QgsField &field, const QString &source = QString(), const QString &aggregate = QString() );

    bool removeSelectedFields();

    bool moveSelectedFieldsUp();

    bool moveSelectedFieldsDown();
 
  private:
    QTableView *mTableView = nullptr;
    QAbstractTableModel *mModel = nullptr;
    QPointer<QgsVectorLayer> mSourceLayer;
    void updateColumns();
    std::list<int> selectedRows();
};

 
#ifndef SIP_RUN
 
class QgsAggregateMappingDelegate : public QStyledItemDelegate
{
    Q_OBJECT
 
  public:
    QgsAggregateMappingDelegate( QObject *parent = nullptr );
 
    // QAbstractItemDelegate interface
    QWidget *createEditor( QWidget *parent, const QStyleOptionViewItem &option, const QModelIndex &index ) const override;
    void setEditorData( QWidget *editor, const QModelIndex &index ) const override;
    void setModelData( QWidget *editor, QAbstractItemModel *model, const QModelIndex &index ) const override;
 
  private:
    static const QStringList aggregates();
};
 
#endif

 
#endif // QGSPROCESSINGAGGREGATEWIDGETS_H