qgssearchwidgetwrapper.h

Go to the documentation of this file.

/***************************************************************************
    qgssearchwidgetwrapper.h
     --------------------------------------
    Date                 : 31.5.2015
    Copyright            : (C) 2015 Karolina Alexiou (carolinux)
    Email                : carolinegr at gmail 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 QGSSEARCHWIDGETWRAPPER_H
#define QGSSEARCHWIDGETWRAPPER_H

#include <QObject>
#include <QMap>
#include <QVariant>

class QgsVectorLayer;
class QgsField;

#include "qgseditorwidgetconfig.h"
#include "qgsattributeeditorcontext.h"
#include "qgswidgetwrapper.h"

class GUI_EXPORT QgsSearchWidgetWrapper : public QgsWidgetWrapper
{
    Q_OBJECT
  public:

    enum FilterFlag
    {
      EqualTo = 1 << 1, 
      NotEqualTo = 1 << 2, 
      GreaterThan = 1 << 3, 
      LessThan = 1 << 4, 
      GreaterThanOrEqualTo = 1 << 5, 
      LessThanOrEqualTo = 1 << 6, 
      Between = 1 << 7, 
      CaseInsensitive = 1 << 8, 
      Contains = 1 << 9, 
      DoesNotContain = 1 << 10, 
      IsNull = 1 << 11, 
      IsNotBetween = 1 << 12, 
      IsNotNull = 1 << 13, 
    };
    Q_DECLARE_FLAGS( FilterFlags, FilterFlag )

    
    static QList< FilterFlag > exclusiveFilterFlags();

    static QList< FilterFlag > nonExclusiveFilterFlags();

    static QString toString( FilterFlag flag );

    explicit QgsSearchWidgetWrapper( QgsVectorLayer* vl, int fieldIdx, QWidget* parent = nullptr );

    virtual FilterFlags supportedFlags() const;

    virtual FilterFlags defaultFlags() const;

    virtual QString expression() = 0;

    virtual bool applyDirectly() = 0;

    // TODO QGIS 3.0 - make pure virtual
    virtual QString createExpression( FilterFlags flags ) const { Q_UNUSED( flags ); return "TRUE"; }

  public slots:

    virtual void clearWidget() {}

    virtual void setEnabled( bool enabled ) override { Q_UNUSED( enabled ); }

  signals:

    void expressionChanged( const QString& exp );

    void valueChanged();

    void valueCleared();

  protected slots:

    virtual void setExpression( QString value ) = 0;
    void setFeature( const QgsFeature& feature ) override;

  protected:
    void clearExpression();

    QString mExpression;
    int mFieldIdx;

};
// We'll use this class inside a QVariant in the widgets properties
Q_DECLARE_METATYPE( QgsSearchWidgetWrapper* )

Q_DECLARE_OPERATORS_FOR_FLAGS( QgsSearchWidgetWrapper::FilterFlags )

#endif // QGSSEARCHWIDGETWRAPPER_H