File indexing completed on 2024-05-12 05:53:14

0001 /*
0002  * Copyright 2020 Tomaz Canabrava <tcanabrava@kde.org>
0003  *
0004  * This library is free software; you can redistribute it and/or
0005  * modify it under the terms of the GNU Lesser General Public
0006  * License as published by the Free Software Foundation; either
0007  * version 2.1 of the License, or (at your option) version 3, or any
0008  * later version accepted by the membership of KDE e.V. (or its
0009  * successor approved by the membership of KDE e.V.), which shall
0010  * act as a proxy defined in Section 6 of version 3 of the license.
0011  *
0012  * This library is distributed in the hope that it will be useful,
0013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0015  * Lesser General Public License for more details.
0016  *
0017  * You should have received a copy of the GNU Lesser General Public
0018  * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
0019  */
0020 
0021 #pragma once
0022 
0023 #include <KPluginFactory>
0024 #include <KPluginMetaData>
0025 #include <QAbstractListModel>
0026 
0027 #include "kirogicore_export.h"
0028 
0029 namespace Kirogi
0030 {
0031 /* This class is the base class of different models for plugins in Kirogi
0032  */
0033 class KIROGI_EXPORT AbstractPluginModel : public QAbstractListModel
0034 {
0035     Q_OBJECT
0036 public:
0037     explicit AbstractPluginModel(QObject *parent = nullptr);
0038     ~AbstractPluginModel() override;
0039 
0040     QHash<int, QByteArray> roleNames() const override;
0041     int rowCount(const QModelIndex &parent = QModelIndex()) const override final;
0042     QObject *pluginForId(const QString &id) const;
0043     KPluginMetaData metadataAt(int row) const;
0044 
0045     void loadPluginByType(const QString &type);
0046     Q_INVOKABLE bool loadPluginByIndex(int idx);
0047     Q_INVOKABLE bool loadPluginById(const QString &id);
0048 
0049     Q_INVOKABLE bool unloadPlugin(int row);
0050     Q_INVOKABLE bool unloadAllPlugins();
0051 
0052 Q_SIGNALS:
0053     void pluginLoaded(const QString &pluginId, const QString &name, QObject *plugin) const;
0054 
0055 protected:
0056     virtual QObject *requestFromFactory(KPluginFactory *factory) = 0;
0057 
0058 private:
0059     class Private;
0060     Private *d;
0061 };
0062 
0063 }