qgsfieldmappingwidget.h

Go to the documentation of this file.

/***************************************************************************
  qgsfieldmappingwidget.h - QgsFieldMappingWidget
 
 ---------------------
 begin                : 16.3.2020
 copyright            : (C) 2020 by Alessandro Pasotti
 email                : elpaso at itopen dot it
 ***************************************************************************
 *                                                                         *
 *   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 QGSFIELDMAPPINGWIDGET_H
#define QGSFIELDMAPPINGWIDGET_H
 
#include "qgis_gui.h"
#include "qgsfieldmappingmodel.h"
#include "qgspanelwidget.h"
 
#include <QAbstractTableModel>
#include <QPointer>
#include <QStyledItemDelegate>
#include <QWidget>
 
class QTableView;
class QItemSelectionModel;
class QgsVectorLayer;
class QgsFieldMappingTypeDelegate;

class GUI_EXPORT QgsFieldMappingWidget : public QgsPanelWidget
{
    Q_OBJECT
 
  public:
    explicit QgsFieldMappingWidget(
      QWidget *parent = nullptr,
      const QgsFields &sourceFields = QgsFields(),
      const QgsFields &destinationFields = QgsFields(),
      const QMap<QString, QString> &expressions = QMap<QString, QString>(),
      const QList< QgsVectorDataProvider::NativeType > &nativeTypes = QList< QgsVectorDataProvider::NativeType >()
    );

    void setDestinationEditable( bool editable );

    bool destinationEditable() const;

    QgsFieldMappingModel *model() const;

    QList<QgsFieldMappingModel::Field> mapping() const;

    QMap<QString, QgsProperty> fieldPropertyMap() const;

    void setFieldPropertyMap( const QMap<QString, QgsProperty> &map );

    QItemSelectionModel *selectionModel();

    void setSourceFields( const QgsFields &sourceFields );

    void setSourceLayer( QgsVectorLayer *layer );

    QgsVectorLayer *sourceLayer();

    void setDestinationFields( const QgsFields &destinationFields, const QMap<QString, QString> &expressions = QMap<QString, QString>() );

    void setNativeTypes( const QList< QgsVectorDataProvider::NativeType > &nativeTypes );

    void scrollTo( const QModelIndex &index ) const;

    void registerExpressionContextGenerator( const QgsExpressionContextGenerator *generator );
 
  public slots:

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

    bool removeSelectedFields();

    bool moveSelectedFieldsUp();

    bool moveSelectedFieldsDown();

    void invertSelection();
 
  private:
    QTableView *mTableView = nullptr;
    QgsFieldMappingModel *mModel = nullptr;
 
    QgsFieldMappingTypeDelegate *mTypeDelegate = nullptr;
 
    QPointer<QgsVectorLayer> mSourceLayer;
    void updateColumns();
    std::list<int> selectedRows();
 
    friend class QgsAggregateMappingWidget;
};

 
#ifndef SIP_RUN
 
class QgsFieldMappingExpressionDelegate : public QStyledItemDelegate
{
    Q_OBJECT
 
  public:
    QgsFieldMappingExpressionDelegate( 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;
};
 
class QgsFieldMappingTypeDelegate : public QStyledItemDelegate
{
    Q_OBJECT
 
  public:
    QgsFieldMappingTypeDelegate( const QList< QgsVectorDataProvider::NativeType > &nativeTypes, 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;

    void setNativeTypes( const QList< QgsVectorDataProvider::NativeType > &nativeTypes );
 
  private:
    QList< QgsVectorDataProvider::NativeType > mNativeTypes;
};
 
#endif

 
#endif // QGSFIELDMAPPINGWIDGET_H