18#ifndef QGSLOCATORFILTER_H
19#define QGSLOCATORFILTER_H
48 , displayString( displayString )
49 , mUserData( userData )
57 QVariant userData() const
SIP_PYNAME( _userData );
64 void setUserData( const QVariant &userData );
74 QString displayString;
107 double groupScore = 0;
130 , iconPath( iconPath )
143 QList<QgsLocatorResult::ResultAction>
actions;
206 virtual QString
name()
const = 0;
242 virtual QString
prefix()
const {
return QString(); }
251 virtual QStringList
prepare(
const QString &
string,
const QgsLocatorContext &context ) { Q_UNUSED(
string ) Q_UNUSED( context );
return QStringList();}
302 virtual void triggerResultFromAction(
const QgsLocatorResult &result,
const int actionId );
319 bool useWithoutPrefix()
const;
326 void setUseWithoutPrefix(
bool useWithoutPrefix );
334 QString activePrefix()
const;
342 void setActivePrefix(
const QString &activePrefix )
SIP_SKIP;
350 static bool stringMatches(
const QString &candidate,
const QString &search );
357 static double fuzzyScore(
const QString &candidate,
const QString &search );
363 bool enabled()
const;
369 void setEnabled(
bool enabled );
375 virtual bool hasConfigWidget()
const;
383 virtual void openConfigWidget( QWidget *parent =
nullptr );
423 bool mEnabled =
true;
424 bool mUseWithoutPrefix =
true;
425 QString mActivePrefifx = QString();
426 int mFetchResultsDelay = 0;
MessageLevel
Level for messages This will be used both for message log and message bar in application.
@ Info
Information message.
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Encapsulates the properties relating to the context of a locator search.
Abstract base class for filters which collect locator results.
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.
@ Highest
Highest 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)
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.