Differential D28744 Diff 80672 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 <QDBusPendingCallWatcher>
27		#include <QList>
28		#include <QSet>
29		#include <QVector>
30
31
32		class QDBusError;
33		class QDBusObjectPath;
34
35		class KConfigBase;
36		class KGlobalAccelInterface;
37		class KGlobalShortcutInfo;
38
39		class FilteredShortcutsModel;
40
41		struct Shortcut {
42		QString uniqueName;
43		QString friendlyName;
44		QSet<QKeySequence> activeShortcuts;
45		QSet<QKeySequence> defaultShortcuts;
46		QSet<QKeySequence> initialShortcuts;
47		};
48
49		struct Component {
50		QString uniqueName;
51		QString friendlyName;
52		QString type;
53		QString icon;
54		QVector<Shortcut> shortcuts;
55		bool checked;
	broulikUnsubmitted Done Coding style, `{` on new line broulik: Coding style, `{` on new line
56		};
57
58		class ShortcutsModel : public QAbstractItemModel
59		{
	broulikUnsubmitted Done It doesnt appear to use any private members? broulik: It doesnt appear to use any private members?
60		Q_OBJECT
	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
62		public:
63		enum Roles {
64		SectionRole = Qt::UserRole,
65		ComponentRole,
66		ActionRole,
67		ActiveShortcutsRole,
68		DefaultShortcutsRole,
69		CustomShortcutsRole,
70		CheckedRole
71		};
72		Q_ENUM(Roles)
73
74		ShortcutsModel(KGlobalAccelInterface interface, QObject parent = nullptr);
75
76		Q_INVOKABLE void toggleDefaultShortcut(const QModelIndex &index, const QKeySequence &shortcut, bool enabled);
77		Q_INVOKABLE void addShortcut(const QModelIndex &index, const QKeySequence &shortcut);
78		Q_INVOKABLE void disableShortcut(const QModelIndex &index, const QKeySequence &shortcut);
79		Q_INVOKABLE void changeShortcut(const QModelIndex &index, const QKeySequence &oldShortcut, const QKeySequence &newShortcut);
80
81		void setShortcuts(const KConfigBase &config);
82		void addApplication(const QString &desktopFileName, const QString &displayName);
83		void removeComponent(const QModelIndex &index);
84
	crossiUnsubmitted Done should be const crossi: should be const
	broulikUnsubmitted Done `const` and below broulik: `const` and below
85		void load();
	crossiUnsubmitted Done should be const crossi: should be const
86		void defaults();
87		void save();
88		bool needsSave() const;
89		bool isDefault() const;
90
91		QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex()) const override;
92		QModelIndex parent(const QModelIndex &child) const override;
93		int rowCount(const QModelIndex &parent = QModelIndex()) const override;
94		int columnCount(const QModelIndex &parent = QModelIndex()) const override;
95		QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
96		bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole) override;
	broulikUnsubmitted Done `const QString &`, also perhaps `errorOccurred`? broulik: `const QString &`, also perhaps `errorOccurred`?
97		QHash<int, QByteArray> roleNames() const override;
98
99		Q_SIGNALS:
100		void errorOccured(const QString&);
101
102		private:
103		Component loadComponent(const QList<KGlobalShortcutInfo> &info);
104		void genericErrorOccured(const QString &description, const QDBusError &error);
105
106		KGlobalAccelInterface *m_globalAccelInterface;
107		QVector<Component> m_components;
108		};
109
110		#endif // SHORTCUTSMODEL_H