plugininstance.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2024 Manuel Schneider
// SPDX-License-Identifier: MIT
 
#pragma once
#include <QObject>
#include <QString>
#include <albert/config.h>
#include <albert/export.h>
#include <filesystem>
#include <memory>
#include <vector>
class QSettings;
class QWidget;
 
namespace albert
{
class Extension;
class PluginLoader;
 
class ALBERT_EXPORT PluginInstance : public QObject
{
public:
 
    virtual QWidget *buildConfigWidget();
 
    virtual std::vector<albert::Extension*> extensions();
 
public:
 
    [[nodiscard]] const PluginLoader &loader() const;
 
    [[nodiscard]] std::filesystem::path cacheLocation() const;
 
    [[nodiscard]] std::filesystem::path configLocation() const;
 
    [[nodiscard]] std::filesystem::path dataLocation() const;
 
    [[nodiscard]] std::vector<std::filesystem::path> dataLocations() const;
 
    [[nodiscard]] std::unique_ptr<QSettings> settings() const;
 
    [[nodiscard]] std::unique_ptr<QSettings> state() const;
 
    void readKeychain(const QString &key,
                      std::function<void(const QString &)> onSuccess,
                      std::function<void(const QString &)> onError) const;
 
    void writeKeychain(const QString &key,
                       const QString &value,
                       std::function<void()> onSuccess,
                       std::function<void(const QString&)> onError) const;
 
protected:
 
    PluginInstance();
    virtual ~PluginInstance();
 
private:
 
    class Private;
    std::unique_ptr<Private> d;
 
};
 
}
 
#define ALBERT_PLUGIN Q_OBJECT Q_PLUGIN_METADATA(IID ALBERT_PLUGIN_IID FILE "metadata.json")