Differential D14542 Diff 46545 kcmkwin/kwindesktop/desktopsmodel.h

Changeset View

Standalone View

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
29
30		namespace KWin
31		{
	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		* @short An item model around KWin's D-Bus API for virtual desktops.
35		*
36		* The model initially gets the state from KWin and populates.
37		*
38		* As long as the user makes no changes, KWin-side changes are directly
39		* exposed in the model.
40		*
41		* If the user makes changes (see the `userModified` property), it stops
42		* exposing KWin-side changes live, but it keeps track of the KWin-side
	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		* changes, so it can figure out and apply the delta when `syncWithServer`
44		* is called.
45		*
46		* When KWin-side changes happen while the model is user-modified, the
47		* model signals this via the `serverModified` property. A call to
48		* `syncWithServer` will overwrite the KWin-side changes.
49		*
50		* After synchronization, the model tracks Kwin-side changes again,
51		* until the user makes further changes.
52		*
	zzagUnsubmitted Not Done KWin-side zzag:* *KWin-side
53		* @author Eike Hein <hein@kde.org>
54		**/
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		class DesktopsModel : public QAbstractListModel
57		{
58		Q_OBJECT
59		Q_PROPERTY(bool ready READ ready NOTIFY readyChanged)
60		Q_PROPERTY(QString error READ error NOTIFY errorChanged)
61		Q_PROPERTY(bool userModified READ userModified NOTIFY userModifiedChanged)
62		Q_PROPERTY(bool serverModified READ serverModified NOTIFY serverModifiedChanged)
63		Q_PROPERTY(int rows READ rows WRITE setRows NOTIFY rowsChanged)
64
65		public:
66		enum AdditionalRoles {
67		Id = Qt::UserRole + 1,
68		DesktopRow
69		};
70		Q_ENUM(AdditionalRoles)
71
72		explicit DesktopsModel(QObject *parent = nullptr);
73		~DesktopsModel() override;
74
75		QHash<int, QByteArray> roleNames() const override;
76
77		QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
78		int rowCount(const QModelIndex &parent = {}) const override;
79
80		bool ready() const;
81		QString error() const;
82
83		bool userModified() const;
84		bool serverModified() const;
85
86		int rows() const;
	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		void setRows(int rows);
88
89		Q_INVOKABLE void createDesktop(const QString &name);
90		Q_INVOKABLE void removeDesktop(const QString &id);
91		Q_INVOKABLE void setDesktopName(const QString &id, const QString &name);
92
93		Q_INVOKABLE void syncWithServer();
94
95		Q_SIGNALS:
96		void needsSaving(bool needsSaving) const;
97		void readyChanged() const;
98		void errorChanged() const;
99		void userModifiedChanged() const;
100		void serverModifiedChanged() const;
101		void rowsChanged() const;
102
103		protected Q_SLOTS:
104		void initialize(const QDBusMessage &msg);
105		void desktopCreated(const QString &id, const KWin::DBusDesktopDataStruct &data);
106		void desktopRemoved(const QString &id);
107		void desktopDataChanged(const QString &id, const KWin::DBusDesktopDataStruct &data);
108		void desktopRowsChanged(uint rows);
109		void checkModifiedState(bool server = false);
110		void handleCallError();
111
112		private:
113		QString m_error;
114		bool m_userModified;
115		bool m_serverModified;
116		QStringList m_serverSideDesktops;
117		QHash<QString,QString> m_serverSideNames;
118		int m_serverSideRows;
119		QStringList m_desktops;
120		QHash<QString,QString> m_names;
121		int m_rows;
122		bool m_synchronizing;
123		};
124
125		}
	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.
126
127		#endif