qgslocatorfilter.h

Go to the documentation of this file.

/***************************************************************************
                         qgslocatorfilter.h
                         ------------------
    begin                : May 2017
    copyright            : (C) 2017 by Nyall Dawson
    email                : nyall dot dawson 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 QGSLOCATORFILTER_H
#define QGSLOCATORFILTER_H
 
#include <QIcon>
#include <QString>
#include <QVariant>
 
#include "qgis_core.h"
#include "qgslocatorcontext.h"
#include "qgslogger.h"
 
class QgsFeedback;
class QgsLocatorFilter;
 
class CORE_EXPORT QgsLocatorResult
{
  public:
 
    QgsLocatorResult() = default;
 
    QgsLocatorResult( QgsLocatorFilter *filter, const QString &displayString, const QVariant &userData = QVariant() )
      : filter( filter )
      , displayString( displayString )
      , mUserData( userData )
    {}
 
    QVariant getUserData() const;
 
    void setUserData( QVariant userData );
 
    QgsLocatorFilter *filter = nullptr;
 
    QString displayString;
 
    QString description;
 
    QIcon icon;
 
    double score = 0.5;
 
    QString group;
 
    struct CORE_EXPORT ResultAction
    {
      public:
        ResultAction() = default;
 
        ResultAction( int id, QString text, QString iconPath = QString() )
          : id( id )
          , text( text )
          , iconPath( iconPath )
        {}
        int id = -1;
        QString text;
        QString iconPath;
    };
 
    QList<QgsLocatorResult::ResultAction> actions;
 
#ifdef SIP_RUN
    SIP_PROPERTY( name = userData, get = getUserData, set = setUserData )
#endif
 
  private:
 
    QVariant mUserData;
 
 
};
 
Q_DECLARE_METATYPE( QgsLocatorResult::ResultAction )
 
 
 
class CORE_EXPORT QgsLocatorFilter : public QObject
{
    Q_OBJECT
 
  public:
 
    enum Priority
    {
      Highest, 
      High, 
      Medium, 
      Low, 
      Lowest 
    };
    Q_ENUM( Priority )
 
    
    enum Flag
    {
      FlagFast = 1 << 1, 
    };
    Q_DECLARE_FLAGS( Flags, Flag )
    Q_FLAG( Flags )
 
    
    QgsLocatorFilter( QObject *parent = nullptr );
 
    virtual QgsLocatorFilter *clone() const = 0 SIP_FACTORY;
 
    virtual QString name() const = 0;
 
    virtual QString displayName() const = 0;
 
    virtual QString description() const { return QString(); }
 
    virtual QgsLocatorFilter::Flags flags() const;
 
    virtual Priority priority() const { return Medium; }
 
    virtual QString prefix() const { return QString(); }
 
    virtual QStringList prepare( const QString &string, const QgsLocatorContext &context ) { Q_UNUSED( string ) Q_UNUSED( context ); return QStringList();}
 
    virtual void fetchResults( const QString &string, const QgsLocatorContext &context, QgsFeedback *feedback ) = 0;
 
    virtual void triggerResult( const QgsLocatorResult &result ) = 0;
 
    virtual void triggerResultFromAction( const QgsLocatorResult &result, const int actionId );
 
    virtual void clearPreviousResults() {}
 
    bool useWithoutPrefix() const;
 
    void setUseWithoutPrefix( bool useWithoutPrefix );
 
    QString activePrefix() const;
 
    void setActivePrefix( const QString &activePrefix ) SIP_SKIP;
 
    static bool stringMatches( const QString &candidate, const QString &search );
 
    static double fuzzyScore( const QString &candidate, const QString &search );
 
    bool enabled() const;
 
    void setEnabled( bool enabled );
 
    virtual bool hasConfigWidget() const;
 
    virtual void openConfigWidget( QWidget *parent = nullptr );
 
    void logMessage( const QString &message, Qgis::MessageLevel level = Qgis::MessageLevel::Info );
 
    int fetchResultsDelay() const { return mFetchResultsDelay; }
 
    void setFetchResultsDelay( int delay ) { mFetchResultsDelay = delay; }
 
  signals:
 
    void finished();
 
    void resultFetched( const QgsLocatorResult &result );
 
  private:
 
    bool mEnabled = true;
    bool mUseWithoutPrefix = true;
    QString mActivePrefifx = QString();
    int mFetchResultsDelay = 0;
 
};
 
Q_DECLARE_METATYPE( QgsLocatorResult )
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsLocatorFilter::Flags )
 
 
#endif // QGSLOCATORFILTER_H