Differential D28744 Diff 79907 kcms/keys/shortcutsmodel.h

Changeset View

Standalone View

kcms/keys/shortcutsmodel.h

This file was added.

1		/*
2		* Copyright 2020 David Redondo <kde@david-redondo.de>
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 SHORTCUTSMODEL_H
22		#define SHORTCUTSMODEL_H
23
24		#include <QAbstractItemModel>
25		#include <QKeySequence>
26		#include <QList>
27		#include <QSet>
28		#include <QVector>
29
30		class QDBusError;
31
32		class KConfigBase;
33		class KGlobalAccelInterface;
34
35		class FilteredShortcutsModel;
36
37		struct Shortcut {
38		QString uniqueName;
39		QString friendlyName;
40		QSet<QKeySequence> activeShortcuts;
41		QSet<QKeySequence> defaultShortcuts;
42		QSet<QKeySequence> initialShortcuts;
43		};
44
45		struct Component {
46		QString uniqueName;
47		QString friendlyName;
48		QString type;
49		QString icon;
50		QVector<Shortcut> shortcuts;
51		bool checked;
52		};
53
54		class ShortcutsModel : public QAbstractItemModel {
55		Q_OBJECT
	broulikUnsubmitted Done Coding style, `{` on new line broulik: Coding style, `{` on new line
56
57		public:
58		friend FilteredShortcutsModel;
59		enum Roles {
	broulikUnsubmitted Done It doesnt appear to use any private members? broulik: It doesnt appear to use any private members?
60		SectionRole = Qt::UserRole,
	davidreAuthorUnsubmitted Done It does in filterAcceptRows to not have to go through data each time davidre: It does in filterAcceptRows to not have to go through data each time
	davidreAuthorUnsubmitted Done Nevermind it goes through data, apparently I forgot that I changed that :) davidre: Nevermind it goes through data, apparently I forgot that I changed that :)
61		ComponentRole,
62		ActionRole,
63		ActiveShortcutsRole,
64		DefaultShortcutsRole,
65		CustomShortcutsRole,
66		CheckedRole
67		};
68		Q_ENUM(Roles)
69
70		ShortcutsModel(KGlobalAccelInterface interface, QObject parent = nullptr);
71
72		Q_INVOKABLE void toggleDefaultShortcut(const QModelIndex &index, const QKeySequence &shortcut, bool enabled);
73		Q_INVOKABLE void addShortcut(const QModelIndex &index, const QKeySequence &shortcut);
74		Q_INVOKABLE void disableShortcut(const QModelIndex &index, const QKeySequence &shortcut);
75		Q_INVOKABLE void changeShortcut(const QModelIndex &index, const QKeySequence &oldShortcut, const QKeySequence &newShortcut);
76
77		void setShortcuts(const KConfigBase &config);
78		void addApplication(const QString &desktopFileName, const QString &displayName);
79
80		void load();
81		void defaults();
82		void save();
83		bool needsSave();
84		bool isDefault();
	crossiUnsubmitted Done should be const crossi: should be const
	broulikUnsubmitted Done `const` and below broulik: `const` and below
85
	crossiUnsubmitted Done should be const crossi: should be const
86		QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex()) const override;
87		QModelIndex parent(const QModelIndex &child) const override;
88		int rowCount(const QModelIndex &parent = QModelIndex()) const override;
89		int columnCount(const QModelIndex &parent = QModelIndex()) const override;
90		QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
91		bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole) override;
92		QHash<int, QByteArray> roleNames() const override;
93
94		Q_SIGNALS:
95		void error(QString);
96
	broulikUnsubmitted Done `const QString &`, also perhaps `errorOccurred`? broulik: `const QString &`, also perhaps `errorOccurred`?
97		private:
98		Component loadComponent(const QStringList &componentId);
99		void genericErrorOccured(const QString &description, const QDBusError &error);
100
101		KGlobalAccelInterface *m_globalAccelInterface;
102		QVector<Component> m_components;
103		};
104
105		#endif // SHORTCUTSMODEL_H