effectsmodel.h

Go to the documentation of this file.

/*
    KWin - the KDE window manager
    This file is part of the KDE project.
 
    SPDX-FileCopyrightText: 2013 Antonis Tsiapaliokas <kok3rs@gmail.com>
    SPDX-FileCopyrightText: 2018 Vlad Zahorodnii <vlad.zahorodnii@kde.org>
 
    SPDX-License-Identifier: GPL-2.0-or-later
*/
 
#pragma once
 
#include <kwin_export.h>
 
#include <KSharedConfig>
 
#include <QAbstractItemModel>
#include <QString>
#include <QUrl>
#include <QWindow>
 
namespace KWin
{
 
class KWIN_EXPORT EffectsModel : public QAbstractItemModel
{
    Q_OBJECT
 
public:
    enum AdditionalRoles {
        NameRole = Qt::UserRole + 1,
        DescriptionRole,
        AuthorNameRole,
        AuthorEmailRole,
        LicenseRole,
        VersionRole,
        CategoryRole,
        ServiceNameRole,
        IconNameRole,
        StatusRole,
        VideoRole,
        WebsiteRole,
        SupportedRole,
        ExclusiveRole,
        InternalRole,
        ConfigurableRole,
        EnabledByDefaultRole,
        ConfigModuleRole,
        EnabledByDefaultFunctionRole,
    };
 
    enum class Status {
        Disabled = Qt::Unchecked,
        EnabledUndeterminded = Qt::PartiallyChecked,
        Enabled = Qt::Checked
    };
 
    explicit EffectsModel(QObject *parent = nullptr);
 
    // Reimplemented from QAbstractItemModel.
    QHash<int, QByteArray> roleNames() const override;
    QModelIndex index(int row, int column, const QModelIndex &parent = {}) const override;
    QModelIndex parent(const QModelIndex &child) const override;
    int rowCount(const QModelIndex &parent = {}) const override;
    int columnCount(const QModelIndex &parent = {}) const 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;
 
    void updateEffectStatus(const QModelIndex &rowIndex, Status effectState);
 
    enum class LoadOptions {
        None,
        KeepDirty
    };
 
    void load(LoadOptions options = LoadOptions::None);
 
    void save();
 
    void defaults();
 
    bool isDefaults() const;
 
    bool needsSave() const;
 
    QModelIndex findByPluginId(const QString &pluginId) const;
 
    void requestConfigure(const QModelIndex &index, QWindow *transientParent);
 
Q_SIGNALS:
    void loaded();
 
protected:
    struct EffectData
    {
        QString name;
        QString description;
        QString authorName;
        QString authorEmail;
        QString license;
        QString version;
        QString untranslatedCategory;
        QString category;
        QString serviceName;
        QString iconName;
        Status status;
        Status originalStatus;
        bool enabledByDefault;
        bool enabledByDefaultFunction;
        QUrl video;
        QUrl website;
        bool supported;
        QString exclusiveGroup;
        bool internal;
        bool changed = false;
        QString configModule;
        QVariantList configArgs;
    };
 
    virtual bool shouldStore(const EffectData &data) const;
 
private:
    void loadBuiltInEffects(const KConfigGroup &kwinConfig);
    void loadJavascriptEffects(const KConfigGroup &kwinConfig);
    void loadPluginEffects(const KConfigGroup &kwinConfig);
 
    QList<EffectData> m_effects;
    QList<EffectData> m_pendingEffects;
    int m_lastSerial = -1;
 
    Q_DISABLE_COPY(EffectsModel)
};
 
}