Differential D1722 Diff 4228 libtaskmanager/taskfilterproxymodel.h

Changeset View

Standalone View

libtaskmanager/taskfilterproxymodel.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 TASKFILTERPROXYMODEL_H
22		#define TASKFILTERPROXYMODEL_H
23
24		#include <QSortFilterProxyModel>
25
26		#include "abstracttasksmodeliface.h"
27
28		#include "taskmanager_export.h"
29
30		namespace TaskManager
31		{
32
33		/**
34		* @short A proxy tasks model filtering its source model by various properties.
35		*
36		* This proxy model class filters its source tasks model by properties such as
37		* virtual desktop or minimixed state. The values to filter for or by are set
38		* as properties on the proxy model instance.
39		*
40		* @author Eike Hein <hein@kde.org>
41		**/
42
43		class TASKMANAGER_EXPORT TaskFilterProxyModel : public QSortFilterProxyModel, public AbstractTasksModelIface
44		{
45		Q_OBJECT
46
47		Q_PROPERTY(int virtualDesktop READ virtualDesktop WRITE setVirtualDesktop NOTIFY virtualDesktopChanged)
48		Q_PROPERTY(int screen READ screen WRITE setScreen NOTIFY screenChanged)
49		Q_PROPERTY(QString activity READ activity WRITE setActivity NOTIFY activityChanged)
50
51		Q_PROPERTY(bool filterByVirtualDesktop READ filterByVirtualDesktop WRITE setFilterByVirtualDesktop NOTIFY filterByVirtualDesktopChanged)
52		Q_PROPERTY(bool filterByScreen READ filterByScreen WRITE setFilterByScreen NOTIFY filterByScreenChanged)
53		Q_PROPERTY(bool filterByActivity READ filterByActivity WRITE setFilterByActivity NOTIFY filterByActivityChanged)
54		Q_PROPERTY(bool filterNotMinimized READ filterNotMinimized WRITE setFilterNotMinimized NOTIFY filterNotMinimizedChanged)
55
56		public:
57		explicit TaskFilterProxyModel(QObject *parent = 0);
58		virtual ~TaskFilterProxyModel();;
59
60		void setSourceModel(QAbstractItemModel *sourceModel) override;
61
62		/**
63		* The number of the virtual desktop used in filtering by virtual
64		* desktop. Usually set to the number of the current virtual desktop.
65		* Defaults to @c 0 (virtual desktop numbers start at 1).
66		*
67		* @see setVirtualDesktop
68		* @returns the number of the virtual desktop used in filtering.
69		**/
70		uint virtualDesktop() const;
71
72		/**
73		* Set the number of the virtual desktop to use in filtering by virtual
74		* desktop.
75		*
76		* If set to 0 (virtual desktop numbers start at 1), filtering by virtual
77		* desktop is disabled.
78		*
79		* @see virtualDesktop
80		* @param virtualDesktop A virtual desktop number.
81		**/
82		void setVirtualDesktop(uint virtualDesktop);
83
84		/**
85		* The number of the screen used in filtering by screen. Usually
86		* set to the number of the current screen. Defaults to @c -1.
87		*
88		* @see setScreen
89		* @returns the number of the screen used in filtering.
90		**/
91		int screen() const;
92
93		/**
94		* Set the number of the screen to use in filtering by screen.
95		*
96		* If set to @c -1, filtering by screen is disabled.
97		*
98		* @see screen
99		* @param screen A screen number.
100		**/
101		void setScreen(int screen);
102
103		/**
104		* The id of the activity used in filtering by activity. Usually
105		* set to the id of the current activity. Defaults to an empty id.
106		*
107		* @see setActivity
108		* @returns the id of the activity used in filtering.
109		**/
110		QString activity() const;
111
112		/**
113		* Set the id of the activity to use in filtering by activity.
114		*
115		* @see activity
116		* @param activity An activity id.
117		**/
118		void setActivity(const QString &activity);
119
120		/**
121		* Whether tasks should be filtered by virtual desktop. Defaults to
122		* @c false.
123		*
124		* Filtering by virtual desktop only happens if a virtual desktop
125		* number greater than -1 is set, even if this returns @c true.
	broulikUnsubmitted Done ie. greater than -1 broulik: ie. greater than -1
	heinAuthorUnsubmitted Not Done Superceded by David's review, fixed. hein: Superceded by David's review, fixed.
126		*
127		* @see setFilterByVirtualDesktop
128		* @see setVirtualDesktop
129		* @returns @c true if tasks should be filtered by virtual desktop.
130		**/
131		bool filterByVirtualDesktop() const;
132
133		/**
134		* Set whether tasks should be filtered by virtual desktop.
135		*
136		* Filtering by virtual desktop only happens if a virtual desktop
137		* number is set, even if this is set to @c true.
138		*
139		* @see filterByVirtualDesktop
140		* @see setVirtualDesktop
141		* @param filter Whether tasks should be filtered by virtual desktop.
142		**/
143		void setFilterByVirtualDesktop(bool filter);
144
145		/**
146		* Whether tasks should be filtered by screen. Defaults to @c false.
147		*
148		* Filtering by screen only happens if a screen number is set, even
149		* if this returns @c true.
150		*
151		* @see setFilterByScreen
152		* @see setScreen
153		* @returns @c true if tasks should be filtered by screen.
154		**/
155		bool filterByScreen() const;
156
157		/**
158		* Set whether tasks should be filtered by screen.
159		*
160		* Filtering by screen only happens if a screen number is set, even
161		* if this is set to @c true.
162		*
163		* @see filterByScreen
164		* @see setScreen
165		* @param filter Whether tasks should be filtered by screen.
166		**/
167		void setFilterByScreen(bool filter);
168
169		/**
170		* Whether tasks should be filtered by activity. Defaults to @c false.
171		*
172		* Filtering by activity only happens if an activity id is set, even
173		* if this returns @c true.
174		*
175		* @see setFilterByActivity
176		* @see setActivity
177		* @returns @ctrue if tasks should be filtered by activity.
178		**/
179		bool filterByActivity() const;
180
181		/**
182		* Set whether tasks should be filtered by activity. Defaults to
183		* @c false.
184		*
185		* Filtering by virtual desktop only happens if an activity id is set,
186		* even if this is set to @c true.
187		*
188		* @see filterByActivity
189		* @see setActivity
190		* @param filter Whether tasks should be filtered by activity.
191		**/
192		void setFilterByActivity(bool filter);
193
194		/**
195		* Whether non-minimized tasks should be filtered. Defaults to
196		* @c false.
197		*
198		* @see setFilterNotMinimized
199		* @returns @c true if non-minimized tasks should be filtered.
200		**/
201		bool filterNotMinimized() const;
202
203		/**
204		* Set whether non-minimized tasks should be filtered.
205		*
206		* @see filterNotMinimized
207		* @param filter Whether non-minimized tasks should be filtered.
208		**/
209		void setFilterNotMinimized(bool filter);
210
211		/**
212		* Request activation of the task at the given index. Derived classes are
213		* free to interpret the meaning of "activate" themselves depending on
214		* the nature and state of the task, e.g. launch or raise a window task.
215		*
216		* @param index An index in this tasks model.
217		**/
218		void requestActivate(const QModelIndex &index);
219
220		/**
221		* Request an additional instance of the application backing the task
222		* at the given index.
223		*
224		* @param index An index in this tasks model.
225		**/
226		void requestNewInstance(const QModelIndex &index);
227
228		/**
229		* Request the task at the given index be closed.
230		*
231		* @param index An index in this tasks model.
232		**/
233		void requestClose(const QModelIndex &index);
234
235		/**
236		* Request starting an interactive move for the task at the given index.
237		*
238		* This is meant for tasks that have an associated window, and may be
239		* a no-op when there is no window.
240		*
241		* @param index An index in this tasks model.
242		**/
243		void requestMove(const QModelIndex &index);
244
245		/**
246		* Request starting an interactive resize for the task at the given index.
247		*
248		* This is meant for tasks that have an associated window, and may be a
249		* no-op when there is no window.
250		*
251		* @param index An index in this tasks model.
252		**/
253		void requestResize(const QModelIndex &index);
254
255		/**
256		* Request toggling the minimized state of the task at the given index.
257		*
258		* This is meant for tasks that have an associated window, and may be
259		* a no-op when there is no window.
260		*
261		* @param index An index in this tasks model.
262		**/
263		void requestToggleMinimized(const QModelIndex &index);
264
265		/**
266		* Request toggling the maximized state of the task at the given index.
267		*
268		* This is meant for tasks that have an associated window, and may be
269		* a no-op when there is no window.
270		*
271		* @param index An index in this tasks model.
272		**/
273		void requestToggleMaximized(const QModelIndex &index);
274
275		/**
276		* Request toggling the keep-above state of the task at the given index.
277		*
278		* This is meant for tasks that have an associated window, and may be
279		* a no-op when there is no window.
280		*
281		* @param index An index in this tasks model.
282		**/
283		void requestToggleKeepAbove(const QModelIndex &index);
284
285		/**
286		* Request toggling the keep-below state of the task at the given index.
287		*
288		* This is meant for tasks that have an associated window, and may be
289		* a no-op when there is no window.
290		*
291		* @param index An index in this tasks model.
292		**/
293		void requestToggleKeepBelow(const QModelIndex &index);
294
295		/**
296		* Request toggling the fullscreen state of the task at the given index.
297		*
298		* This is meant for tasks that have an associated window, and may be
299		* a no-op when there is no window.
300		*
301		* @param index An index in this tasks model.
302		**/
303		void requestToggleFullScreen(const QModelIndex &index);
304
305		/**
306		* Request toggling the shaded state of the task at the given index.
307		*
308		* This is meant for tasks that have an associated window, and may be
309		* a no-op when there is no window.
310		*
311		* @param index An index in this tasks model.
312		**/
313		void requestToggleShaded(const QModelIndex &index);
314
315		/**
316		* Request moving the task at the given index to the specified virtual
317		* desktop.
318		*
319		* This is meant for tasks that have an associated window, and may be
320		* a no-op when there is no window.
321		*
322		* @param index An index in this tasks model.
323		* @param desktop A virtual desktop number.
324		**/
325		void requestVirtualDesktop(const QModelIndex &index, qint32 desktop);
326
327		/**
328		* Request informing the window manager of new geometry for a visual
329		* delegate for the task at the given index. The geometry should be in
330		* screen coordinates.
331		*
332		* @param index An index in this tasks model.
333		* @param geometry Visual delegate geometry in screen coordinates.
334		* @param delegate The delegate. Implementations are on their own with
335		* regard to extracting information from this, and should take care to
336		* reject invalid objects.
337		**/
338		void requestPublishDelegateGeometry(const QModelIndex &index, const QRect &geometry,
339		QObject *delegate = nullptr);
340
341		Q_SIGNALS:
342		void virtualDesktopChanged() const;
343		void screenChanged() const;
344		void activityChanged() const;
345		void filterByVirtualDesktopChanged() const;
346		void filterByScreenChanged() const;
347		void filterByActivityChanged() const;
348		void filterNotMinimizedChanged() const;
349
350		protected:
351		bool filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const;
352
353		private:
354		class Private;
355		QScopedPointer<Private> d;
356		};
357
358		}
359
360		#endif