yukijoou/kwin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
kwin/src/rulebooksettings.h

50 lines
1.1 KiB
C
Raw Normal View History

Prettify license headers
2020-08-02 22:22:19 +00:00
/*
KWin - the KDE window manager
This file is part of the KDE project.
Port kwinrules kcm to kconfigxt Reviewers: meven, crossi, bport, ervin, #kwin Subscribers: iasensio, ognarb, zzag, kwin Tags: #kwin Differential Revision: https://phabricator.kde.org/D27682
2020-02-18 13:52:08 +00:00
Prettify license headers
2020-08-02 22:22:19 +00:00
SPDX-FileCopyrightText: 2020 Henri Chain <henri.chain@enioka.com>
rulebooksettings: Add accesors to the rules settings list Previously, the only way to access the rules list was via the `rules()` and `setRules()` methods, so the actual settings objects were not accesible. This commit adds methods to retrieve, insert, remove or reorder the rules within the list. Since every individual rule is stored as a KConfig group, and they are not designed to be dynamically renamed, using consecutive numbered groups and store only the total count is problematic. So we also add a new stringlist setting to store the rules group names and their order. Now any group name is valid. To avoid collisions use random QUuids as group names for newly created rules.
2021-03-19 18:43:47 +00:00
SPDX-FileCopyrightText: 2021 Ismael Asensio <isma.af@gmail.com>
Port kwinrules kcm to kconfigxt Reviewers: meven, crossi, bport, ervin, #kwin Subscribers: iasensio, ognarb, zzag, kwin Tags: #kwin Differential Revision: https://phabricator.kde.org/D27682
2020-02-18 13:52:08 +00:00
Prettify license headers
2020-08-02 22:22:19 +00:00
SPDX-License-Identifier: GPL-2.0-or-later
*/
Port kwinrules kcm to kconfigxt Reviewers: meven, crossi, bport, ervin, #kwin Subscribers: iasensio, ognarb, zzag, kwin Tags: #kwin Differential Revision: https://phabricator.kde.org/D27682
2020-02-18 13:52:08 +00:00
port all headers to pragma once
2022-12-16 20:08:44 +00:00
#pragma once
Port kwinrules kcm to kconfigxt Reviewers: meven, crossi, bport, ervin, #kwin Subscribers: iasensio, ognarb, zzag, kwin Tags: #kwin Differential Revision: https://phabricator.kde.org/D27682
2020-02-18 13:52:08 +00:00
#include "rulebooksettingsbase.h"
#include <KSharedConfig>
namespace KWin
{
class Rules;
class RuleSettings;
class RuleBookSettings : public RuleBookSettingsBase
{
public:
RuleBookSettings(KSharedConfig::Ptr config, QObject *parent = nullptr);
RuleBookSettings(QObject *parent = nullptr);
rulebooksettings: Add accesors to the rules settings list Previously, the only way to access the rules list was via the `rules()` and `setRules()` methods, so the actual settings objects were not accesible. This commit adds methods to retrieve, insert, remove or reorder the rules within the list. Since every individual rule is stored as a KConfig group, and they are not designed to be dynamically renamed, using consecutive numbered groups and store only the total count is problematic. So we also add a new stringlist setting to store the rules group names and their order. Now any group name is valid. To avoid collisions use random QUuids as group names for newly created rules.
2021-03-19 18:43:47 +00:00
~RuleBookSettings();
rules/RuleBook: Optimize saving discarded rules to config After porting to KConfigXT settings some time ago, there was still an inefficient and error-prone codepath between the `RuleBook` (which keeps the runtime list of `Rules`) and the `RuleBookSettings` (responsible for config reads and saves), in the form of the `setRules()` method. We can eliminate the `setRules()` codepath, reducing unnecessary runtime process and file access operations, and instead: - Keep track of the config `id` in the `Rules` objects - Keep a single `RuleBookSettings` object as a member - Modify or delete the discarded rules settings directly - Save when necessary This also fixes two bugs/pitfalls of the previous solution: - the config group id for each rule is now preserved instead of creating new ones - no leftovers on the config file for the discarded groups and entries Setting custom configs for the integration tests still works unchanged. BUG: 446381 FIXED-IN: 6.1
2024-05-02 14:36:08 +00:00
QList<Rules *> rules() const;
rulebooksettings: Add accesors to the rules settings list Previously, the only way to access the rules list was via the `rules()` and `setRules()` methods, so the actual settings objects were not accesible. This commit adds methods to retrieve, insert, remove or reorder the rules within the list. Since every individual rule is stored as a KConfig group, and they are not designed to be dynamically renamed, using consecutive numbered groups and store only the total count is problematic. So we also add a new stringlist setting to store the rules group names and their order. Now any group name is valid. To avoid collisions use random QUuids as group names for newly created rules.
2021-03-19 18:43:47 +00:00
Port kwinrules kcm to kconfigxt Reviewers: meven, crossi, bport, ervin, #kwin Subscribers: iasensio, ognarb, zzag, kwin Tags: #kwin Differential Revision: https://phabricator.kde.org/D27682
2020-02-18 13:52:08 +00:00
bool usrSave() override;
void usrRead() override;
rulebooksettings: Add accesors to the rules settings list Previously, the only way to access the rules list was via the `rules()` and `setRules()` methods, so the actual settings objects were not accesible. This commit adds methods to retrieve, insert, remove or reorder the rules within the list. Since every individual rule is stored as a KConfig group, and they are not designed to be dynamically renamed, using consecutive numbered groups and store only the total count is problematic. So we also add a new stringlist setting to store the rules group names and their order. Now any group name is valid. To avoid collisions use random QUuids as group names for newly created rules.
2021-03-19 18:43:47 +00:00
bool usrIsSaveNeeded() const;
int ruleCount() const;
rules/RuleBook: Optimize saving discarded rules to config After porting to KConfigXT settings some time ago, there was still an inefficient and error-prone codepath between the `RuleBook` (which keeps the runtime list of `Rules`) and the `RuleBookSettings` (responsible for config reads and saves), in the form of the `setRules()` method. We can eliminate the `setRules()` codepath, reducing unnecessary runtime process and file access operations, and instead: - Keep track of the config `id` in the `Rules` objects - Keep a single `RuleBookSettings` object as a member - Modify or delete the discarded rules settings directly - Save when necessary This also fixes two bugs/pitfalls of the previous solution: - the config group id for each rule is now preserved instead of creating new ones - no leftovers on the config file for the discarded groups and entries Setting custom configs for the integration tests still works unchanged. BUG: 446381 FIXED-IN: 6.1
2024-05-02 14:36:08 +00:00
std::optional<int> indexForId(const QString &id) const;
rulebooksettings: Add accesors to the rules settings list Previously, the only way to access the rules list was via the `rules()` and `setRules()` methods, so the actual settings objects were not accesible. This commit adds methods to retrieve, insert, remove or reorder the rules within the list. Since every individual rule is stored as a KConfig group, and they are not designed to be dynamically renamed, using consecutive numbered groups and store only the total count is problematic. So we also add a new stringlist setting to store the rules group names and their order. Now any group name is valid. To avoid collisions use random QUuids as group names for newly created rules.
2021-03-19 18:43:47 +00:00
RuleSettings *ruleSettingsAt(int row) const;
RuleSettings *insertRuleSettingsAt(int row);
void removeRuleSettingsAt(int row);
void moveRuleSettings(int srcRow, int destRow);
private:
static QString generateGroupName();
Port kwinrules kcm to kconfigxt Reviewers: meven, crossi, bport, ervin, #kwin Subscribers: iasensio, ognarb, zzag, kwin Tags: #kwin Differential Revision: https://phabricator.kde.org/D27682
2020-02-18 13:52:08 +00:00
private:
There's no QVector anymore, QList is the QVector in Qt6
2023-10-19 06:50:15 +00:00
QList<RuleSettings *> m_list;
rulebooksettings: Add accesors to the rules settings list Previously, the only way to access the rules list was via the `rules()` and `setRules()` methods, so the actual settings objects were not accesible. This commit adds methods to retrieve, insert, remove or reorder the rules within the list. Since every individual rule is stored as a KConfig group, and they are not designed to be dynamically renamed, using consecutive numbered groups and store only the total count is problematic. So we also add a new stringlist setting to store the rules group names and their order. Now any group name is valid. To avoid collisions use random QUuids as group names for newly created rules.
2021-03-19 18:43:47 +00:00
QStringList m_storedGroups;
Port kwinrules kcm to kconfigxt Reviewers: meven, crossi, bport, ervin, #kwin Subscribers: iasensio, ognarb, zzag, kwin Tags: #kwin Differential Revision: https://phabricator.kde.org/D27682
2020-02-18 13:52:08 +00:00
};
}
Reference in a new issue Copy permalink