qgsfeaturefiltermodel.h

Go to the documentation of this file.

/***************************************************************************
  qgsfeaturefiltermodel.h - QgsFeatureFilterModel
 ---------------------
 begin                : 10.3.2017
 copyright            : (C) 2017 by Matthias Kuhn
 email                : matthias@opengis.ch
 ***************************************************************************
 *                                                                         *
 *   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 QGSFEATUREFILTERMODEL_H
#define QGSFEATUREFILTERMODEL_H
 
 
#include "qgsfeaturepickermodelbase.h"
 
class QgsSettingsEntryInteger;

class CORE_EXPORT QgsFeatureFilterModel : public QgsFeaturePickerModelBase
{
    Q_OBJECT

    Q_PROPERTY( QStringList identifierFields READ identifierFields WRITE setIdentifierFields NOTIFY identifierFieldsChanged )
 
    
    Q_PROPERTY( QVariantList extraIdentifierValues READ extraIdentifierValues WRITE setExtraIdentifierValues NOTIFY extraIdentifierValuesChanged )
 
  public:
#ifndef SIP_RUN
    static const QgsSettingsEntryInteger *settingsMaxEntriesRelationWidget;
#endif

    explicit QgsFeatureFilterModel( QObject *parent = nullptr );

    Q_DECL_DEPRECATED QString identifierField() const;

    QStringList identifierFields() const;

    void setIdentifierFields( const QStringList &identifierFields );

    void setExtraIdentifierValueToNull() override;

    QVariantList extraIdentifierValues() const;

    void setExtraIdentifierValues( const QVariantList &extraIdentifierValues );
 
 
  signals:

    void identifierFieldsChanged();

    void extraIdentifierValuesChanged();
 
  private:
    QgsFeatureExpressionValuesGatherer *createValuesGatherer( const QgsFeatureRequest &request ) const override;
 
    void requestToReloadCurrentFeature( QgsFeatureRequest &request ) override SIP_FORCE;
 
    QSet<QString> requestedAttributes() const override;
 
    QVariant entryIdentifier( const QgsFeatureExpressionValuesGatherer::Entry &entry ) const override;
 
    QgsFeatureExpressionValuesGatherer::Entry createEntry( const QVariant &identifier ) const override;
 
    bool compareEntries( const QgsFeatureExpressionValuesGatherer::Entry &a, const QgsFeatureExpressionValuesGatherer::Entry &b ) const override;
 
    bool identifierIsNull( const QVariant &identifier ) const override;
 
    QVariant nullIdentifier() const override;
 
    QStringList mIdentifierFields;
};
 
#endif // QGSFEATUREFILTERMODEL_H