Differential D28152 Diff 78312 kcmkwin/kwinrules/ruleitem.h

Changeset View

Standalone View

kcmkwin/kwinrules/ruleitem.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_RULEITEM_H
22		#define KWIN_RULEITEM_H
23
24		#include "optionsmodel.h"
25
26		#include <QIcon>
27
28
29		namespace KWin
30		{
31
32		class RuleItemPrivate;
33
	broulikUnsubmitted Done Since none of these classes are exported, I think you can save yourself the trouble of using private data classes broulik: Since none of these classes are exported, I think you can save yourself the trouble of using…
	iasensioAuthorUnsubmitted Not Done It helped me at the beginning to set-up the model items... but you're probably right now it's just an inconvenience iasensio: It helped me at the beginning to set-up the model items... but you're probably right now it's…
34		class RuleItem : public QObject
35		{
36		Q_OBJECT
37
38		public:
39		enum Type {
40		Undefined,
	broulikUnsubmitted Not Done I /think/ if you based your class on `QMetaObject::Type` you can generalize it a lot without putting `switch` statements for your types in it? However, there's also `Coordinate` and `Shortcut`, so maybe not. broulik: I /think/ if you based your class on `QMetaObject::Type` you can generalize it a lot without…
	iasensioAuthorUnsubmitted Not Done I definitely want to go with a nicer approach for this thing, but for now is the simplest way I found. @hchain suggested to use a template, ideally, using the type on the KConfigXT schema. Currently `RuleItem::Type` has a double meaning: it sets the stored type and the edit field in the UI. And anyway, `Coordinate` just maps to a `QPoint` or `QSize`, and `Shortcut` a `QKeySequence`. iasensio: I definitely want to go with a nicer approach for this thing, but for now is the simplest way I…
41		Boolean,
42		String,
43		Integer,
44		Option,
45		FlagsOption,
46		Percentage,
47		Coordinate,
48		Shortcut
49		};
50		Q_ENUM(Type)
51
52		enum Flags {
53		NoFlags = 0,
54		AlwaysEnabled = 1u << 0,
55		StartEnabled = 1u << 1,
56		AffectsWarning = 1u << 2,
57		AffectsDescription = 1u << 3,
58		AllFlags = 0b1111
59		};
60
61		public:
62		RuleItem() {};
63		RuleItem(const QString &key,
64		const RulePolicy::Type policyType,
65		const Type type,
66		const QString &name,
67		const QString &section,
68		const QString &iconName = QStringLiteral("window"),
69		const QList<OptionsModel::Data> &options = {}
70		);
71		~RuleItem();
72
73		QString key() const;
74		QString name() const;
75		QString section() const;
76		QIcon icon() const;
77		QString iconName() const;
78
79		bool isEnabled() const;
80		void setEnabled(bool enabled);
81
82		QString description() const;
83		void setDescription(const QString &description);
84
85		bool hasFlag(uint flag) const;
86		void setFlags(uint flags, bool active=true);
87
88		Type type() const;
89		QVariant value() const;
90		void setValue(QVariant value);
91
92		QVariant options() const;
93		void setOptionsData(const QList<OptionsModel::Data> &data);
94
95		RulePolicy::Type policyType() const;
96		int policy() const; // int belongs to anonymous enum in Rules::
97		void setPolicy(int policy); // int belongs to anonymous enum in Rules::
98		QVariant policyModel() const;
99		QString policyKey() const;
100
101		void reset();
102
103		private:
104		static QVariant typedValue(const QVariant &value, const Type type);
105
106		private:
107		RuleItemPrivate *d;
108		RulePolicy *p;
109		OptionsModel *o;
	broulikUnsubmitted Done Generally we want to have speaking names, i.e. name this `policy`. `d` pointer is an exception. broulik: Generally we want to have speaking names, i.e. name this `policy`. `d` pointer is an exception.
110		};
111
112		} //namespace
113
114		#endif //KWIN_RULEITEM_H