qgslocator.h

Go to the documentation of this file.

/***************************************************************************
                         qgslocator.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 QGSLOCATOR_H
#define QGSLOCATOR_H
 
#include <QObject>
#include <QFuture>
#include <QFutureWatcher>
#include <QMap>
#include <memory>
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgslocatorfilter.h"
#include "qgsfeedback.h"
#include "qgslocatorcontext.h"
#include "qgssettingsentry.h"
 
 
class CORE_EXPORT QgsLocator : public QObject
{
    Q_OBJECT
 
  public:
 
    static const QList<QString> CORE_FILTERS;
 
    QgsLocator( QObject *parent SIP_TRANSFERTHIS = nullptr );
 
    ~QgsLocator() override;
 
    void registerFilter( QgsLocatorFilter *filter SIP_TRANSFER );
 
    void deregisterFilter( QgsLocatorFilter *filter );
 
    QList< QgsLocatorFilter *> filters( const QString &prefix = QString() );
 
    Q_DECL_DEPRECATED QMap<QString, QgsLocatorFilter *> prefixedFilters() const;
 
    void fetchResults( const QString &string, const QgsLocatorContext &context, QgsFeedback *feedback = nullptr );
 
    void cancel();
 
    void cancelWithoutBlocking();
 
    bool isRunning() const;
 
    void clearPreviousResults();
 
    QStringList completionList() const {return mAutocompletionList;}
 
#ifndef SIP_RUN
    static const inline QgsSettingsEntryBool settingsLocatorFilterEnabled = QgsSettingsEntryBool( QStringLiteral( "locator_filters/enabled_%1" ), QgsSettings::Gui, true, "Locator filter enabled" );
    static const inline QgsSettingsEntryBool settingsLocatorFilterDefault = QgsSettingsEntryBool( QStringLiteral( "locator_filters/default_%1" ), QgsSettings::Gui, false, "Locator filter default value" );
    static const inline QgsSettingsEntryString settingsLocatorFilterPrefix = QgsSettingsEntryString( QStringLiteral( "locator_filters/prefix_%1" ), QgsSettings::Gui, QString(), "Locator filter prefix" );
#endif
 
  signals:
 
    void foundResult( const QgsLocatorResult &result );
 
    void searchPrepared();
 
    void finished();
 
  private slots:
 
    void filterSentResult( QgsLocatorResult result );
 
  private:
 
    QgsFeedback *mFeedback = nullptr;
    std::unique_ptr< QgsFeedback > mOwnedFeedback;
 
    QList< QgsLocatorFilter * > mFilters;
    QList< QThread * > mActiveThreads;
 
    QStringList mAutocompletionList;
 
    void cancelRunningQuery();
 
};
 
#endif // QGSLOCATOR_H