Changeset View
Changeset View
Standalone View
Standalone View
libnotificationmanager/jobsmodel.h
- This file was added.
1 | /* | ||||
---|---|---|---|---|---|
2 | * Copyright 2019 Kai Uwe Broulik <kde@privat.broulik.de> | ||||
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 | #pragma once | ||||
22 | | ||||
23 | #include <QAbstractListModel> | ||||
24 | #include <QScopedPointer> | ||||
25 | #include <QSharedPointer> | ||||
26 | | ||||
27 | #include "notifications.h" | ||||
28 | #include "notificationmanager_export.h" | ||||
29 | | ||||
30 | namespace NotificationManager | ||||
31 | { | ||||
32 | | ||||
33 | class JobsModelPrivate; | ||||
34 | | ||||
35 | class NOTIFICATIONMANAGER_EXPORT JobsModel : public QAbstractListModel | ||||
36 | { | ||||
37 | Q_OBJECT | ||||
38 | | ||||
39 | public: | ||||
40 | ~JobsModel() override; | ||||
41 | | ||||
42 | using Ptr = QSharedPointer<JobsModel>; | ||||
43 | static Ptr createJobsModel(); | ||||
44 | | ||||
45 | /** | ||||
46 | * Registers the JobView service on DBus. | ||||
47 | * | ||||
48 | * @return true if succeeded, false otherwise. | ||||
49 | */ | ||||
50 | bool init(); | ||||
51 | | ||||
52 | /** | ||||
53 | * Whether the notification service could be reigstered | ||||
54 | */ | ||||
55 | bool isValid() const; | ||||
56 | | ||||
57 | QVariant data(const QModelIndex &index, int role) const override; | ||||
58 | bool setData(const QModelIndex &index, const QVariant &value, int role) override; | ||||
59 | int rowCount(const QModelIndex &parent = QModelIndex()) const override; | ||||
60 | | ||||
61 | /** | ||||
62 | * @brief Close a job | ||||
63 | * | ||||
64 | * This removes the job from the model. This will not cancel the job! | ||||
65 | * Use @c kill if you want to cancel a job. | ||||
66 | */ | ||||
67 | void close(const QModelIndex &idx); | ||||
68 | void expire(const QModelIndex &idx); | ||||
69 | | ||||
70 | /** | ||||
71 | * @brief Suspend a job | ||||
72 | */ | ||||
73 | void suspend(const QModelIndex &idx); | ||||
74 | /** | ||||
75 | * @brief Resume a job | ||||
76 | */ | ||||
77 | void resume(const QModelIndex &idx); | ||||
78 | /** | ||||
79 | * @brief Kill a job | ||||
80 | * | ||||
81 | * This cancels the job. | ||||
82 | */ | ||||
83 | void kill(const QModelIndex &idx); | ||||
84 | | ||||
85 | void clear(Notifications::ClearFlags flags); | ||||
86 | | ||||
87 | private: | ||||
88 | JobsModel(); | ||||
89 | Q_DISABLE_COPY(JobsModel) | ||||
90 | | ||||
91 | JobsModelPrivate *d; | ||||
92 | | ||||
93 | }; | ||||
94 | | ||||
95 | } // namespace NotificationManager |