Differential D27509 Diff 78346 processcore/process_data_model.h

Changeset View

Standalone View

processcore/process_data_model.h

This file was added.

1		/*
2		Copyright (c) 2020 David Edmundson <davidedmundson@kde.org>
3
4		This library is free software; you can redistribute it and/or
5		modify it under the terms of the GNU Library General Public
6		License as published by the Free Software Foundation; either
7		version 2 of the License, or (at your option) any later version.
8
9		This library is distributed in the hope that it will be useful,
10		but WITHOUT ANY WARRANTY; without even the implied warranty of
11		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12		Library General Public License for more details.
13
14		You should have received a copy of the GNU Library General Public License
15		along with this library; see the file COPYING.LIB. If not, write to
16		the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17		Boston, MA 02110-1301, USA.
18		*/
19
20		#pragma once
21
22		#include <QAbstractItemModel>
23		#include <processcore/processes.h>
24
25		namespace KSysGuard
26		{
27
28		class Process;
29		class ProcessAttributeModel;
30
31		/**
32		* This class contains a model of all running processes
33		* Rows represent processes
34		* Columns represent a specific attribute, such as CPU usage
	broulikUnsubmitted Done Remove second "contains" broulik: Remove second "contains"
35		* Attributes can be enabled or disabled
36		*
37		* This class abstracts the process data so that it can be presented without the client
38		* needing to understand the semantics of each column
39		* It is designed to be consumable by a QML API
40		*/
41		class Q_DECL_EXPORT ProcessDataModel : public QAbstractItemModel
42		{
43		Q_OBJECT
44
45		Q_PROPERTY(QStringList availableAttributes READ availableAttributes CONSTANT)
46		Q_PROPERTY(QStringList enabledAttributes READ enabledAttributes WRITE setEnabledAttributes NOTIFY enabledAttributesChanged)
47		Q_PROPERTY(QAbstractItemModel *attributesModel READ attributesModel CONSTANT)
48
49		public:
	broulikUnsubmitted Done would it hurt to make this a `QAbstractItemModel `? broulik:* would it hurt to make this a `QAbstractItemModel *`?
50		enum AdditionalRoles {
51		Value = Qt::UserRole, /// The raw value of the attribute. This is unformatted and could represent an int, real or string
52		FormattedValue, /// A string containing the value in a locale friendly way with appropriate suffix "eg. 5Mb" "20%"
53
54		PIDs, /// The PIDs associated with this row
	broulikUnsubmitted Done should this just be `Qt::DisplayRole` given you return for both in `data`? broulik: should this just be `Qt::DisplayRole` given you return for both in `data`?
	davidedmundsonAuthorUnsubmitted Done It breaks our roleNames as you can't have two names for the same value. Then on the QML side we can't interchange with display and formattedValue. which is what we were trying to achieve davidedmundson: It breaks our roleNames as you can't have two names for the same value. Then on the QML side…
55		Minimum, /// Smallest value this reading can be in normal situations. A hint for graphing utilities
56		Maximum, /// Largest value this reading can be in normal situations. A hint for graphing utilities
57
58		Attribute, /// The attribute id associated with this column
59		Name, /// The full name of this attribute
60		ShortName, /// A shorter name of this attribute, compressed for viewing
61		Unit, /// The unit associated with this attribute. Returned value is of the type KSysGuard::Unit
62		};
63		Q_ENUM(AdditionalRoles)
64
65		explicit ProcessDataModel(QObject *parent = nullptr);
66		~ProcessDataModel() override;
67
	broulikUnsubmitted Done `explicit` broulik: `explicit`
68		/**
69		* A list of attribute IDs that can be enabled
70		*/
71		QStringList availableAttributes() const;
72
73		/**
74		* The list of available attributes that can be enabled, presented as a model
75		* See @availableAttributes
76		*/
77		ProcessAttributeModel *attributesModel();
78
79		/**
80		* The currently enabled attributes
81		*/
82		QStringList enabledAttributes() const;
83		/**
84		* Select which process attributes should be enabled
85		* The order determines the column order
86		*
87		* The default value is empty
88		*/
89		void setEnabledAttributes(const QStringList &enabledAttributes);
90
91		QHash<int, QByteArray> roleNames() const override;
92		QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
93		QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override;
94		int rowCount(const QModelIndex &parent = QModelIndex()) const override;
95		int columnCount(const QModelIndex &parent = QModelIndex()) const override;
96		QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex()) const override;
97		QModelIndex parent(const QModelIndex &index) const override;
98
99		Q_SIGNALS:
100		void enabledAttributesChanged();
101
102		private:
103		class Private;
104		QScopedPointer<Private> d;
105		};
	broulikUnsubmitted Done Why is this not a nested `Private` class like in the extended processes list? broulik: Why is this not a nested `Private` class like in the extended processes list?
106
107		}