Differential D1722 Diff 4228 libtaskmanager/abstracttasksmodeliface.h

Changeset View

Standalone View

libtaskmanager/abstracttasksmodeliface.h

This file was added.

1		/********************************************************************
2		Copyright 2016 Eike Hein <hein.org>
3
	graesslinUnsubmitted Not Done your email address in the copy right headers is not a valid email address (seems to be consistent over all header files) graesslin: your email address in the copy right headers is not a valid email address (seems to be…
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 ABSTRACTASKSMODELIFACE_H
22		#define ABSTRACTASKSMODELIFACE_H
23
24		#include <QObject>
25
26		#include "taskmanager_export.h"
27
28		namespace TaskManager
29		{
30
31		/**
32		* @short Pure virtual method interface for tasks model implementations.
33		*
34		* This is the pure virtual method interface implemented by AbstractTasksModel,
35		* as well as other model classes in this library which cannot inherit from
36		* AbstractTasksModel.
37		*
38		* @author Eike Hein <hein@kde.org>
39		**/
40
41		class TASKMANAGER_EXPORT AbstractTasksModelIface
42		{
43		public:
44		virtual ~AbstractTasksModelIface() {}
45
46		/**
47		* Request activation of the task at the given index. Implementing classes
48		* are free to interpret the meaning of "activate" themselves depending on
49		* the nature and state of the task, e.g. launch or raise a window task.
50		*
51		* @param index An index in this tasks model.
52		**/
53		virtual void requestActivate(const QModelIndex &index) = 0;
54
55		/**
56		* Request an additional instance of the application backing the task at
57		* the given index.
58		*
59		* @param index An index in this tasks model.
60		**/
61		virtual void requestNewInstance(const QModelIndex &index) = 0;
62
63		/**
64		* Request the task at the given index be closed.
65		*
66		* @param index An index in this tasks model.
67		**/
68		virtual void requestClose(const QModelIndex &index) = 0;
69
70		/**
71		* Request starting an interactive move for the task at the given index.
72		*
73		* This is meant for tasks that have an associated window, and may be
74		* a no-op when there is no window.
75		*
76		* @param index An index in this tasks model.
77		**/
78		virtual void requestMove(const QModelIndex &index) = 0;
79
80		/**
81		* Request starting an interactive resize for the task at the given index.
82		*
83		* This is meant for tasks that have an associated window, and may be a
84		* no-op when there is no window.
85		*
86		* @param index An index in this tasks model.
87		**/
88		virtual void requestResize(const QModelIndex &index) = 0;
89
90		/**
91		* Request toggling the minimized state of the task at the given index.
92		*
93		* This is meant for tasks that have an associated window, and may be
94		* a no-op when there is no window.
95		*
96		* @param index An index in this tasks model.
97		**/
98		virtual void requestToggleMinimized(const QModelIndex &index) = 0;
99
100		/**
101		* Request toggling the maximized state of the task at the given index.
102		*
103		* This is meant for tasks that have an associated window, and may be
104		* a no-op when there is no window.
105		*
106		* @param index An index in this tasks model.
107		**/
108		virtual void requestToggleMaximized(const QModelIndex &index) = 0;
109
110		/**
111		* Request toggling the keep-above state of the task at the given index.
112		*
113		* This is meant for tasks that have an associated window, and may be
114		* a no-op when there is no window.
115		*
116		* @param index An index in this tasks model.
117		**/
118		virtual void requestToggleKeepAbove(const QModelIndex &index) = 0;
119
120		/**
121		* Request toggling the keep-below state of the task at the given index.
122		*
123		* This is meant for tasks that have an associated window, and may be
124		* a no-op when there is no window.
125		*
126		* @param index An index in this tasks model.
127		**/
128		virtual void requestToggleKeepBelow(const QModelIndex &index) = 0;
129
130		/**
131		* Request toggling the fullscreen state of the task at the given index.
132		*
133		* This is meant for tasks that have an associated window, and may be
134		* a no-op when there is no window.
135		*
136		* @param index An index in this tasks model.
137		**/
138		virtual void requestToggleFullScreen(const QModelIndex &index) = 0;
139
140		/**
141		* Request toggling the shaded state of the task at the given index.
142		*
143		* This is meant for tasks that have an associated window, and may be
144		* a no-op when there is no window.
145		*
146		* @param index An index in this tasks model.
147		**/
148		virtual void requestToggleShaded(const QModelIndex &index) = 0;
149
150		/**
151		* Request moving the task at the given index to the specified virtual
152		* desktop.
153		*
154		* This is meant for tasks that have an associated window, and may be
155		* a no-op when there is no window.
156		*
157		* @param index An index in this tasks model.
158		* @param desktop A virtual desktop number.
159		**/
160		virtual void requestVirtualDesktop(const QModelIndex &index, qint32 desktop = -1) = 0;
161
162		/**
163		* Request informing the window manager of new geometry for a visual
164		* delegate for the task at the given index. The geometry should be in
165		* screen coordinates.
166		*
167		* FIXME: Doesn't deal with the long-standing problem of multiple
168		* delegates in multiple applets.
169		*
170		* @param index An index in this tasks model.
171		* @param geometry Visual delegate geometry in screen coordinates.
172		* @param delegate The delegate. Implementations are on their own with
173		* regard to extracting information from this, and should take care to
174		* reject invalid objects.
175		**/
176		virtual void requestPublishDelegateGeometry(const QModelIndex &index, const QRect &geometry,
177		QObject *delegate = nullptr) = 0;
178		};
179
180		}
181
182		#endif