Differential D28152 Diff 78127 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 RulesFilterModel;
41
42		class RulesModel : public QAbstractListModel
43		{
44		Q_OBJECT
45
46		Q_PROPERTY(QString description READ description NOTIFY descriptionChanged)
47		Q_PROPERTY(bool showWarning READ isWarningShown NOTIFY showWarningChanged)
48		Q_PROPERTY(RulesFilterModel *filter MEMBER m_filterModel CONSTANT)
	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
50		public:
51		enum RulesRole {
52		NameRole = Qt::DisplayRole,
53		DescriptionRole = Qt::ToolTipRole,
54		IconRole = Qt::DecorationRole,
55		IconNameRole = Qt::UserRole + 1,
56		KeyRole,
57		SectionRole,
58		EnabledRole,
59		SelectableRole,
60		ValueRole,
61		TypeRole,
62		PolicyRole,
63		PolicyModelRole,
64		OptionsModelRole
65		};
66
67		public:
68		explicit RulesModel(QObject *parent = nullptr);
69		~RulesModel();
70
71		int rowCount(const QModelIndex &parent = QModelIndex()) const override;
72		QHash<int, QByteArray> roleNames() const override;
73		QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
74		bool setData(const QModelIndex & index, const QVariant & value, int role) override;
75
76		bool hasRule(const QString &key) const;
77		RuleItem *ruleItem(const QString &key) const;
78
79		void readFromSettings(RuleSettings *settings);
80		void writeToSettings(RuleSettings *settings) const;
81
82		void importFromRules(Rules *rules);
83		Rules *exportToRules() const;
84
85		void prefillProperties(const QVariantMap &info);
86
87		QString description() const;
88		bool isWarningShown() const;
89
90		public slots:
91		void detectWindowProperties(int secs);
92
93		signals:
94		void descriptionChanged();
95		void showWarningChanged();
96
97		private:
98		void populateRuleList();
99		RuleItem addRule(RuleItem rule);
100		QString defaultDescription() const;
101
102		static const QHash<QString, QString> x11PropertyHash();
103
104		QList<OptionsModel::Data> windowTypesModelData() const;
105		QList<OptionsModel::Data> virtualDesktopsModelData() const;
106		QList<OptionsModel::Data> activitiesModelData() const;
107		QList<OptionsModel::Data> placementModelData() const;
108		QList<OptionsModel::Data> focusModelData() const;
109		QList<OptionsModel::Data> colorSchemesModelData() const;
110
111		private slots:
112		void selectX11Window();
113
114		private:
115		QList<RuleItem *> m_ruleList;
116		QHash<QString, RuleItem *> m_rules;
117		RulesFilterModel *m_filterModel;
118		#ifdef KWIN_BUILD_ACTIVITIES
119		KActivities::Consumer *m_activities;
120		#endif
121		};
122
123
124		class RulesFilterModel : public QSortFilterProxyModel
125		{
126		Q_OBJECT
127		Q_PROPERTY(bool showAll READ showAll WRITE setShowAll NOTIFY showAllChanged)
128		Q_PROPERTY(QString searchText WRITE setSearchText)
129
130		public:
131		explicit RulesFilterModel(QObject *parent) : QSortFilterProxyModel(parent) {};
132		bool filterAcceptsRow(int source_row, const QModelIndex &source_parent) const override;
133
134		void setSearchText(const QString &text);
135		bool showAll() const;
136		void setShowAll(bool showAll);
137
138		signals:
139		void showAllChanged();
140
141		private:
142		bool m_isSearching = false;
143		bool m_showAll = false;
144		};
145
146		}
147
148		#endif