qgsfieldmodel.h

Go to the documentation of this file.

/***************************************************************************
   qgsfieldmodel.h
    --------------------------------------
   Date                 : 01.04.2014
   Copyright            : (C) 2014 Denis Rouzaud
   Email                : denis.rouzaud@gmail.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 QGSFIELDMODEL_H
#define QGSFIELDMODEL_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsfields.h"
 
#include <QAbstractItemModel>
#include <QComboBox>
#include <QItemSelectionModel>
 
class QgsVectorLayer;

class CORE_EXPORT QgsFieldModel : public QAbstractItemModel
{
    Q_OBJECT
 
    Q_PROPERTY( bool allowExpression READ allowExpression WRITE setAllowExpression )
    Q_PROPERTY( bool allowEmptyFieldName READ allowEmptyFieldName WRITE setAllowEmptyFieldName )
    Q_PROPERTY( QgsVectorLayer *layer READ layer WRITE setLayer )
 
  public:
    // *INDENT-OFF*

    enum class CustomRole SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsFieldModel, FieldRoles ) : int
    {
      FieldName SIP_MONKEYPATCH_COMPAT_NAME( FieldNameRole ) = Qt::UserRole + 1,                   
      FieldIndex SIP_MONKEYPATCH_COMPAT_NAME( FieldIndexRole ) = Qt::UserRole + 2,                 
      Expression SIP_MONKEYPATCH_COMPAT_NAME( ExpressionRole ) = Qt::UserRole + 3,                 
      IsExpression SIP_MONKEYPATCH_COMPAT_NAME( IsExpressionRole ) = Qt::UserRole + 4,             
      ExpressionValidity SIP_MONKEYPATCH_COMPAT_NAME( ExpressionValidityRole ) = Qt::UserRole + 5, 
      FieldType SIP_MONKEYPATCH_COMPAT_NAME( FieldTypeRole ) = Qt::UserRole + 6,                   
      FieldOrigin SIP_MONKEYPATCH_COMPAT_NAME( FieldOriginRole ) = Qt::UserRole + 7,               
      IsEmpty SIP_MONKEYPATCH_COMPAT_NAME( IsEmptyRole ) = Qt::UserRole + 8,                       
      EditorWidgetType = Qt::UserRole + 9,                                                         
      JoinedFieldIsEditable = Qt::UserRole + 10,                                                   
      FieldIsWidgetEditable = Qt::UserRole + 11,                                                   
    };
    Q_ENUM( CustomRole )
    // *INDENT-ON*
 
    
    explicit QgsFieldModel( QObject *parent SIP_TRANSFERTHIS = nullptr );

    QModelIndex indexFromName( const QString &fieldName );

    void setAllowExpression( bool allowExpression );

    bool allowExpression() const { return mAllowExpression; }

    void setAllowEmptyFieldName( bool allowEmpty );

    bool allowEmptyFieldName() const { return mAllowEmpty; }

    bool isField( const QString &expression ) const;

    void setExpression( const QString &expression );

    void removeExpression();

    QgsVectorLayer *layer() { return mLayer; }
 
    // QAbstractItemModel interface
    QModelIndex index( int row, int column, const QModelIndex &parent = QModelIndex() ) const override;
    QModelIndex parent( const QModelIndex &child ) const override;
    int rowCount( const QModelIndex &parent = QModelIndex() ) const override;
    int columnCount( const QModelIndex &parent ) const override;
    QVariant data( const QModelIndex &index, int role ) const override;

    static QString fieldToolTip( const QgsField &field, const QString &predefinedComment = QString() );

    static QString fieldToolTipExtended( const QgsField &field, const QgsVectorLayer *layer, const QString &predefinedComment = QString() );

    void setFields( const QgsFields &fields );

    QgsFields fields() const;
 
  public slots:

    void setLayer( QgsVectorLayer *layer );
 
  protected slots:

    virtual void updateModel();
 
  private slots:
    void layerDeleted();
 
  protected:
    QgsFields mFields;
    QList<QString> mExpression;
 
    QgsVectorLayer *mLayer = nullptr;
    bool mAllowExpression = false;
    bool mAllowEmpty = false;
 
  private:
    void fetchFeature();
};
 
#endif // QGSFIELDMODEL_H