query.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2024 Manuel Schneider
// SPDX-License-Identifier: MIT
 
#pragma once
#include <QAbstractListModel>
#include <QObject>
#include <QString>
#include <albert/export.h>
#include <memory>
#include <vector>
 
namespace albert
{
class Item;
class Extension;
 
class ALBERT_EXPORT ResultItem
{
public:
    const Extension &extension;
    std::shared_ptr<Item> item;
};
 
class ALBERT_EXPORT Query : public QObject
{
    Q_OBJECT
 
public:
 
    Q_INVOKABLE virtual QString synopsis() const = 0;
 
    Q_INVOKABLE virtual QString trigger() const = 0;
 
    Q_INVOKABLE virtual QString string() const = 0;
 
    Q_INVOKABLE virtual bool isActive() const = 0;
 
    Q_INVOKABLE virtual bool isFinished() const = 0;
 
    Q_INVOKABLE virtual const bool &isValid() const = 0;
 
    Q_INVOKABLE virtual bool isTriggered() const = 0;
 
    Q_INVOKABLE virtual const std::vector<ResultItem> &matches() = 0;
 
    Q_INVOKABLE virtual const std::vector<ResultItem> &fallbacks() = 0;
 
    Q_INVOKABLE virtual bool activateMatch(uint item, uint action = 0) = 0;
 
    Q_INVOKABLE virtual bool activateFallback(uint item, uint action = 0) = 0;
 
    virtual void add(const std::shared_ptr<Item> &item) = 0;
 
    virtual void add(std::shared_ptr<Item> &&item) = 0;
 
    virtual void add(const std::vector<std::shared_ptr<Item>> &items) = 0;
 
    virtual void add(std::vector<std::shared_ptr<Item>> &&items) = 0;
 
    inline operator QString() const { return string(); }
 
protected:
 
    ~Query() override;
 
signals:
 
    void matchesAboutToBeAdded(uint count);
 
    void matchesAdded();
 
    void invalidated();
 
    void activeChanged(bool active);
};
 
}