optionsmodel.h

Go to the documentation of this file.

/*
    SPDX-FileCopyrightText: 2020 Ismael Asensio <isma.af@gmail.com>
 
    SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
*/
 
#pragma once
 
#include <rules.h>
 
#include <QAbstractListModel>
#include <QIcon>
#include <QVariant>
 
namespace KWin
{
 
class OptionsModel : public QAbstractListModel
{
    Q_OBJECT
    Q_PROPERTY(int selectedIndex READ selectedIndex NOTIFY selectedIndexChanged)
    Q_PROPERTY(int allOptionsMask READ allOptionsMask NOTIFY modelUpdated)
    Q_PROPERTY(int useFlags READ useFlags CONSTANT)
 
public:
    enum OptionsRole {
        ValueRole = Qt::UserRole,
        IconNameRole,
        OptionTypeRole, // The type of an option item, defaults to NormalOption
        BitMaskRole,
    };
    Q_ENUM(OptionsRole)
 
    enum OptionType {
        NormalOption = 0, 
        ExclusiveOption, 
        SelectAllOption, 
    };
    Q_ENUM(OptionType)
 
    struct Data
    {
        Data(const QVariant &value, const QString &text, const QIcon &icon = {}, const QString &description = {}, OptionType optionType = NormalOption)
            : value(value)
            , text(text)
            , icon(icon)
            , description(description)
            , optionType(optionType)
        {
        }
        Data(const QVariant &value, const QString &text, const QString &description)
            : value(value)
            , text(text)
            , description(description)
        {
        }
 
        QVariant value;
        QString text;
        QIcon icon;
        QString description;
        OptionType optionType = NormalOption;
    };
 
public:
    OptionsModel(QList<Data> data = {}, bool useFlags = false)
        : QAbstractListModel()
        , m_data(data)
        , m_index(0)
        , m_useFlags(useFlags){};
 
    int rowCount(const QModelIndex &parent = QModelIndex()) const override;
    QHash<int, QByteArray> roleNames() const override;
    QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
 
    QVariant value() const;
    void setValue(QVariant value);
    void resetValue();
 
    bool useFlags() const;
    QVariant allValues() const;
    uint allOptionsMask() const;
 
    void updateModelData(const QList<Data> &data);
 
    Q_INVOKABLE int indexOf(const QVariant &value) const;
    Q_INVOKABLE QString textOfValue(const QVariant &value) const;
    int selectedIndex() const;
    uint bitMask(int index) const;
 
Q_SIGNALS:
    void selectedIndexChanged(int index);
    void modelUpdated();
 
public:
    QList<Data> m_data;
 
protected:
    int m_index = 0;
    bool m_useFlags = false;
};
 
class RulePolicy : public OptionsModel
{
public:
    enum Type {
        NoPolicy,
        StringMatch,
        SetRule,
        ForceRule
    };
 
public:
    RulePolicy(Type type)
        : OptionsModel(policyOptions(type))
        , m_type(type){};
 
    Type type() const;
    int value() const;
    QString policyKey(const QString &key) const;
 
private:
    static QList<Data> policyOptions(RulePolicy::Type type);
 
private:
    Type m_type;
};
 
} // namespace