Differential D28152 Diff 80694 kcmkwin/kwinrules/rulesmodel.h

Changeset View

Standalone View

kcmkwin/kwinrules/rulesmodel.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		#ifndef KWIN_RULES_MODEL_H
22		#define KWIN_RULES_MODEL_H
23
24		#include "ruleitem.h"
25		#include "rulesettings.h"
26		#include <rules.h>
27
28		#include <QAbstractListModel>
29		#include <QSortFilterProxyModel>
30		#include <QObject>
31
32		#ifdef KWIN_BUILD_ACTIVITIES
33		#include <KActivities/Consumer>
34		#endif
35
36
37		namespace KWin
38		{
39
40		class RulesModel : public QAbstractListModel
41		{
42		Q_OBJECT
43
44		Q_PROPERTY(QString description READ description WRITE setDescription NOTIFY descriptionChanged)
45		Q_PROPERTY(QString warningMessage READ warningMessage NOTIFY warningMessageChanged)
46
47		public:
48		enum RulesRole {
	broulikUnsubmitted Done I kinda think this should be a `QString` property and have the info filled on the C++ side. But since it's just used for that one case, maybe name it `showWindowClassWarning` or something? broulik: I kinda think this should be a `QString` property and have the info filled on the C++ side. But…
49		NameRole = Qt::DisplayRole,
50		DescriptionRole = Qt::ToolTipRole,
51		IconRole = Qt::DecorationRole,
52		IconNameRole = Qt::UserRole + 1,
53		KeyRole,
54		SectionRole,
55		EnabledRole,
56		SelectableRole,
57		ValueRole,
58		TypeRole,
59		PolicyRole,
60		PolicyModelRole,
61		OptionsModelRole,
62		SuggestedValueRole
63		};
64		Q_ENUM(RulesRole)
65
66		public:
67		explicit RulesModel(QObject *parent = nullptr);
68		~RulesModel();
69
70		int rowCount(const QModelIndex &parent = QModelIndex()) const override;
71		QHash<int, QByteArray> roleNames() const override;
72		QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
73		bool setData(const QModelIndex & index, const QVariant & value, int role) override;
74
75		bool hasRule(const QString &key) const;
76		RuleItem *ruleItem(const QString &key) const;
77
78		void readFromSettings(RuleSettings *settings);
79		void writeToSettings(RuleSettings *settings) const;
80
81		void importFromRules(Rules *rules);
82		Rules *exportToRules() const;
83
84		void setWindowProperties(const QVariantMap &info, bool forceValue = false);
85
86		QString description() const;
87		void setDescription(const QString &description);
88		QString warningMessage() const;
89
90
91		public slots:
92		void detectWindowProperties(int secs);
93
94		signals:
95		void descriptionChanged();
96		void warningMessageChanged();
97		void suggestionsChanged();
98
99		private:
100		void populateRuleList();
101		bool wmclassWarning() const;
102		RuleItem addRule(RuleItem rule);
103		QString defaultDescription() const;
104
105		static const QHash<QString, QString> x11PropertyHash();
106
107		QList<OptionsModel::Data> windowTypesModelData() const;
108		QList<OptionsModel::Data> virtualDesktopsModelData() const;
109		QList<OptionsModel::Data> activitiesModelData() const;
110		QList<OptionsModel::Data> placementModelData() const;
111		QList<OptionsModel::Data> focusModelData() const;
112		QList<OptionsModel::Data> colorSchemesModelData() const;
113
114		private slots:
115		void selectX11Window();
116
117		private:
118		QList<RuleItem *> m_ruleList;
119		QHash<QString, RuleItem *> m_rules;
120		#ifdef KWIN_BUILD_ACTIVITIES
121		KActivities::Consumer *m_activities;
122		#endif
123		};
124
125		}
126
127		#endif