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 "qgis_sip.h"
 
#include <QMap>
#include <QObject>
#include <QString>
#include <QVariant>
 
using namespace Qt::StringLiterals;
 
class QgsVectorLayer;
class QgsField;
 
#include "qgsattributeeditorcontext.h"
#include "qgswidgetwrapper.h"
#include "qgis_gui.h"
 
#ifdef SIP_RUN // should not be required, but mingw workflow needs it..
SIP_INSERT_QLIST_ENUM_CONVERSION_CODE( QgsSearchWidgetWrapper::FilterFlag );
#endif

class GUI_EXPORT QgsSearchWidgetWrapper : public QgsWidgetWrapper
{
    Q_OBJECT
  public:
    enum FilterFlag SIP_ENUM_BASETYPE( IntFlag )
    {
      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,           
      StartsWith = 1 << 14,          
      EndsWith = 1 << 15,            
    };
    Q_DECLARE_FLAGS( FilterFlags, FilterFlag )
 
    
    static QList<QgsSearchWidgetWrapper::FilterFlag> exclusiveFilterFlags();

    static QList<QgsSearchWidgetWrapper::FilterFlag> nonExclusiveFilterFlags();

    static QString toString( QgsSearchWidgetWrapper::FilterFlag flag );

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

    virtual FilterFlags supportedFlags() const;

    virtual FilterFlags defaultFlags() const;

    virtual QString expression() const = 0;

    virtual bool applyDirectly() = 0;
 
    // TODO QGIS 5.0 - make pure virtual

    virtual QString createExpression( FilterFlags flags ) const
    {
      Q_UNUSED( flags )
      return u"TRUE"_s;
    }

    QString createFieldIdentifier() const;

    QString aggregate() const;

    void setAggregate( const QString &aggregate );

    int fieldIndex() const;
 
  public slots:

    virtual void clearWidget() {}

    void setEnabled( bool enabled ) override { Q_UNUSED( enabled ) }
 
  signals:

    void expressionChanged( const QString &exp );

    void valueChanged();

    void valueCleared();
 
  protected slots:

    virtual void setExpression( const QString &expression ) = 0;
 
    void setFeature( const QgsFeature &feature ) override;
 
  protected:
    void clearExpression();
 
    QString mExpression;
    int mFieldIdx;
 
  private:
    QString mAggregate;
    QgsRelation mAggregateRelation;
};
// 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