1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
/*
SPDX-FileCopyrightText: 2016 Eike Hein <hein@kde.org>
SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
*/
#pragma once
#include "abstracttasksmodel.h"
#include "taskmanager_export.h"
#include <QUrl>
namespace TaskManager
{
/**
* @short A tasks model for launchers.
*
* This model presents tasks sourced from list of launcher URLs. The
* list can be read from and written to from a notifiable prop, enabling
* storage outside the instance (e.g. in config).
*
* Extends AbstractTasksModel API with API for adding, removing, checking
* for and moving launchers by URL or row index.
*
* Launcher URLs can use the preferred:// protocol to request system
* default applications such as "browser" and "mailer".
*
* @see defaultApplication
*
* @author Eike Hein <hein@kde.org>
*/
class TASKMANAGER_EXPORT LauncherTasksModel : public AbstractTasksModel
{
Q_OBJECT
Q_PROPERTY(QStringList launcherList READ launcherList WRITE setLauncherList NOTIFY launcherListChanged)
public:
explicit LauncherTasksModel(QObject *parent = nullptr);
~LauncherTasksModel() override;
QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
int rowCount(const QModelIndex &parent = QModelIndex()) const override;
int rowCountForActivity(const QString &activity) const;
/**
* The list of launcher URLs serialized to strings along with
* the activities they belong to.
*
* @see setLauncherList
* @returns the list of launcher URLs serialized to strings.
**/
QStringList launcherList() const;
/**
* Replace the list of launcher URL strings.
*
* Invalid or empty URLs will be rejected. Duplicate URLs will be
* collapsed.
*
* @see launcherList
* @param launchers A list of launcher URL strings.
**/
void setLauncherList(const QStringList &launchers);
/**
* Request adding a launcher with the given URL.
*
* If this URL is already in the list, the request will fail. URLs are
* compared for equality after removing the query string used to hold
* metadata.
*
* @see launcherUrlsMatch
* @param url A launcher URL.
* @returns @c true if a launcher was added.
*/
bool requestAddLauncher(const QUrl &url);
/**
* Request removing the launcher with the given URL.
*
* If this URL is already in the list, the request will fail. URLs are
* compared for equality after removing the query string used to hold
* metadata.
*
* @see launcherUrlsMatch
* @param url A launcher URL.
* @returns @c true if the launcher was removed.
*/
bool requestRemoveLauncher(const QUrl &url);
/**
* Request adding a launcher with the given URL to current activity.
*
* If this URL is already in the list, the request will fail. URLs are
* compared for equality after removing the query string used to hold
* metadata.
*
* @see launcherUrlsMatch
* @param url A launcher URL.
* @returns @c true if a launcher was added.
*/
bool requestAddLauncherToActivity(const QUrl &url, const QString &activity);
/**
* Request removing the launcher with the given URL from the current activity.
*
* If this URL is already in the list, the request will fail. URLs are
* compared for equality after removing the query string used to hold
* metadata.
*
* @see launcherUrlsMatch
* @param url A launcher URL.
* @returns @c true if the launcher was removed.
*/
bool requestRemoveLauncherFromActivity(const QUrl &url, const QString &activity);
/**
* Return the list of activities the launcher belongs to.
* If there is no launcher with that url, the list will be empty,
* while if the launcher is on all activities, it will contain a
* null uuid.
*
* URLs are compared for equality after removing the query string used
* to hold metadata.
*/
QStringList launcherActivities(const QUrl &url) const;
/**
* Return the position of the launcher with the given URL.
*
* URLs are compared for equality after removing the query string used
* to hold metadata.
*
* @see launcherUrlsMatch
* @param url A launcher URL.
* @returns @c -1 if no launcher exists for the given URL.
*/
int launcherPosition(const QUrl &url) const;
/**
* Runs the URL (i.e. launches the application) at the given index.
*
* @param index An index in this launcher tasks model.
*/
void requestActivate(const QModelIndex &index) override;
/**
* Runs the URL (i.e. launches the application) at the given index.
*
* @param index An index in this launcher tasks model.
*/
void requestNewInstance(const QModelIndex &index) override;
/**
* Runs the application backing the launcher at the given index with the given URLs.
*
* @param index An index in this launcher tasks model
* @param urls The URLs to be passed to the application
*/
void requestOpenUrls(const QModelIndex &index, const QList<QUrl> &urls) override;
Q_SIGNALS:
void launcherListChanged() const;
private:
class Private;
QScopedPointer<Private> d;
};
}
|
