Differential D28152 Diff 78787 kcmkwin/kwinrules/kcmrules.h

Changeset View

Standalone View

View Options

kcmkwin/kwinrules/kcmrules.h

  • This file was added.
1​/*
2​ * Copyright (c) 2020 Ismael Asensio <isma.af@gmail.com>
3​ *
4​ * This program is free software; you can redistribute it and/or
5​ * modify it under the terms of the GNU General Public License as
6​ * published by the Free Software Foundation; either version 2 of
7​ * the License or (at your option) version 3 or any later version
8​ * accepted by the membership of KDE e.V. (or its successor approved
9​ * by the membership of KDE e.V.), which shall act as a proxy
10​ * defined in Section 14 of version 3 of the license.
11​ *
12​ * This program is distributed in the hope that it will be useful,
13​ * but WITHOUT ANY WARRANTY; without even the implied warranty of
14​ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15​ * GNU General Public License for more details.
16​ *
17​ * You should have received a copy of the GNU General Public License
18​ * along with this program. If not, see <http://www.gnu.org/licenses/>.
19​ */
20​
21​#pragma once
22​
23​#include <rules.h>
24​#include "rulebooksettings.h"
25​#include "rulesmodel.h"
26​
27​#include <QStringListModel>
28​
29​#include <KQuickAddons/ConfigModule>
30​
31​
32​namespace KWin
33​{
34​
35​class KCMKWinRules : public KQuickAddons::ConfigModule
36​{
37​ Q_OBJECT
38​
39​ Q_PROPERTY(QStringList ruleBookModel READ ruleBookModel NOTIFY ruleBookModelChanged)
40​ Q_PROPERTY(int editingIndex READ editingIndex NOTIFY editingIndexChanged)
broulikUnsubmitted
Done

I would prefer if this was a proper model (or QStandardItemModel) so we don't end up having the list destroy and recreate its entire state when we change it. This way yo could also move items and it just swaps the delegates without redoing the entire list.
When you signal changes to a QStringList bound to a model the view resets completely.

(Also, by the name of the variable it wasn't clear to me what it actually is about.)

broulik: I would prefer if this was a proper model (or `QStandardItemModel`) so we don't end up having…
41​ Q_PROPERTY(RulesModel *rulesModel MEMBER m_rulesModel CONSTANT)
42​
43​public:
44​ explicit KCMKWinRules(QObject *parent, const QVariantList &arguments);
45​ ~KCMKWinRules() override;
46​
broulikUnsubmitted
Done

override

broulik: `override`
47​ Q_INVOKABLE void setRuleDescription(int index, const QString &description);
48​ Q_INVOKABLE void editRule(int index);
49​
50​ Q_INVOKABLE void createRule();
51​ Q_INVOKABLE void removeRule(int index);
52​ Q_INVOKABLE void moveRule(int sourceIndex, int destIndex);
broulikUnsubmitted
Done

It's a property already, doesn't need to be a slot

broulik: It's a property already, doesn't need to be a `slot`
53​
54​ Q_INVOKABLE void exportToFile(const QUrl &path, int index);
55​ Q_INVOKABLE void importFromFile(const QUrl &path);
56​
57​public slots:
broulikUnsubmitted
Done

createRule?
also perhaps make it Q_INVOKABLE rather than a slot. At least personally I use that to indicate stuff I want explicitly called from QML

broulik: `createRule`? also perhaps make it `Q_INVOKABLE` rather than a slot. At least personally I use…
58​ void load() override;
59​ void save() override;
60​
61​signals:
62​ void ruleBookModelChanged();
63​ void editingIndexChanged();
64​
65​private slots:
66​ void updateNeedsSave();
67​ void updateState();
68​
69​private:
70​ QStringList ruleBookModel() const;
71​ int editingIndex() const;
72​ void saveCurrentRule();
73​
74​private:
75​ RuleBookSettings *m_ruleBook;
76​ QVector<Rules *> m_rules;
77​ RulesModel* m_rulesModel;
78​
79​ int m_editingIndex = -1;
80​};
broulikUnsubmitted
Done

I think a QPersistentModelIndex might be better suited for this, so it automatically adjusts as you add, remove, rearrange rules. You still probably need to signal the changes for it manually, so not sure. Just food for thought.

broulik: I think a `QPersistentModelIndex` might be better suited for this, so it automatically adjusts…
81​
82​} // namespace