File indexing completed on 2026-08-09 07:09:56

 /*
     SPDX-FileCopyrightText: 2021 Nicolas Fella <nicolas.fella@gmx.de>
     SPDX-FileCopyrightText: 2021 Alexander Lohnau <alexander.lohnau@gmx.de>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef KPLUGINMODEL_H
 #define KPLUGINMODEL_H
 
 #include "kcmutilscore_export.h"
 
 #include <QAbstractListModel>
 #include <QList>
 
 #include <KPluginMetaData>
 #include <memory>
 
 class KConfigGroup;
 class KPluginModelPrivate;
 
 class KCMUTILSCORE_EXPORT KPluginModel : public QAbstractListModel
 {
     Q_OBJECT
 
 public:
     enum Roles {
         NameRole = Qt::DisplayRole,
         IconRole = Qt::DecorationRole,
         EnabledRole = Qt::CheckStateRole,
         DescriptionRole = Qt::UserRole + 1,
         IsChangeableRole,
         MetaDataRole,
         ConfigRole,
         IdRole,
         EnabledByDefaultRole,
         SortableRole, /// @internal
     };
 
     explicit KPluginModel(QObject *parent = nullptr);
     ~KPluginModel() override;
 
     QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
     bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole) override;
     int rowCount(const QModelIndex &parent = QModelIndex()) const override;
     QHash<int, QByteArray> roleNames() const override;
 
     bool moveRows(const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild) override;
 
     void addPlugins(const QList<KPluginMetaData> &plugins, const QString &categoryLabel);
 
     /**
      * Add plugins that should not be sorted automatically based on their name
      * This is useful in case your app has a custom sorting mechanism or implements reordering of plugins
      *
      * @since 6.0
      */
     void addUnsortablePlugins(const QList<KPluginMetaData> &plugins, const QString &categoryLabel);
     /// @since 6.0
     void removePlugin(const KPluginMetaData &data);
     void clear();
     void setConfig(const KConfigGroup &config);
     void save();
     void load();
     void defaults();
     bool isSaveNeeded();
 
     /**
      * Returns the KPluginMetaData object of the plugin's config module. If no plugin is found or the plugin does not have a config, the resulting
      * KPluginMetaData object will be invalid.
      * @since 5.94
      */
     KPluginMetaData findConfigForPluginId(const QString &pluginId) const;
 
     Q_SIGNAL void defaulted(bool isDefaulted);
     Q_SIGNAL void isSaveNeededChanged();
 
 private:
     const std::unique_ptr<KPluginModelPrivate> d;
     friend class KPluginProxyModel;
     QStringList getOrderedCategoryLabels();
 };
 #endif