qgsfeaturepickerwidget.h

Go to the documentation of this file.

/***************************************************************************
  qgsfeaturepickerwidget.h - QgsFeaturePickerWidget
 ---------------------
 begin                : 03.04.2020
 copyright            : (C) 2020 by Denis Rouzaud
 email                : [email protected]
 ***************************************************************************
 *                                                                         *
 *   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 QGSFEATURECHOOSER_H
#define QGSFEATURECHOOSER_H
 
#include "qgis_gui.h"
#include "qgsfeature.h"
 
#include <QComboBox>
#include <QCompleter>
#include <QLineEdit>
#include <QWidget>
 
class QToolButton;
 
class QgsVectorLayer;
class QgsFeaturePickerModel;
class QgsAnimatedIcon;
class QgsFilterLineEdit;
 

class GUI_EXPORT QgsFeaturePickerWidget : public QWidget
{
    Q_OBJECT
 
    Q_PROPERTY( QgsVectorLayer *layer READ layer WRITE setLayer NOTIFY layerChanged )
    Q_PROPERTY( QString displayExpression READ displayExpression WRITE setDisplayExpression NOTIFY displayExpressionChanged )
    Q_PROPERTY( QString filterExpression READ filterExpression WRITE setFilterExpression NOTIFY filterExpressionChanged )
    Q_PROPERTY( bool allowNull READ allowNull WRITE setAllowNull NOTIFY allowNullChanged )
    Q_PROPERTY( bool fetchGeometry READ fetchGeometry WRITE setFetchGeometry NOTIFY fetchGeometryChanged )
    Q_PROPERTY( int fetchLimit READ fetchLimit WRITE setFetchLimit NOTIFY fetchLimitChanged )
    Q_PROPERTY( bool showBrowserButtons READ showBrowserButtons WRITE setShowBrowserButtons NOTIFY showBrowserButtonsChanged )
 
  public:
    QgsFeaturePickerWidget( QWidget *parent = nullptr );

    QgsVectorLayer *layer() const;

    void setLayer( QgsVectorLayer *layer );

    void setFeature( QgsFeatureId featureId );

    QgsFeature feature() const;

    QString displayExpression() const;

    void setDisplayExpression( const QString &displayExpression );

    QString filterExpression() const;

    int nullIndex() const;

    void setFilterExpression( const QString &filterExpression );

    bool allowNull() const;

    void setAllowNull( bool allowNull );

    bool fetchGeometry() const;

    void setFetchGeometry( bool fetchGeometry );

    int fetchLimit() const;

    void setFetchLimit( int fetchLimit );

    bool showBrowserButtons() const;

    void setShowBrowserButtons( bool showBrowserButtons );
 

    QModelIndex currentModelIndex() const;
 
    void focusOutEvent( QFocusEvent *event ) override;
 
    void keyPressEvent( QKeyEvent *event ) override;
 
  signals:

    void modelUpdated();

    void layerChanged();

    void displayExpressionChanged();

    void filterExpressionChanged();

    void featureChanged( const QgsFeature &feature );

    void allowNullChanged();

    void fetchGeometryChanged();

    void fetchLimitChanged();

    void showBrowserButtonsChanged();
 
  private slots:
    void onCurrentTextChanged( const QString &text );
    void onFilterUpdateCompleted();
    void onLoadingChanged();
    void onItemSelected( const QModelIndex &index );
    void onCurrentIndexChanged( int i );
    void onActivated( QModelIndex index );
    void storeLineEditState();
    void restoreLineEditState();
    void onDataChanged( const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector<int> &roles = QVector<int>() );
    void browseFeatures( int direction );
 
  private:
    QComboBox *mComboBox;
    QToolButton *mPreviousButton;
    QToolButton *mNextButton;
    QgsFeaturePickerModel *mModel = nullptr;
    QCompleter *mCompleter = nullptr;
    QgsFilterLineEdit *mLineEdit;
    bool mPopupRequested = false;
    bool mIsCurrentlyEdited = false;
    bool mShowBrowserButtons = false;
};
 
 
#endif // QGSFEATURECHOOSER_H