optionsmodel.cpp

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
*/
 
#include "optionsmodel.h"
 
#include <KLocalizedString>
 
namespace KWin
{
 
QHash<int, QByteArray> OptionsModel::roleNames() const
{
    return {
        {Qt::DisplayRole, QByteArrayLiteral("display")},
        {Qt::DecorationRole, QByteArrayLiteral("decoration")},
        {Qt::ToolTipRole, QByteArrayLiteral("tooltip")},
        {ValueRole, QByteArrayLiteral("value")},
        {IconNameRole, QByteArrayLiteral("iconName")},
        {OptionTypeRole, QByteArrayLiteral("optionType")},
        {BitMaskRole, QByteArrayLiteral("bitMask")},
    };
}
 
int OptionsModel::rowCount(const QModelIndex &parent) const
{
    if (parent.isValid()) {
        return 0;
    }
    return m_data.size();
}
 
QVariant OptionsModel::data(const QModelIndex &index, int role) const
{
    if (!checkIndex(index, CheckIndexOption::IndexIsValid | CheckIndexOption::ParentIsInvalid)) {
        return QVariant();
    }
 
    const Data item = m_data.at(index.row());
 
    switch (role) {
    case Qt::DisplayRole:
        return item.text;
    case Qt::UserRole:
        return item.value;
    case Qt::DecorationRole:
        return item.icon;
    case IconNameRole:
        return item.icon.name();
    case Qt::ToolTipRole:
        return item.description;
    case OptionTypeRole:
        return item.optionType;
    case BitMaskRole:
        return bitMask(index.row());
    }
    return QVariant();
}
 
int OptionsModel::selectedIndex() const
{
    return m_index;
}
 
int OptionsModel::indexOf(const QVariant &value) const
{
    for (int index = 0; index < m_data.count(); index++) {
        if (m_data.at(index).value == value) {
            return index;
        }
    }
    return -1;
}
 
QString OptionsModel::textOfValue(const QVariant &value) const
{
    int index = indexOf(value);
    if (index < 0 || index >= m_data.count()) {
        return QString();
    }
    return m_data.at(index).text;
}
 
QVariant OptionsModel::value() const
{
    if (m_data.isEmpty()) {
        return QVariant();
    }
    if (m_data.at(m_index).optionType == SelectAllOption) {
        return allValues();
    }
    return m_data.at(m_index).value;
}
 
void OptionsModel::setValue(QVariant value)
{
    if (this->value() == value) {
        return;
    }
    int index = indexOf(value);
    if (index >= 0 && index != m_index) {
        m_index = index;
        Q_EMIT selectedIndexChanged(index);
    }
}
 
void OptionsModel::resetValue()
{
    m_index = 0;
    Q_EMIT selectedIndexChanged(m_index);
}
 
bool OptionsModel::useFlags() const
{
    return m_useFlags;
};
 
uint OptionsModel::bitMask(int index) const
{
    const Data item = m_data.at(index);
 
    if (item.optionType == SelectAllOption) {
        return allOptionsMask();
    }
    if (m_useFlags) {
        return item.value.toUInt();
    }
    return 1u << index;
}
 
QVariant OptionsModel::allValues() const
{
    if (m_useFlags) {
        return allOptionsMask();
    }
 
    QVariantList list;
    for (const Data &item : std::as_const(m_data)) {
        if (item.optionType == NormalOption) {
            list << item.value;
        }
    }
    return list;
}
 
uint OptionsModel::allOptionsMask() const
{
    uint mask = 0;
    for (int index = 0; index < m_data.count(); index++) {
        if (m_data.at(index).optionType == NormalOption) {
            mask += bitMask(index);
        }
    }
    return mask;
}
 
void OptionsModel::updateModelData(const QList<Data> &data)
{
    beginResetModel();
    m_data = data;
    endResetModel();
    Q_EMIT modelUpdated();
}
 
RulePolicy::Type RulePolicy::type() const
{
    return m_type;
}
 
int RulePolicy::value() const
{
    if (m_type == RulePolicy::NoPolicy) {
        return Rules::Apply; // To simplify external checks when rule has no policy
    }
    return OptionsModel::value().toInt();
}
 
QString RulePolicy::policyKey(const QString &key) const
{
    switch (m_type) {
    case NoPolicy:
        return QString();
    case StringMatch:
        return QStringLiteral("%1match").arg(key);
    case SetRule:
    case ForceRule:
        return QStringLiteral("%1rule").arg(key);
    }
 
    return QString();
}
 
QList<RulePolicy::Data> RulePolicy::policyOptions(RulePolicy::Type type)
{
    static const auto stringMatchOptions = QList<RulePolicy::Data>{
        {Rules::UnimportantMatch, i18n("Unimportant")},
        {Rules::ExactMatch, i18n("Exact Match")},
        {Rules::SubstringMatch, i18n("Substring Match")},
        {Rules::RegExpMatch, i18n("Regular Expression")}};
 
    static const auto setRuleOptions = QList<RulePolicy::Data>{
        {Rules::Apply,
         i18n("Apply Initially"),
         i18n("The window property will be only set to the given value after the window is created."
              "\nNo further changes will be affected.")},
        {Rules::ApplyNow,
         i18n("Apply Now"),
         i18n("The window property will be set to the given value immediately and will not be affected later"
              "\n(this action will be deleted afterwards).")},
        {Rules::Remember,
         i18n("Remember"),
         i18n("The value of the window property will be remembered and, every time the window"
              " is created, the last remembered value will be applied.")},
        {Rules::DontAffect,
         i18n("Do Not Affect"),
         i18n("The window property will not be affected and therefore the default handling for it will be used."
              "\nSpecifying this will block more generic window settings from taking effect.")},
        {Rules::Force,
         i18n("Force"),
         i18n("The window property will be always forced to the given value.")},
        {Rules::ForceTemporarily,
         i18n("Force Temporarily"),
         i18n("The window property will be forced to the given value until it is hidden"
              "\n(this action will be deleted after the window is hidden).")}};
 
    static auto forceRuleOptions = QList<RulePolicy::Data>{
        setRuleOptions.at(4), // Rules::Force
        setRuleOptions.at(5), // Rules::ForceTemporarily
        setRuleOptions.at(3), // Rules::DontAffect
    };
 
    switch (type) {
    case NoPolicy:
        return {};
    case StringMatch:
        return stringMatchOptions;
    case SetRule:
        return setRuleOptions;
    case ForceRule:
        return forceRuleOptions;
    }
    return {};
}
 
} // namespace
 
#include "moc_optionsmodel.cpp"