Differential D1722 Diff 4228 libtaskmanager/launchertasksmodel.h

Changeset View

Standalone View

libtaskmanager/launchertasksmodel.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 LAUNCHERTASKSMODEL_H
22		#define LAUNCHERTASKSMODEL_H
23
24		#include "abstracttasksmodel.h"
25
26		#include "taskmanager_export.h"
27
28		#include <QUrl>
29
30		namespace TaskManager
31		{
32
33		/**
34		* @short A tasks model for launchers.
35		*
36		* This model presents tasks sourced from list of launcher URLs. The
37		* list can be read from and written to from a notifiable prop, enabling
38		* storage outside the instance (e.g. in config).
39		*
40		* Extends AbstractTasksModel API with API for adding, removing, checking
41		* for and moving launchers by URL or row index.
42		*
43		* Launcher URLs can use the preferred:// protocol to request system
44		* default applications such as "browser" and "mailer".
45		*
46		* @see defaultApplication
47		*
48		* @author Eike Hein <hein@kde.org>
49		*/
50
51		class TASKMANAGER_EXPORT LauncherTasksModel : public AbstractTasksModel
52		{
53		Q_OBJECT
54
55		Q_PROPERTY(QStringList launcherList READ launcherList WRITE setLauncherList NOTIFY launcherListChanged)
56
57		public:
58		explicit LauncherTasksModel(QObject *parent = 0);
59		virtual ~LauncherTasksModel();
60
61		virtual QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
62		int rowCount(const QModelIndex &parent = QModelIndex()) const override;
	broulikUnsubmitted Done Either virtual or override (preferrably the latter) broulik: Either virtual or override (preferrably the latter)
	heinAuthorUnsubmitted Not Done Done. hein: Done.
63
64		/**
65		* The list of launcher URLs serialized to strings.
66		*
67		* @see setLauncherList
68		* @returns the list of launcher URLs serialized to strings.
69		**/
70		QStringList launcherList() const;
71
72		/**
73		* Replace the list of launcher URL strings.
74		*
75		* Invalid or empty URLs will be rejected. Duplicate URLs will be
76		* collapsed.
77		*
78		* @see launcherList
79		* @param launchers A list of launcher URL strings.
80		**/
81		void setLauncherList(const QStringList &launchers);
82
83		/**
84		* Request adding a launcher with the given URL.
85		*
86		* If this URL is already in the list, the request will fail. URLs are
87		* compared for equality after removing the query string used to hold
	broulikUnsubmitted Not Done "will fail" sounds like it's dangerous, "will do nothing"? broulik: "will fail" sounds like it's dangerous, "will do nothing"?
	heinAuthorUnsubmitted Not Done It means it will return false, for failure. hein: It means it will return false, for failure.
88		* metadata.
89		*
90		* @see launcherUrlsMatch
91		* @param url A launcher URL.
92		* @returns @c true if a launcher was added.
93		*/
94		bool requestAddLauncher(const QUrl &url);
95
96		/**
97		* Request removing the launcher with the given URL.
98		*
99		* If this URL is already in the list, the request will fail. URLs are
100		* compared for equality after removing the query string used to hold
101		* metadata.
102		*
103		* @see launcherUrlsMatch
104		* @param url A launcher URL.
105		* @returns @c true if the launcher was removed.
106		*/
107		bool requestRemoveLauncher(const QUrl &url);
108
109		/**
110		* Return the position of the launcher with the given URL.
111		*
112		* URLs are compared for equality after removing the query string used
113		* to hold metadata.
114		*
115		* @see launcherUrlsMatch
116		* @param url A launcher URL.
117		* @returns @c -1 if no launcher exists for the given URL.
118		*/
119		int launcherPosition(const QUrl &url) const;
120
121		/**
122		* Runs the URL (i.e. launches the application) at the given index.
123		*
124		* @param index An index in this launcher tasks model.
125		*/
126		void requestActivate(const QModelIndex &index) override;
127
128		/**
129		* Runs the URL (i.e. launches the application) at the given index.
130		*
131		* @param index An index in this launcher tasks model.
132		*/
133		void requestNewInstance(const QModelIndex &index) override;
134
135		Q_SIGNALS:
136		void launcherListChanged() const;
137
138		private:
139		class Private;
140		QScopedPointer<Private> d;
141		};
142
143		}
144
145		#endif