Albert
Loading...
Searching...
No Matches
triggerqueryhandler.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: 2024-2025 Manuel Schneider
2// SPDX-License-Identifier: MIT
3
4#pragma once
5#include <albert/extension.h>
6#include <albert/query.h>
7
8namespace albert
9{
10class RankItem;
11
20class ALBERT_EXPORT TriggerQueryHandler : virtual public Extension
21{
22public:
26 virtual QString synopsis(const QString &query) const;
27
30 virtual bool allowTriggerRemap() const;
31
34 virtual QString defaultTrigger() const;
35
38 virtual void setTrigger(const QString &trigger);
39
42 virtual bool supportsFuzzyMatching() const;
43
46 virtual void setFuzzyMatching(bool enabled);
47
50 virtual void handleTriggerQuery(Query &query) = 0;
51
53 void applyUsageScore(std::vector<RankItem> &rank_items);
54
55protected:
56
58
59};
60
61}
Abstract extension class.
Definition extension.h:19
Common query object.
Definition query.h:28
Abstract trigger query handler.
Definition triggerqueryhandler.h:21
virtual void handleTriggerQuery(Query &query)=0
Handles the triggered query.
virtual QString synopsis(const QString &query) const
Returns the input hint for the given query.
virtual void setFuzzyMatching(bool enabled)
Sets the fuzzy matching mode to enabled.
virtual bool allowTriggerRemap() const
Returns true if the user is allowed to set a custom trigger, otherwise returns false.
virtual bool supportsFuzzyMatching() const
Returns true if the handler supports error tolerant matching, otherwise returns false.
void applyUsageScore(std::vector< RankItem > &rank_items)
Modifies the score of rank_items to reflect the users usage history.
virtual void setTrigger(const QString &trigger)
Notifies that the user-defined trigger has changed to trigger.
virtual QString defaultTrigger() const
Returns the default trigger.
Albert core interface namespace.
Definition albert.h:14