Differential D1722 Diff 4228 libtaskmanager/abstracttasksmodel.h

Changeset View

Standalone View

libtaskmanager/abstracttasksmodel.h

This file was added.

1		/********************************************************************
2		Copyright 2016 Eike Hein <hein.org>
3
4		This library is free software; you can redistribute it and/or
5		modify it under the terms of the GNU Lesser General Public
6		License as published by the Free Software Foundation; either
7		version 2.1 of the License, or (at your option) version 3, or any
8		later version accepted by the membership of KDE e.V. (or its
9		successor approved by the membership of KDE e.V.), which shall
10		act as a proxy defined in Section 6 of version 3 of the license.
11
12		This library 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 GNU
15		Lesser General Public License for more details.
16
17		You should have received a copy of the GNU Lesser General Public
18		License along with this library. If not, see <http://www.gnu.org/licenses/>.
19		*********************************************************************/
20
21		#ifndef ABSTRACTTASKSMODEL_H
22		#define ABSTRACTTASKSMODEL_H
23
24		#include "abstracttasksmodeliface.h"
25
26		#include <QAbstractListModel>
27
28		#include "taskmanager_export.h"
29
30		namespace TaskManager
31		{
32
33		/**
34		* @short An abstract base class for (flat) tasks models.
35		*
36		* This class serves as abstract base class for flat tasks model implementations.
37		* It provides data roles and no-op default implementations of methods in the
38		* AbstractTasksModelIface interface.
39		*
40		* @author Eike Hein <hein@kde.org>
41		**/
42
43		class TASKMANAGER_EXPORT AbstractTasksModel : public QAbstractListModel,
44		public AbstractTasksModelIface
45		{
46		Q_OBJECT
47
48		Q_ENUMS(AdditionalRoles)
49
50		public:
51		enum AdditionalRoles {
52		AppId = Qt::UserRole + 1, /*< KService storage id (.desktop name sans extension). /
53		AppName, /*< Application name. /
54		GenericName, /*< Generic application name. /
55		LauncherUrl, /*< URL that can be used to launch this application (.desktop or executable). /
56		LegacyWinIdList, /*< X11 window ids. Stopgap until we have something better. /
57		MimeType, /*< MIME type for this task (window, window group), needed for DND. /
58		MimeData, /*< Data for MimeType. /
59		IsWindow, /*< This is a window task. /
60		IsStartup, /*< This is a startup task. /
61		IsLauncher, /*< This is a launcher task. /
62		IsGroupParent, /*< This is a parent item for a group of child tasks. /
63		IsGroupable, /*< Whether this task is being ignored by grouping or not. /
64		IsActive, /*< This is the currently active task. /
	broulikUnsubmitted Done I don't fully get that, can you clarify whether this means: A task that "can be grouped" (judging from the enum value name) A task that "is currently grouped" (judging from the comment) broulik: I don't fully get that, can you clarify whether this means: * A task that "can be grouped"…
	heinAuthorUnsubmitted Not Done It means what the comment says: If it's true, the task is not subject to grouping. That means it will never be grouped. It's used by the applet's Don't allow/Allow This Program To Be Grouped action. hein: It means what the comment says: If it's true, the task is not subject to grouping. That means…
	heinAuthorUnsubmitted Not Done I improved the comment. hein: I improved the comment.
65		IsClosable, /*< requestClose (see below) available. /
66		IsMovable, /*< requestMove (see below) available. /
67		IsResizable, /*< requestResize (see below) available. /
68		IsMaximizable, /*< requestToggleMaximize (see below) available. /
69		IsMaximized, /*< Task (i.e. window) is maximized. /
70		IsMinimizable, /*< requestToggleMinimize (see below) available. /
71		IsMinimized, /*< Task (i.e. window) is minimized. /
72		IsKeepAbove, /*< Task (i.e. window) is keep-above. /
73		IsKeepBelow, /*< Task (i.e. window) is keep-below. /
74		IsFullScreenable, /*< requestToggleFullScreen (see below) available. /
75		IsFullScreen, /*< Task (i.e. window) is fullscreen. /
76		IsShadeable, /*< requestToggleShade (see below) available. /
	broulikUnsubmitted Done Qt uses FullScreen capitalization usually. broulik: Qt uses FullScreen capitalization usually.
	heinAuthorUnsubmitted Not Done Changed. hein: Changed.
77		IsShaded, /*< Task (i.e. window) is shaded. /
78		IsVirtualDesktopChangeable, /*< requestVirtualDesktop (see below) available. /
79		VirtualDesktop, /*< Virtual desktop for the task (i.e. window). /
80		IsOnAllVirtualDesktops, /*< Task is on all virtual desktops. /
81		Screen, /*< Screen for the task (i.e. window). /
82		Activities, /*< Activities for the task (i.e. window). /
83		IsDemandingAttention, /*< Task is demanding attention. /
84		SkipTaskbar /*< Task desires not to be shown in a user interface. /
85		};
86
87		explicit AbstractTasksModel(QObject *parent = nullptr);
88		virtual ~AbstractTasksModel();
	broulikUnsubmitted Done nullptr broulik: nullptr
	heinAuthorUnsubmitted Not Done Done. hein: Done.
89
90		QHash<int, QByteArray> roleNames() const override;
91
	broulikUnsubmitted Done override instead of virtual broulik: override instead of virtual
	heinAuthorUnsubmitted Not Done Done. hein: Done.
92		virtual QModelIndex index(int row, int column = 0, const QModelIndex &parent = QModelIndex()) const;
93
	graesslinUnsubmitted Not Done This looks weird. There is a virtual method QAbstractItemModel::index which has column not optional. So you are maybe hiding a virtual method. I suggest to use override here and make column not optional. graesslin: This looks weird. There is a virtual method QAbstractItemModel::index which has column not…
94		/**
95		* Request activation of the task at the given index. Derived classes are
96		* free to interpret the meaning of "activate" themselves depending on
97		* the nature and state of the task, e.g. launch or raise a window task.
98		*
99		* This base implementation does nothing.
100		*
101		* @param index An index in this tasks model.
102		**/
103		virtual void requestActivate(const QModelIndex &index);
	graesslinUnsubmitted Not Done why copy all the documentation? It's already documented in AbstractTasksModelIface. That yells like "will diverge" to me ;-) graesslin: why copy all the documentation? It's already documented in AbstractTasksModelIface. That yells…
104
	graesslinUnsubmitted Not Done please use override for these methods as well. They are defined in AbstractTasksModelIface after all. graesslin: please use override for these methods as well. They are defined in AbstractTasksModelIface…
105		/**
106		* Request an additional instance of the application backing the task
107		* at the given index.
108		*
109		* This base implementation does nothing.
110		*
111		* @param index An index in this tasks model.
112		**/
113		virtual void requestNewInstance(const QModelIndex &index);
114
115		/**
116		* Request the task at the given index be closed.
117		*
118		* This base implementation does nothing.
119		*
120		* @param index An index in this tasks model.
121		**/
122		virtual void requestClose(const QModelIndex &index);
123
124		/**
125		* Request starting an interactive move for the task at the given index.
126		*
127		* This is meant for tasks that have an associated window, and may be
128		* a no-op when there is no window.
129		*
130		* This base implementation does nothing.
131		*
132		* @param index An index in this tasks model.
133		**/
134		virtual void requestMove(const QModelIndex &index);
135
136		/**
137		* Request starting an interactive resize for the task at the given index.
138		*
139		* This is meant for tasks that have an associated window, and may be a
140		* no-op when there is no window.
141		*
142		* This base implementation does nothing.
143		*
144		* @param index An index in this tasks model.
145		**/
146		virtual void requestResize(const QModelIndex &index);
147
148		/**
149		* Request toggling the minimized state of the task at the given index.
150		*
151		* This is meant for tasks that have an associated window, and may be
152		* a no-op when there is no window.
153		*
154		* This base implementation does nothing.
155		*
156		* @param index An index in this tasks model.
157		**/
158		virtual void requestToggleMinimized(const QModelIndex &index);
159
160		/**
161		* Request toggling the maximized state of the task at the given index.
162		*
163		* This is meant for tasks that have an associated window, and may be
164		* a no-op when there is no window.
165		*
166		* This base implementation does nothing.
167		*
168		* @param index An index in this tasks model.
169		**/
170		virtual void requestToggleMaximized(const QModelIndex &index);
171
172		/**
173		* Request toggling the keep-above state of the task at the given index.
174		*
175		* This is meant for tasks that have an associated window, and may be
176		* a no-op when there is no window.
177		*
178		* This base implementation does nothing.
179		*
180		* @param index An index in this tasks model.
181		**/
182		virtual void requestToggleKeepAbove(const QModelIndex &index);
183
184		/**
185		* Request toggling the keep-below state of the task at the given index.
186		*
187		* This is meant for tasks that have an associated window, and may be
188		* a no-op when there is no window.
189		*
190		* This base implementation does nothing.
191		*
192		* @param index An index in this tasks model.
193		**/
194		virtual void requestToggleKeepBelow(const QModelIndex &index);
195
196		/**
197		* Request toggling the fullscreen state of the task at the given index.
198		*
199		* This is meant for tasks that have an associated window, and may be
200		* a no-op when there is no window.
201		*
202		* This base implementation does nothing.
203		*
204		* @param index An index in this tasks model.
205		**/
206		virtual void requestToggleFullScreen(const QModelIndex &index);
207
208		/**
209		* Request toggling the shaded state of the task at the given index.
210		*
211		* This is meant for tasks that have an associated window, and may be
212		* a no-op when there is no window.
213		*
214		* This base implementation does nothing.
215		*
216		* @param index An index in this tasks model.
217		**/
218		virtual void requestToggleShaded(const QModelIndex &index);
219
220		/**
221		* Request moving the task at the given index to the specified virtual
222		* desktop.
223		*
224		* This is meant for tasks that have an associated window, and may be
225		* a no-op when there is no window.
226		*
227		* This base implementation does nothing.
228		*
229		* @param index An index in this tasks model.
230		* @param desktop A virtual desktop number.
231		**/
232		virtual void requestVirtualDesktop(const QModelIndex &index, qint32 desktop);
233
234		/**
235		* Request informing the window manager of new geometry for a visual
236		* delegate for the task at the given index. The geometry should be in
237		* screen coordinates.
238		*
239		* This base implementation does nothing.
240		*
241		* @param index An index in this tasks model.
242		* @param geometry Visual delegate geometry in screen coordinates.
243		* @param delegate The delegate. Implementations are on their own with
244		* regard to extracting information from this, and should take care to
245		* reject invalid objects.
246		**/
247		virtual void requestPublishDelegateGeometry(const QModelIndex &index, const QRect &geometry,
248		QObject *delegate = nullptr);
249		};
250
251		}
252
253		#endif