Differential D28152 Diff 78127 kcmkwin/kwinrules/rulesmodel.cpp

Changeset View

Standalone View

View Options

kcmkwin/kwinrules/rulesmodel.cpp

  • This file was added.
1​/*
2​ * Copyright (c) 2004 Lubos Lunak <l.lunak@kde.org>
3​ * Copyright (c) 2020 Ismael Asensio <isma.af@gmail.com>
4​ *
5​ * This program is free software; you can redistribute it and/or
6​ * modify it under the terms of the GNU General Public License as
7​ * published by the Free Software Foundation; either version 2 of
8​ * the License or (at your option) version 3 or any later version
9​ * accepted by the membership of KDE e.V. (or its successor approved
10​ * by the membership of KDE e.V.), which shall act as a proxy
11​ * defined in Section 14 of version 3 of the license.
12​ *
13​ * This program is distributed in the hope that it will be useful,
14​ * but WITHOUT ANY WARRANTY; without even the implied warranty of
15​ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16​ * GNU General Public License for more details.
17​ *
18​ * You should have received a copy of the GNU General Public License
19​ * along with this program. If not, see <http://www.gnu.org/licenses/>.
20​ */
21​
22​#include "rulesmodel.h"
23​#include <rules.h>
24​
25​#include <QFileInfo>
26​#include <QIcon>
27​#include <QQmlEngine>
28​#include <QTemporaryFile>
29​#include <QtDBus>
30​
31​#include <KColorSchemeManager>
32​#include <KConfig>
33​#include <KLocalizedString>
34​#include <KWindowSystem>
35​
36​
37​namespace KWin
38​{
39​
40​RulesModel::RulesModel(QObject *parent)
41​ : QAbstractListModel(parent)
42​ , m_filterModel(new RulesFilterModel(this))
43​{
44​ qmlRegisterUncreatableType<RuleItem>("org.kde.kcms.kwinrules", 1, 0, "RuleItem",
broulikUnsubmitted
Not Done

I think this should be registered in the KCM constructor, not inside of another type

broulik: I think this should be registered in the KCM constructor, not inside of another type
iasensioAuthorUnsubmitted
Not Done

It's related to the 2nd entry point (kwin_rules_dialog). Since it does not include the kcm, but just the model, this is the most outer object common to both paths.

iasensio: It's related to the 2nd entry point (`kwin_rules_dialog`). Since it does not include the kcm…
45​ QStringLiteral("Do not create objects of type RuleItem"));
46​ qmlRegisterUncreatableType<RulesFilterModel>("org.kde.kcms.kwinrules", 1, 0, "RulesFilterModel",
47​ QStringLiteral("Do not create objects of type RulesFilterModel"));
48​
49​ m_filterModel->setFilterCaseSensitivity(Qt::CaseInsensitive);
50​ m_filterModel->setSourceModel(this);
51​
52​ populateRuleList();
53​}
54​
55​RulesModel::~RulesModel()
56​{
57​}
58​
broulikUnsubmitted
Done

No need to delete those

broulik: No need to delete those
59​QHash< int, QByteArray > RulesModel::roleNames() const
60​{
61​ return {
62​ {KeyRole, QByteArrayLiteral("key")},
63​ {NameRole, QByteArrayLiteral("name")},
64​ {IconRole, QByteArrayLiteral("icon")},
65​ {IconNameRole, QByteArrayLiteral("iconName")},
66​ {SectionRole, QByteArrayLiteral("section")},
67​ {DescriptionRole, QByteArrayLiteral("description")},
68​ {EnabledRole, QByteArrayLiteral("enabled")},
69​ {SelectableRole, QByteArrayLiteral("selectable")},
70​ {ValueRole, QByteArrayLiteral("value")},
71​ {TypeRole, QByteArrayLiteral("type")},
72​ {PolicyRole, QByteArrayLiteral("policy")},
73​ {PolicyModelRole, QByteArrayLiteral("policyModel")},
74​ {OptionsModelRole, QByteArrayLiteral("options")},
75​ };
76​}
77​
78​int RulesModel::rowCount(const QModelIndex &parent) const
79​{
80​ if (parent.isValid()) {
81​ return 0;
82​ }
83​ return m_ruleList.size();
84​}
85​
86​QVariant RulesModel::data(const QModelIndex &index, int role) const
87​{
88​ if (!checkIndex(index, CheckIndexOption::IndexIsValid | CheckIndexOption::ParentIsInvalid)) {
89​ return QVariant();
90​ }
91​
92​ const RuleItem *rule = m_ruleList.at(index.row());
93​
94​ switch (role) {
95​ case KeyRole:
96​ return rule->key();
97​ case NameRole:
98​ return rule->name();
99​ case IconRole:
100​ return rule->icon();
101​ case IconNameRole:
102​ return rule->iconName();
103​ case DescriptionRole:
104​ return rule->description();
105​ case SectionRole:
106​ return rule->section();
107​ case EnabledRole:
108​ return rule->isEnabled();
109​ case SelectableRole:
110​ return !rule->hasFlag(RuleItem::AlwaysEnabled);
111​ case ValueRole:
112​ return rule->value();
113​ case TypeRole:
114​ return rule->type();
115​ case PolicyRole:
116​ return rule->policy();
117​ case PolicyModelRole:
118​ return rule->policyModel();
119​ case OptionsModelRole:
120​ return rule->options();
121​ }
122​ return QVariant();
123​}
124​
125​bool RulesModel::setData(const QModelIndex &index, const QVariant &value, int role)
126​{
127​ if (!checkIndex(index, CheckIndexOption::IndexIsValid | CheckIndexOption::ParentIsInvalid)) {
128​ return false;
129​ }
130​
131​ RuleItem *rule = m_ruleList.at(index.row());
132​
133​ switch (role) {
134​ case EnabledRole:
135​ if (value.toBool() == rule->isEnabled()) {
136​ return true;
137​ }
138​ rule->setEnabled(value.toBool());
139​ break;
140​ case ValueRole:
141​ if (value == rule->value()) {
142​ return true;
143​ }
144​ rule->setValue(value);
145​ break;
146​ case PolicyRole:
147​ if (value.toInt() == rule->policy()) {
148​ return true;
149​ }
150​ rule->setPolicy(value.toInt());
broulikUnsubmitted
Done

Check if you changed the value before emitting this for optimization

broulik: Check if you changed the value before emitting this for optimization
151​ break;
152​ default:
153​ return false;
154​ }
155​
156​ emit dataChanged(index, index, QVector<int>{role});
157​
158​ if (rule->hasFlag(RuleItem::AffectsDescription)) {
159​ emit descriptionChanged();
160​ }
161​ if (rule->hasFlag(RuleItem::AffectsWarning)) {
162​ emit showWarningChanged();
163​ }
164​
165​ return true;
166​}
167​
168​RuleItem *RulesModel::addRule(RuleItem *rule)
169​{
170​ m_ruleList << rule;
171​ m_rules.insert(rule->key(), rule);
172​
173​ return rule;
174​}
175​
176​bool RulesModel::hasRule(const QString& key) const
177​{
178​ return m_rules.contains(key);
broulikUnsubmitted
Done

Avoid operator[] which may detach and insert new items into the list unexpectedly. (It can't here because this method is const but generally we try to avoid it)

broulik: Avoid `operator[]` which may detach and insert new items into the list unexpectedly. (It can't…
179​}
180​
181​
182​RuleItem *RulesModel::ruleItem(const QString& key) const
183​{
184​ return m_rules.value(key);
185​}
186​
187​QString RulesModel::description() const
188​{
189​ const QString desc = m_rules["description"]->value().toString();
190​ if (!desc.isEmpty()) {
191​ return desc;
192​ }
193​ return defaultDescription();
194​}
195​
196​QString RulesModel::defaultDescription() const
197​{
198​ const QString wmclass = m_rules["wmclass"]->value().toString();
199​ const QString title = m_rules["title"]->isEnabled() ? m_rules["title"]->value().toString() : QString();
200​
201​ if (!title.isEmpty()) {
202​ return i18n("Window settings for %1", title);
203​ }
204​ if (!wmclass.isEmpty()) {
205​ return i18n("Settings for %1", wmclass);
206​ }
207​
208​ return i18n("New window settings");
209​}
210​
211​bool RulesModel::isWarningShown() const
212​{
213​ const bool no_wmclass = !m_rules["wmclass"]->isEnabled()
214​ || m_rules["wmclass"]->policy() == Rules::UnimportantMatch;
215​ const bool alltypes = !m_rules["types"]->isEnabled()
216​ || (m_rules["types"]->value() == 0)
ngrahamUnsubmitted
Done

Maybe "Exact Match" should be the default settting so this message isn't always shown for every new rule you add

ngraham: Maybe "Exact Match" should be the default settting so this message isn't always shown for every…
iasensioAuthorUnsubmitted
Not Done

Agree. I have set it in a simple way for new rules added.

I would like though, to set this directly on the config schema defaults, but for that to work I'll need to modify some bits of the KConfigXT helper classes, which I have planned for a later patch along some other changes to improve integration.

iasensio: Agree. I have set it in a simple way for new rules added. I would like though, to set this…
217​ || (m_rules["types"]->value() == NET::AllTypesMask)
218​ || ((m_rules["types"]->value().toInt() | (1 << NET::Override)) == 0x3FF);
219​
220​ return (no_wmclass && alltypes);
221​}
222​
223​
224​void RulesModel::readFromSettings(RuleSettings *settings)
225​{
226​ beginResetModel();
227​
228​ for (RuleItem *rule : qAsConst(m_ruleList)) {
229​ const KConfigSkeletonItem *configItem = settings->findItem(rule->key());
230​ const KConfigSkeletonItem *configPolicyItem = settings->findItem(rule->policyKey());
231​
232​ if (!configItem
233​ || (configPolicyItem && configPolicyItem->property() == Rules::Unused)
234​ || (configItem->property().toString().isEmpty())) {
235​ rule->reset();
236​ continue;
237​ }
238​
239​ rule->setEnabled(true);
240​
241​ const QVariant value = configItem->property();
242​ rule->setValue(value);
243​
244​ if (rule->policyType() != RulePolicy::NoPolicy) {
245​ const int policy = configPolicyItem->property().toInt();
246​ rule->setPolicy(policy);
247​ }
248​ }
249​
250​ endResetModel();
251​
252​ emit descriptionChanged();
253​ emit showWarningChanged();
254​}
255​
256​void RulesModel::writeToSettings(RuleSettings *settings) const
257​{
258​ const QString description = m_rules["description"]->value().toString();
259​ if (description.isEmpty()) {
260​ m_rules["description"]->setValue(defaultDescription());
261​ }
262​
263​ for (const RuleItem *rule : qAsConst(m_ruleList)) {
264​ KConfigSkeletonItem *configItem = settings->findItem(rule->key());
265​ KConfigSkeletonItem *configPolicyItem = settings->findItem(rule->policyKey());
266​
267​ Q_ASSERT (configItem);
268​
269​ if (rule->isEnabled()) {
270​ configItem->setProperty(rule->value());
271​ if (configPolicyItem) {
272​ configPolicyItem->setProperty(rule->policy());
273​ }
274​ } else {
275​ if (configPolicyItem) {
276​ configPolicyItem->setProperty(Rules::Unused);
277​ } else {
278​ // Rules without policy gets deactivated by an empty string
279​ configItem->setProperty(QString());
280​ }
281​ }
282​ }
283​}
284​
285​void RulesModel::importFromRules(Rules* rules)
286​{
287​ QTemporaryFile tempFile;
288​ if (!tempFile.open()) {
289​ return;
290​ }
291​ const auto cfg = KSharedConfig::openConfig(tempFile.fileName(), KConfig::SimpleConfig);
292​ RuleSettings *settings = new RuleSettings(cfg, QStringLiteral("tempSettings"));
293​
294​ settings->setDefaults();
295​ if (rules) {
296​ rules->write(settings);
297​ }
298​ readFromSettings(settings);
299​
300​ delete(settings);
301​}
302​
303​Rules *RulesModel::exportToRules() const
304​{
305​ QTemporaryFile tempFile;
306​ if (!tempFile.open()) {
307​ return nullptr;
308​ }
309​ const auto cfg = KSharedConfig::openConfig(tempFile.fileName(), KConfig::SimpleConfig);
310​
311​ RuleSettings *settings = new RuleSettings(cfg, QStringLiteral("tempSettings"));
312​
313​ writeToSettings(settings);
314​ Rules *rules = new Rules(settings);
315​
316​ delete(settings);
317​ return rules;
broulikUnsubmitted
Done

qDeleteAll(m_ruleList) before so you don't leak those rules?

broulik: `qDeleteAll(m_ruleList)` before so you don't leak those rules?
318​}
319​
320​
321​void RulesModel::populateRuleList()
322​{
323​ qDeleteAll(m_ruleList);
324​ m_ruleList.clear();
broulikUnsubmitted
Done

Just use the return value of addRule instead of looking it up in the dict again

broulik: Just use the return value of `addRule` instead of looking it up in the dict again
325​
326​ //Rule description
327​ addRule(new RuleItem(QLatin1String("description"),
328​ RulePolicy::NoPolicy, RuleItem::String,
329​ i18n("Description"), i18n("Window matching"),
330​ QStringLiteral("entry-edit")));
331​ m_rules["description"]->setFlags(RuleItem::AlwaysEnabled | RuleItem::AffectsDescription);
332​
333​ // Window matching
334​ addRule(new RuleItem(QLatin1String("wmclass"),
335​ RulePolicy::StringMatch, RuleItem::String,
336​ i18n("Window class (application)"), i18n("Window matching"),
337​ QStringLiteral("window")));
338​ m_rules["wmclass"]->setFlags(RuleItem::AlwaysEnabled | RuleItem::AffectsWarning | RuleItem::AffectsDescription);
339​
340​ addRule(new RuleItem(QLatin1String("wmclasscomplete"),
341​ RulePolicy::NoPolicy, RuleItem::Boolean,
342​ i18n("Match whole window class"), i18n("Window matching"),
343​ QStringLiteral("window")));
344​ m_rules["wmclasscomplete"]->setFlags(RuleItem::AlwaysEnabled);
345​
346​ addRule(new RuleItem(QLatin1String("types"),
347​ RulePolicy::NoPolicy, RuleItem::FlagsOption,
348​ i18n("Window types"), i18n("Window matching"),
349​ QStringLiteral("window-duplicate"),
350​ windowTypesModelData()));
351​ m_rules["types"]->setFlags(RuleItem::AlwaysEnabled | RuleItem::AffectsWarning );
352​
353​ addRule(new RuleItem(QLatin1String("windowrole"),
354​ RulePolicy::NoPolicy, RuleItem::String,
355​ i18n("Window role"), i18n("Window matching"),
356​ QStringLiteral("dialog-object-properties")));
357​
358​ addRule(new RuleItem(QLatin1String("title"),
359​ RulePolicy::StringMatch, RuleItem::String,
360​ i18n("Window title"), i18n("Window matching"),
361​ QStringLiteral("edit-comment")));
362​ m_rules["title"]->setFlags(RuleItem::AffectsDescription);
363​
364​ addRule(new RuleItem(QLatin1String("clientmachine"),
365​ RulePolicy::StringMatch, RuleItem::String,
366​ i18n("Machine (hostname)"), i18n("Window matching"),
367​ QStringLiteral("computer")));
368​
369​ // Size & Position
370​ addRule(new RuleItem(QLatin1String("position"),
371​ RulePolicy::SetRule, RuleItem::Coordinate,
372​ i18n("Position"), i18n("Size & Position"),
373​ QStringLiteral("transform-move")));
374​
375​ addRule(new RuleItem(QLatin1String("size"),
376​ RulePolicy::SetRule, RuleItem::Coordinate,
377​ i18n("Size"), i18n("Size & Position"),
378​ QStringLiteral("image-resize-symbolic")));
379​
380​ addRule(new RuleItem(QLatin1String("maximizehoriz"),
381​ RulePolicy::SetRule, RuleItem::Boolean,
382​ i18n("Maximized horizontally"), i18n("Size & Position"),
383​ QStringLiteral("resizecol")));
384​
385​ addRule(new RuleItem(QLatin1String("maximizevert"),
386​ RulePolicy::SetRule, RuleItem::Boolean,
387​ i18n("Maximized vertically"), i18n("Size & Position"),
388​ QStringLiteral("resizerow")));
389​
390​ addRule(new RuleItem(QLatin1String("desktop"),
391​ RulePolicy::SetRule, RuleItem::Option,
392​ i18n("Virtual Desktop"), i18n("Size & Position"),
393​ QStringLiteral("virtual-desktops"),
394​ virtualDesktopsModelData()));
395​
396​#ifdef KWIN_BUILD_ACTIVITIES
397​ m_activities = new KActivities::Consumer(this);
398​
399​ addRule(new RuleItem(QLatin1String("activity"),
400​ RulePolicy::SetRule, RuleItem::Option,
401​ i18n("Activity"), i18n("Size & Position"),
402​ QStringLiteral("activities"),
403​ activitiesModelData()));
404​
405​ // Activites consumer may update the available activities later
406​ connect(m_activities, &KActivities::Consumer::activitiesChanged,
407​ this, [this] { m_rules["activity"]->setOptionsData(activitiesModelData()); });
408​ connect(m_activities, &KActivities::Consumer::serviceStatusChanged,
409​ this, [this] { m_rules["activity"]->setOptionsData(activitiesModelData()); });
410​
411​#endif
412​
413​ addRule(new RuleItem(QLatin1String("screen"),
414​ RulePolicy::SetRule, RuleItem::Integer,
415​ i18n("Screen"), i18n("Size & Position"),
416​ QStringLiteral("osd-shutd-screen")));
417​
418​ addRule(new RuleItem(QLatin1String("fullscreen"),
419​ RulePolicy::SetRule, RuleItem::Boolean,
420​ i18n("Fullscreen"), i18n("Size & Position"),
421​ QStringLiteral("view-fullscreen")));
422​
423​ addRule(new RuleItem(QLatin1String("minimize"),
424​ RulePolicy::SetRule, RuleItem::Boolean,
425​ i18n("Minimized"), i18n("Size & Position"),
426​ QStringLiteral("window-minimize")));
427​
428​ addRule(new RuleItem(QLatin1String("shade"),
429​ RulePolicy::SetRule, RuleItem::Boolean,
430​ i18n("Shaded"), i18n("Size & Position"),
431​ QStringLiteral("window-shade")));
432​
433​ addRule(new RuleItem(QLatin1String("placement"),
434​ RulePolicy::ForceRule, RuleItem::Option,
435​ i18n("Initial placement"), i18n("Size & Position"),
436​ QStringLiteral("region"),
437​ placementModelData()));
438​
439​ addRule(new RuleItem(QLatin1String("ignoregeometry"),
440​ RulePolicy::SetRule, RuleItem::Boolean,
441​ i18n("Ignore requested geometry"), i18n("Size & Position"),
442​ QStringLiteral("view-time-schedule-baselined-remove")));
443​ m_rules["ignoregeometry"]->setDescription(i18n("Windows can ask to appear in a certain position.\n"
444​ "By default this overrides the placement strategy\n"
445​ "what might be nasty if the client abuses the feature\n"
446​ "to unconditionally popup in the middle of your screen."));
447​
448​ addRule(new RuleItem(QLatin1String("minsize"),
449​ RulePolicy::ForceRule, RuleItem::Coordinate,
450​ i18n("Minimum Size"), i18n("Size & Position"),
451​ QStringLiteral("image-resize-symbolic")));
452​
453​ addRule(new RuleItem(QLatin1String("maxsize"),
454​ RulePolicy::ForceRule, RuleItem::Coordinate,
455​ i18n("Maximum Size"), i18n("Size & Position"),
456​ QStringLiteral("image-resize-symbolic")));
457​
458​ addRule(new RuleItem(QLatin1String("strictgeometry"),
459​ RulePolicy::ForceRule, RuleItem::Boolean,
460​ i18n("Obey geometry restrictions"), i18n("Size & Position"),
461​ QStringLiteral("transform-crop-and-resize")));
462​ m_rules["strictgeometry"]->setDescription(i18n("Eg. terminals or video players can ask to keep a certain aspect ratio\n"
463​ "or only grow by values larger than one\n"
464​ "(eg. by the dimensions of one character).\n"
465​ "This may be pointless and the restriction prevents arbitrary dimensions\n"
466​ "like your complete screen area."));
467​
468​ // Arrangement & Access
469​ addRule(new RuleItem(QLatin1String("above"),
470​ RulePolicy::SetRule, RuleItem::Boolean,
471​ i18n("Keep above"), i18n("Arrangement & Access"),
472​ QStringLiteral("window-keep-above")));
473​
474​ addRule(new RuleItem(QLatin1String("below"),
475​ RulePolicy::SetRule, RuleItem::Boolean,
476​ i18n("Keep below"), i18n("Arrangement & Access"),
477​ QStringLiteral("window-keep-below")));
478​
479​ addRule(new RuleItem(QLatin1String("skiptaskbar"),
480​ RulePolicy::SetRule, RuleItem::Boolean,
481​ i18n("Skip taskbar"), i18n("Arrangement & Access"),
482​ QStringLiteral("kt-show-statusbar")));
483​ m_rules["skiptaskbar"]->setDescription(i18n("Window shall (not) appear in the taskbar."));
484​
485​ addRule(new RuleItem(QLatin1String("skippager"),
486​ RulePolicy::SetRule, RuleItem::Boolean,
487​ i18n("Skip pager"), i18n("Arrangement & Access"),
488​ QStringLiteral("org.kde.plasma.pager")));
489​ m_rules["skippager"]->setDescription(i18n("Window shall (not) appear in the manager for virtual desktops"));
490​
491​ addRule(new RuleItem(QLatin1String("skipswitcher"),
492​ RulePolicy::SetRule, RuleItem::Boolean,
493​ i18n("Skip switcher"), i18n("Arrangement & Access"),
494​ QStringLiteral("preferences-system-windows-effect-flipswitch")));
495​ m_rules["skipswitcher"]->setDescription(i18n("Window shall (not) appear in the Alt+Tab list"));
496​
497​ addRule(new RuleItem(QLatin1String("shortcut"),
498​ RulePolicy::SetRule, RuleItem::Shortcut,
499​ i18n("Shortcut"), i18n("Arrangement & Access"),
500​ QStringLiteral("configure-shortcuts")));
501​
502​ // Appearance & Fixes
503​ addRule(new RuleItem(QLatin1String("noborder"),
504​ RulePolicy::SetRule, RuleItem::Boolean,
505​ i18n("No titlebar and frame"), i18n("Appearance & Fixes"),
506​ QStringLiteral("dialog-cancel")));
507​
508​ addRule(new RuleItem(QLatin1String("decocolor"),
509​ RulePolicy::ForceRule, RuleItem::Option,
510​ i18n("Titlebar color scheme"), i18n("Appearance & Fixes"),
511​ QStringLiteral("preferences-desktop-theme"),
512​ colorSchemesModelData()));
513​
514​ addRule(new RuleItem(QLatin1String("opacityactive"),
515​ RulePolicy::ForceRule, RuleItem::Percentage,
516​ i18n("Active opacity"), i18n("Appearance & Fixes"),
517​ QStringLiteral("edit-opacity")));
518​
519​ addRule(new RuleItem(QLatin1String("opacityinactive"),
520​ RulePolicy::ForceRule, RuleItem::Percentage,
521​ i18n("Inactive opacity"), i18n("Appearance & Fixes"),
522​ QStringLiteral("edit-opacity")));
523​
524​ addRule(new RuleItem(QLatin1String("fsplevel"),
525​ RulePolicy::ForceRule, RuleItem::Option,
526​ i18n("Focus stealing prevention"), i18n("Appearance & Fixes"),
527​ QStringLiteral("preferences-system-windows-effect-glide"),
528​ focusModelData()));
529​ m_rules["fsplevel"]->setDescription(i18n("KWin tries to prevent windows from taking the focus\n"
530​ "(\"activate\") while you're working in another window,\n"
531​ "but this may sometimes fail or superact.\n"
532​ "\"None\" will unconditionally allow this window to get the focus while\n"
533​ "\"Extreme\" will completely prevent it from taking the focus."));
534​
535​ addRule(new RuleItem(QLatin1String("fpplevel"),
536​ RulePolicy::ForceRule, RuleItem::Option,
537​ i18n("Focus protection"), i18n("Appearance & Fixes"),
538​ QStringLiteral("preferences-system-windows-effect-minimize"),
539​ focusModelData()));
540​ m_rules["fpplevel"]->setDescription(i18n("This controls the focus protection of the currently active window.\n"
541​ "None will always give the focus away,\n"
542​ "Extreme will keep it.\n"
543​ "Otherwise it's interleaved with the stealing prevention\n"
544​ "assigned to the window that wants the focus."));
545​
546​ addRule(new RuleItem(QLatin1String("acceptfocus"),
547​ RulePolicy::ForceRule, RuleItem::Boolean,
548​ i18n("Accept focus"), i18n("Appearance & Fixes"),
549​ QStringLiteral("preferences-desktop-cursors")));
550​ m_rules["acceptfocus"]->setDescription(i18n("Windows may prevent to get the focus (activate) when being clicked.\n"
551​ "On the other hand you might wish to prevent a window\n"
552​ "from getting focused on a mouse click."));
553​
554​ addRule(new RuleItem(QLatin1String("disableglobalshortcuts"),
555​ RulePolicy::ForceRule, RuleItem::Boolean,
556​ i18n("Ignore global shortcuts"), i18n("Appearance & Fixes"),
557​ QStringLiteral("input-keyboard-virtual-off")));
558​ m_rules["disableglobalshortcuts"]->setDescription(i18n("When used, a window will receive\n"
559​ "all keyboard inputs while it is active, including Alt+Tab etc.\n"
560​ "This is especially interesting for emulators or virtual machines.\n"
561​ "\n"
562​ "Be warned:\n"
563​ "you won't be able to Alt+Tab out of the window\n"
564​ "nor use any other global shortcut (such as Alt+F2 to show KRunner)\n"
565​ "while it's active!"));
566​
567​ addRule(new RuleItem(QLatin1String("closeable"),
568​ RulePolicy::ForceRule, RuleItem::Boolean,
569​ i18n("Closeable"), i18n("Appearance & Fixes"),
570​ QStringLiteral("dialog-close")));
571​
572​ addRule(new RuleItem(QLatin1String("type"),
573​ RulePolicy::ForceRule, RuleItem::Option,
574​ i18n("Set window type"), i18n("Appearance & Fixes"),
575​ QStringLiteral("window-duplicate"),
576​ windowTypesModelData()));
577​
578​ addRule(new RuleItem(QLatin1String("desktopfile"),
579​ RulePolicy::SetRule, RuleItem::String,
580​ i18n("Desktop file name"), i18n("Appearance & Fixes"),
581​ QStringLiteral("application-x-desktop")));
582​
583​ addRule(new RuleItem(QLatin1String("blockcompositing"),
584​ RulePolicy::ForceRule, RuleItem::Boolean,
585​ i18n("Block compositing"), i18n("Appearance & Fixes"),
586​ QStringLiteral("composite-track-on")));
587​}
588​
589​
590​const QHash<QString, QString> RulesModel::x11PropertyHash()
591​{
592​ static const auto propertyToRule = QHash<QString, QString> {
593​ /* The original detection dialog allows to choose depending on "Match complete window class":
594​ * if Match Complete == false: wmclass = "resourceClass"
595​ * if Match Complete == true: wmclass = "resourceName" + " " + "resourceClass"
596​ */
597​ { "resourceName", "wmclass" },
598​ { "caption", "title" },
599​ { "role", "windowrole" },
600​ { "clientMachine", "clientmachine" },
601​ { "x11DesktopNumber", "desktop" },
602​ { "maximizeHorizontal", "maximizehoriz" },
603​ { "maximizeVertical", "maximizevert" },
604​ { "minimized", "minimize" },
605​ { "shaded", "shade" },
606​ { "fullscreen", "fullscreen" },
607​ { "keepAbove", "above" },
608​ { "keepBelow", "below" },
609​ { "noBorder", "noborder" },
610​ { "skipTaskbar", "skiptaskbar" },
611​ { "skipPager", "skippager" },
612​ { "skipSwitcher", "skipswitcher" },
613​ { "type", "type" },
614​ { "desktopFile", "desktopfile" }
615​ };
616​ return propertyToRule;
617​};
618​
619​void RulesModel::prefillProperties(const QVariantMap &info)
620​{
621​ beginResetModel();
622​
623​ // Properties that cannot be directly applied via x11PropertyHash
624​ const QString position = QStringLiteral("%1,%2").arg(info.value("x").toInt())
625​ .arg(info.value("y").toInt());
626​ const QString size = QStringLiteral("%1,%2").arg(info.value("width").toInt())
627​ .arg(info.value("height").toInt());
628​
629​ if (!m_rules["position"]->isEnabled()) {
630​ m_rules["position"]->setValue(position);
631​ }
632​ if (!m_rules["size"]->isEnabled()) {
633​ m_rules["size"]->setValue(size);
634​ }
635​ if (!m_rules["minsize"]->isEnabled()) {
636​ m_rules["minsize"]->setValue(size);
637​ }
638​ if (!m_rules["maxsize"]->isEnabled()) {
639​ m_rules["maxsize"]->setValue(size);
640​ }
641​
642​ NET::WindowType window_type = static_cast<NET::WindowType>(info.value("type", 0).toInt());
643​ if (!m_rules["types"]->isEnabled() || m_rules["types"]->value() == 0) {
644​ if (window_type == NET::Unknown) {
645​ window_type = NET::Normal;
646​ }
647​ m_rules["types"]->setValue(1 << window_type);
648​ }
649​
650​ const auto ruleForProperty = x11PropertyHash();
651​ for (QString &property : info.keys()) {
652​ if (!ruleForProperty.contains(property)) {
653​ continue;
654​ }
655​ const QString ruleKey = ruleForProperty.value(property, QString());
656​ Q_ASSERT(hasRule(ruleKey));
657​
658​ // Only prefill disabled or empty properties
659​ if (!m_rules[ruleKey]->isEnabled() || m_rules[ruleKey]->value().toString().isEmpty()) {
660​ m_rules[ruleKey]->setValue(info.value(property));
661​ }
662​ }
663​
664​ endResetModel();
665​
666​ emit descriptionChanged();
667​ emit showWarningChanged();
668​}
669​
670​
671​QList<OptionsModel::Data> RulesModel::windowTypesModelData() const
672​{
673​ static const auto modelData = QList<OptionsModel::Data> {
674​ //TODO: Find/create better icons
675​ { NET::Normal, i18n("Normal Window") , QIcon::fromTheme("window") },
676​ { NET::Dialog, i18n("Dialog Window") , QIcon::fromTheme("window-duplicate") },
677​ { NET::Utility, i18n("Utility Window") , QIcon::fromTheme("dialog-object-properties") },
678​ { NET::Dock, i18n("Dock (panel)") , QIcon::fromTheme("list-remove") },
679​ { NET::Toolbar, i18n("Toolbar") , QIcon::fromTheme("tools") },
680​ { NET::Menu, i18n("Torn-Off Menu") , QIcon::fromTheme("overflow-menu-left") },
681​ { NET::Splash, i18n("Splash Screen") , QIcon::fromTheme("embosstool") },
682​ { NET::Desktop, i18n("Desktop") , QIcon::fromTheme("desktop") },
683​ // { NET::Override, i18n("Unmanaged Window") }, deprecated
684​ { NET::TopMenu, i18n("Standalone Menubar"), QIcon::fromTheme("open-menu-symbolic") }
685​ };
686​ return modelData;
687​}
688​
689​QList<OptionsModel::Data> RulesModel::virtualDesktopsModelData() const
690​{
691​ QList<OptionsModel::Data> modelData;
692​ for (int desktopId = 1; desktopId <= KWindowSystem::numberOfDesktops(); ++desktopId) {
693​ modelData << OptionsModel::Data{
694​ desktopId,
695​ QString::number(desktopId).rightJustified(2) + QStringLiteral(": ") + KWindowSystem::desktopName(desktopId),
696​ QIcon::fromTheme("virtual-desktops")
697​ };
698​ }
699​ modelData << OptionsModel::Data{ NET::OnAllDesktops, i18n("All Desktops"), QIcon::fromTheme("window-pin") };
700​ return modelData;
701​}
702​
703​
704​QList<OptionsModel::Data> RulesModel::activitiesModelData() const
705​{
706​#ifdef KWIN_BUILD_ACTIVITIES
davidedmundsonUnsubmitted
Not Done

This won't work on wayland, we will want to copy whatever we do in the virtual desktop KCM.

I think this is not regression, as the current code does the same.
At which point I'm happy to merge now and revist it later.

davidedmundson: This won't work on wayland, we will want to copy whatever we do in the virtual desktop KCM. I…
iasensioAuthorUnsubmitted
Not Done

I'll look into it. Thanks!

iasensio: I'll look into it. Thanks!
707​ QList<OptionsModel::Data> modelData;
708​
709​ // NULL_ID from kactivities/src/lib/core/consumer.cpp
710​ modelData << OptionsModel::Data{
711​ QString::fromLatin1("00000000-0000-0000-0000-000000000000"),
712​ i18n("All Activities"),
713​ QIcon::fromTheme("activities")
714​ };
715​
716​ const auto activities = m_activities->activities(KActivities::Info::Running);
717​ if (m_activities->serviceStatus() == KActivities::Consumer::Running) {
718​ for (const QString &activityId : activities) {
719​ const KActivities::Info info(activityId);
720​ modelData << OptionsModel::Data{ activityId, info.name(), QIcon::fromTheme(info.icon()) };
721​ }
722​ }
723​
724​ return modelData;
725​#else
726​ return {};
727​#endif
728​}
729​
730​QList<OptionsModel::Data> RulesModel::placementModelData() const
731​{
732​ // From "placement.h" : Placement rule is stored as a string, not the enum value
733​ static const auto modelData = QList<OptionsModel::Data> {
734​ { Placement::policyToString(Placement::Default), i18n("Default") },
735​ { Placement::policyToString(Placement::NoPlacement), i18n("No Placement") },
736​ { Placement::policyToString(Placement::Smart), i18n("Minimal Overlapping") },
737​ { Placement::policyToString(Placement::Maximizing), i18n("Maximized") },
738​ { Placement::policyToString(Placement::Cascade), i18n("Cascaded") },
739​ { Placement::policyToString(Placement::Centered), i18n("Centered") },
740​ { Placement::policyToString(Placement::Random), i18n("Random") },
741​ { Placement::policyToString(Placement::ZeroCornered), i18n("In Top-Left Corner") },
742​ { Placement::policyToString(Placement::UnderMouse), i18n("Under Mouse") },
743​ { Placement::policyToString(Placement::OnMainWindow), i18n("On Main Window") }
744​ };
745​ return modelData;
746​}
747​
748​QList<OptionsModel::Data> RulesModel::focusModelData() const
749​{
750​ static const auto modelData = QList<OptionsModel::Data> {
751​ { 0, i18n("None") },
752​ { 1, i18n("Low") },
753​ { 2, i18n("Normal") },
754​ { 3, i18n("High") },
755​ { 4, i18n("Extreme") }
756​ };
757​ return modelData;
758​}
759​
760​QList<OptionsModel::Data> RulesModel::colorSchemesModelData() const
761​{
762​ QList<OptionsModel::Data> modelData;
763​
764​ KColorSchemeManager schemes;
765​ QAbstractItemModel *schemesModel = schemes.model();
766​
767​ // Skip row 0, which is Default scheme
768​ for (int r = 1; r < schemesModel->rowCount(); r++) {
769​ const QModelIndex index = schemesModel->index(r, 0);
770​ modelData << OptionsModel::Data{
771​ QFileInfo(index.data(Qt::UserRole).toString()).baseName(),
772​ index.data(Qt::DisplayRole).toString(),
773​ index.data(Qt::DecorationRole).value<QIcon>()
774​ };
broulikUnsubmitted
Done

There's now a KSortFilterProxyModel in KItemModels you can use from QML for simple filtering like this. Just a suggestion.

broulik: There's now a `KSortFilterProxyModel` in `KItemModels` you can use from QML for simple…
iasensioAuthorUnsubmitted
Done

That seems very handy. I've been trying to, but apparently there is no way to invalidateFilter() from the QML side, to add the showAll condition.
Maybe can it be extended on KItemModels?

iasensio: That seems very handy. I've been trying to, but apparently there is no way to `invalidateFilter…
775​ }
776​
broulikUnsubmitted
Done

I probably would have stored the search string in a member and done the filtering fully custom here rather than relying on filterFixedString

broulik: I probably would have stored the search string in a member and done the filtering fully custom…
iasensioAuthorUnsubmitted
Done

Added fully custom search, to include name and value properties

iasensio: Added fully custom search, to include `name` and `value` properties
777​ return modelData;
778​}
779​
780​
781​bool RulesFilterModel::filterAcceptsRow(int source_row, const QModelIndex &source_parent) const
782​{
783​ if (m_isSearching) {
784​ return QSortFilterProxyModel::filterAcceptsRow(source_row, source_parent);
broulikUnsubmitted
Done

You can also do QModelIndex::data()

broulik: You can also do `QModelIndex::data()`
785​ }
786​ if (m_showAll) {
787​ return true;
788​ }
789​
790​ return sourceModel()->index(source_row, 0).data(RulesModel::EnabledRole).toBool();
791​}
792​
793​void RulesFilterModel::setSearchText(const QString &text)
794​{
795​ const QString searchText = text.trimmed();
796​ m_isSearching = !searchText.isEmpty();
797​ setFilterFixedString(searchText);
798​}
799​
800​bool RulesFilterModel::showAll() const
801​{
broulikUnsubmitted
Done

Generally we check if a property has actually changed before emitting a change:

if (m_showAll == showAll) {
    return;
}
...
broulik: Generally we check if a property has actually changed before emitting a change: ``` if…
802​ return m_showAll;
803​}
804​
805​void RulesFilterModel::setShowAll(bool showAll)
806​{
807​ if (m_showAll == showAll) {
808​ return;
809​ }
810​
811​ m_showAll = showAll;
812​ invalidateFilter();
813​ emit showAllChanged();
814​}
815​
816​
817​void RulesModel::detectWindowProperties(int secs)
818​{
819​ QTimer::singleShot(secs*1000, this, &RulesModel::selectX11Window);
820​}
821​
822​void RulesModel::selectX11Window()
823​{
824​ QDBusMessage message = QDBusMessage::createMethodCall(QStringLiteral("org.kde.KWin"),
825​ QStringLiteral("/KWin"),
826​ QStringLiteral("org.kde.KWin"),
827​ QStringLiteral("queryWindowInfo"));
828​
829​ QDBusPendingReply<QVariantMap> async = QDBusConnection::sessionBus().asyncCall(message);
830​
831​ QDBusPendingCallWatcher *callWatcher = new QDBusPendingCallWatcher(async, this);
832​ connect(callWatcher, &QDBusPendingCallWatcher::finished, this,
833​ [this](QDBusPendingCallWatcher *self) {
834​ QDBusPendingReply<QVariantMap> reply = *self;
835​ self->deleteLater();
836​ if (!reply.isValid()) {
837​ return;
838​ }
839​ const QVariantMap windowInfo = reply.value();
840​ //TODO: Improve UI to suggest/select the detected properties.
841​ // For now, just prefill unused rules
842​ prefillProperties(windowInfo);
843​ }
844​ );
845​}
846​
847​} //namespace