QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
qgslocatorfilter.h
Go to the documentation of this file.
1/***************************************************************************
2 qgslocatorfilter.h
3 ------------------
4 begin : May 2017
5 copyright : (C) 2017 by Nyall Dawson
6 email : nyall dot dawson at gmail dot com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
18#ifndef QGSLOCATORFILTER_H
19#define QGSLOCATORFILTER_H
20
21#include <QIcon>
22#include <QString>
23#include <QVariant>
24
25#include "qgis_core.h"
26#include "qgslocatorcontext.h"
27#include "qgslogger.h"
28
29class QgsFeedback;
31
37class CORE_EXPORT QgsLocatorResult
38{
39 public:
40
41 QgsLocatorResult() = default;
42
46 QgsLocatorResult( QgsLocatorFilter *filter, const QString &displayString, const QVariant &userData = QVariant() )
47 : filter( filter )
48 , displayString( displayString )
49 , mUserData( userData )
50 {}
51
57 QVariant userData() const SIP_PYNAME( _userData );
58
64 void setUserData( const QVariant &userData );
65
69 QgsLocatorFilter *filter = nullptr;
70
74 QString displayString;
75
79 QString description;
80
84 QIcon icon;
85
89 double score = 0.5;
90
98 QString group;
99
107 double groupScore = 0;
108
115 struct CORE_EXPORT ResultAction
116 {
117 public:
118
119 ResultAction() = default;
120
127 ResultAction( int id, QString text, QString iconPath = QString() )
128 : id( id )
129 , text( text )
130 , iconPath( iconPath )
131 {}
132 int id = -1;
133 QString text;
134 QString iconPath;
135 };
136
143 QList<QgsLocatorResult::ResultAction> actions;
144
145 private:
146
150 QVariant mUserData;
151
152
153};
154
156
157
158
166class CORE_EXPORT QgsLocatorFilter : public QObject
167{
168 Q_OBJECT
169
170 public:
171
174 {
179 Lowest
180 };
181 Q_ENUM( Priority )
182
183
184 enum Flag SIP_ENUM_BASETYPE( IntFlag )
185 {
186 FlagFast = 1 << 1,
187 };
188 Q_DECLARE_FLAGS( Flags, Flag )
189 Q_FLAG( Flags )
190
191
194 QgsLocatorFilter( QObject *parent = nullptr );
195
200 virtual QgsLocatorFilter *clone() const = 0 SIP_FACTORY;
201
206 virtual QString name() const = 0;
207
212 virtual QString displayName() const = 0;
213
218 virtual QString description() const { return QString(); }
219
223 virtual QgsLocatorFilter::Flags flags() const;
224
229 virtual Priority priority() const { return Medium; }
230
242 virtual QString prefix() const { return QString(); }
243
251 virtual QStringList prepare( const QString &string, const QgsLocatorContext &context ) { Q_UNUSED( string ) Q_UNUSED( context ); return QStringList();}
252
268 virtual void fetchResults( const QString &string, const QgsLocatorContext &context, QgsFeedback *feedback ) = 0;
269
278 virtual void triggerResult( const QgsLocatorResult &result ) = 0;
279
286 virtual void resultSelected( const QgsLocatorResult &result ) {Q_UNUSED( result )}
287
294 virtual void resultDeselected( const QgsLocatorResult &result ) {Q_UNUSED( result )}
295
302 virtual void triggerResultFromAction( const QgsLocatorResult &result, const int actionId );
303
312 virtual void clearPreviousResults() {}
313
319 bool useWithoutPrefix() const;
320
326 void setUseWithoutPrefix( bool useWithoutPrefix );
327
334 QString activePrefix() const;
335
342 void setActivePrefix( const QString &activePrefix ) SIP_SKIP;
343
350 static bool stringMatches( const QString &candidate, const QString &search );
351
357 static double fuzzyScore( const QString &candidate, const QString &search );
358
363 bool enabled() const;
364
369 void setEnabled( bool enabled );
370
375 virtual bool hasConfigWidget() const;
376
383 virtual void openConfigWidget( QWidget *parent = nullptr );
384
391 void logMessage( const QString &message, Qgis::MessageLevel level = Qgis::MessageLevel::Info );
392
398 int fetchResultsDelay() const { return mFetchResultsDelay; }
399
406 void setFetchResultsDelay( int delay ) { mFetchResultsDelay = delay; }
407
408 signals:
409
413 void finished();
414
419 void resultFetched( const QgsLocatorResult &result );
420
421 private:
422
423 bool mEnabled = true;
424 bool mUseWithoutPrefix = true;
425 QString mActivePrefifx = QString();
426 int mFetchResultsDelay = 0;
427
428};
429
432
433
434#endif // QGSLOCATORFILTER_H
MessageLevel
Level for messages This will be used both for message log and message bar in application.
Definition qgis.h:154
@ Info
Information message.
Definition qgis.h:155
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition qgsfeedback.h:44
Encapsulates the properties relating to the context of a locator search.
Abstract base class for filters which collect locator results.
QFlags< Flag > Flags
virtual QString prefix() const
Returns the search prefix character(s) for this filter.
Flag
Flags for locator behavior.
int fetchResultsDelay() const
Returns the delay (in milliseconds) for the filter to wait prior to fetching results.
Priority
Filter priority. Controls the order of results in the locator.
@ Low
Low priority.
@ Highest
Highest priority.
@ Medium
Medium priority.
@ High
High priority.
void setFetchResultsDelay(int delay)
Sets a delay (in milliseconds) for the filter to wait prior to fetching results.
virtual QString description() const
Returns a translated, description for the filter.
void finished()
Emitted when the filter finishes fetching results.
virtual QString displayName() const =0
Returns a translated, user-friendly name for the filter.
virtual Priority priority() const
Returns the priority for the filter, which controls how results are ordered in the locator.
virtual QString name() const =0
Returns the unique name for the filter.
virtual void triggerResult(const QgsLocatorResult &result)=0
Triggers a filter result from this filter.
virtual QgsLocatorFilter * clone() const =0
Creates a clone of the filter.
virtual void resultDeselected(const QgsLocatorResult &result)
This is called when a result is deselected.
virtual void clearPreviousResults()
This method will be called on main thread on the original filter (not a clone) before fetching result...
virtual void resultSelected(const QgsLocatorResult &result)
This is called when the result is selected by the user.
void resultFetched(const QgsLocatorResult &result)
Should be emitted by filters whenever they encounter a matching result during within their fetchResul...
virtual void fetchResults(const QString &string, const QgsLocatorContext &context, QgsFeedback *feedback)=0
Retrieves the filter results for a specified search string.
virtual QStringList prepare(const QString &string, const QgsLocatorContext &context)
Prepares the filter instance for an upcoming search for the specified string.
Encapsulates properties of an individual matching result found by a QgsLocatorFilter.
QList< QgsLocatorResult::ResultAction > actions
Additional actions to be used in a locator widget for the given result.
QgsLocatorResult()=default
QgsLocatorResult(QgsLocatorFilter *filter, const QString &displayString, const QVariant &userData=QVariant())
Constructor for QgsLocatorResult.
#define SIP_ENUM_BASETYPE(type)
Definition qgis_sip.h:278
#define SIP_SKIP
Definition qgis_sip.h:126
#define SIP_PYNAME(name)
Definition qgis_sip.h:81
#define SIP_FACTORY
Definition qgis_sip.h:76
Q_DECLARE_METATYPE(QgsDatabaseQueryLogEntry)
Q_DECLARE_OPERATORS_FOR_FLAGS(QgsTextRendererUtils::CurvedTextFlags)
The ResultAction stores basic information for additional actions to be used in a locator widget for t...
ResultAction(int id, QString text, QString iconPath=QString())
Constructor for ResultAction The id used to recognized the action when the result is triggered.