qgsfeaturefilterwidget_p.h

Go to the documentation of this file.

/***************************************************************************
    qgsfeaturefilterwidget.h
     --------------------------------------
    Date                 : 20.9.2019
    Copyright            : (C) 2019 Julien Cabieces
    Email                : julien dot cabieces at oslandia 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 QGSFEATUREFILTERWIDGET_P_H
#define QGSFEATUREFILTERWIDGET_P_H

#define SIP_NO_FILE


//
//  W A R N I N G
//  -------------
//
// This file is not part of the QGIS API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//

#include "ui_qgsfeaturefilterwidget.h"

#include "qgsattributeform.h"

#include "qgis_gui.h"

class QgsVectorLayer;
class QgsAttributeEditorContext;
class QgsSearchWidgetWrapper;
class QgsDualView;
class QgsMessageBar;

class GUI_EXPORT QgsFeatureFilterWidget : public QWidget, private Ui::QgsFeatureFilterWidget
{
    Q_OBJECT

  public:

    explicit QgsFeatureFilterWidget( QWidget *parent SIP_TRANSFERTHIS = nullptr );

    void init( QgsVectorLayer *layer, const QgsAttributeEditorContext &context, QgsDualView *mainView,
               QgsMessageBar *messageBar, int messagebarTimeout );

    void setFilterExpression( const QString &filterString,
                              QgsAttributeForm::FilterType type = QgsAttributeForm::ReplaceFilter,
                              bool alwaysShowFilter = false );

  public slots:
    void filterShowAll();
    void filterSelected();
    void filterVisible();


  private slots:

    void columnBoxInit();

    void storedFilterExpressionBoxInit();
    void storeExpressionButtonInit();

    void filterExpressionBuilder();
    void filterEdited();
    void filterQueryChanged( const QString &query );
    void filterQueryAccepted();

    void onFilterQueryTextChanged( const QString &value );

    void handleStoreFilterExpression();

    void saveAsStoredFilterExpression();

    void editStoredFilterExpression();

    void updateCurrentStoredFilterExpression( );

    void filterColumnChanged( QAction *filterAction );

  private:

    /* replace the search widget with a new one */
    void replaceSearchWidget( QWidget *oldw, QWidget *neww );

    QMenu *mFilterColumnsMenu = nullptr;
    QMenu *mStoredFilterExpressionMenu = nullptr;
    QTimer mFilterQueryTimer;
    QgsSearchWidgetWrapper *mCurrentSearchWidgetWrapper = nullptr;
    QgsDualView *mMainView = nullptr;
    QgsVectorLayer *mLayer = nullptr;
    QgsAttributeEditorContext mEditorContext;
    QgsMessageBar *mMessageBar = nullptr;
    int mMessageBarTimeout = 0;
};

#endif // QGSFEATUREFILTERWIDGET_P_H