Differential D14542 Diff 46895 kcmkwin/kwindesktop/desktopsmodel.h

Changeset View

Standalone View

View Options

kcmkwin/kwindesktop/desktopsmodel.h

  • This file was added.
1​/*
2​ * Copyright (C) 2018 Eike Hein <hein@kde.org>
3​ * Copyright (C) 2018 Marco Martin <mart@kde.org>
4​ *
5​ * This program is free software; you can redistribute it and/or modify
6​ * it under the terms of the GNU General Public License as published by
7​ * the Free Software Foundation; either version 2 of the License, or
8​ * (at your option) any later version.
9​ *
10​ * This program is distributed in the hope that it will be useful,
11​ * but WITHOUT ANY WARRANTY; without even the implied warranty of
12​ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13​ * GNU General Public License for more details.
14​ *
15​ * You should have received a copy of the GNU General Public License
16​ * along with this program. If not, see <http://www.gnu.org/licenses/>.
17​ */
18​
19​#ifndef DESKTOPSMODEL_H
20​#define DESKTOPSMODEL_H
21​
22​#include <QAbstractListModel>
23​
24​#include "../virtualdesktopsdbustypes.h"
25​
26​class QDBusArgument;
27​class QDBusMessage;
28​class QDBusServiceWatcher;
29​
30​
31​namespace KWin
zzagUnsubmitted
Not Done

Coding style nitpick: namespaces have the opening brace on a new line.

zzag: Coding style nitpick: namespaces have the opening brace on a new line.
32​{
33​
34​/**
35​ * @short An item model around KWin's D-Bus API for virtual desktops.
36​ *
37​ * The model initially gets the state from KWin and populates.
38​ *
39​ * As long as the user makes no changes, KWin-side changes are directly
40​ * exposed in the model.
41​ *
42​ * If the user makes changes (see the `userModified` property), it stops
zzagUnsubmitted
Not Done

Coding style nitpick: the kdelibs coding style doesn't say anything about indenting access modifiers, but in KWin, we usually put access modifiers on the start of a line (i.e. they are not indented).

zzag: Coding style nitpick: the kdelibs coding style doesn't say anything about indenting access…
43​ * exposing KWin-side changes live, but it keeps track of the KWin-side
44​ * changes, so it can figure out and apply the delta when `syncWithServer`
45​ * is called.
46​ *
47​ * When KWin-side changes happen while the model is user-modified, the
48​ * model signals this via the `serverModified` property. A call to
49​ * `syncWithServer` will overwrite the KWin-side changes.
50​ *
51​ * After synchronization, the model tracks Kwin-side changes again,
zzagUnsubmitted
Not Done

*KWin-side

zzag: *KWin-side
52​ * until the user makes further changes.
53​ *
54​ * @author Eike Hein <hein@kde.org>
55​ **/
zzagUnsubmitted
Not Done

Minor nitpick: you could also use uniform initialization, e.g.

int rowCount(const QModelIndex &parent = {}) const override;

It saves typing extra characters, also looks neater, IMHO. I didn't test it, so take my words with a grain of salt.

zzag: Minor nitpick: you could also use uniform initialization, e.g. ```lang=cpp int rowCount(const…
56​
57​class DesktopsModel : public QAbstractListModel
58​{
59​ Q_OBJECT
60​ Q_PROPERTY(bool ready READ ready NOTIFY readyChanged)
61​ Q_PROPERTY(QString error READ error NOTIFY errorChanged)
62​ Q_PROPERTY(bool userModified READ userModified NOTIFY userModifiedChanged)
63​ Q_PROPERTY(bool serverModified READ serverModified NOTIFY serverModifiedChanged)
64​ Q_PROPERTY(int rows READ rows WRITE setRows NOTIFY rowsChanged)
65​
66​public:
67​ enum AdditionalRoles {
68​ Id = Qt::UserRole + 1,
69​ DesktopRow
70​ };
71​ Q_ENUM(AdditionalRoles)
72​
73​ explicit DesktopsModel(QObject *parent = nullptr);
74​ ~DesktopsModel() override;
75​
76​ QHash<int, QByteArray> roleNames() const override;
77​
78​ QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
79​ int rowCount(const QModelIndex &parent = {}) const override;
80​
81​ bool ready() const;
82​ QString error() const;
83​
84​ bool userModified() const;
85​ bool serverModified() const;
86​
zzagUnsubmitted
Not Done

Feel free to ignore this one: as an alternative, we could use an enum instead of the boolean trap.

zzag: Feel free to ignore this one: as an alternative, we could use an enum instead of the boolean…
87​ int rows() const;
88​ void setRows(int rows);
89​
90​ Q_INVOKABLE void createDesktop(const QString &name);
91​ Q_INVOKABLE void removeDesktop(const QString &id);
92​ Q_INVOKABLE void setDesktopName(const QString &id, const QString &name);
93​
94​ Q_INVOKABLE void syncWithServer();
95​
96​Q_SIGNALS:
97​ void needsSaving(bool needsSaving) const;
98​ void readyChanged() const;
99​ void errorChanged() const;
100​ void userModifiedChanged() const;
101​ void serverModifiedChanged() const;
102​ void rowsChanged() const;
103​
104​protected Q_SLOTS:
105​ void reset();
106​ void getAllAndConnect(const QDBusMessage &msg);
107​ void desktopCreated(const QString &id, const KWin::DBusDesktopDataStruct &data);
108​ void desktopRemoved(const QString &id);
109​ void desktopDataChanged(const QString &id, const KWin::DBusDesktopDataStruct &data);
110​ void desktopRowsChanged(uint rows);
111​ void checkModifiedState(bool server = false);
112​ void handleCallError();
113​
114​private:
115​ QDBusServiceWatcher *m_serviceWatcher;
116​ QString m_error;
117​ bool m_userModified;
118​ bool m_serverModified;
119​ QStringList m_serverSideDesktops;
120​ QHash<QString,QString> m_serverSideNames;
121​ int m_serverSideRows;
122​ QStringList m_desktops;
123​ QHash<QString,QString> m_names;
124​ int m_rows;
zzagUnsubmitted
Not Done

For better readability, you could create a struct to represent the state on both sides, e.g.:

struct State
{
    QStringList desktops;
    QHash<QString, QString> names;
    int rows;
};

State m_clientState;
State m_serverState;
zzag: For better readability, you could create a struct to represent the state on both sides, e.g.
125​ bool m_synchronizing;
126​};
127​
128​}
129​
130​#endif