Differential D20265 Diff 57643 libnotificationmanager/settings.h

Changeset View

Standalone View

libnotificationmanager/settings.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 <QObject>
24
25		#include <KSharedConfig>
26
27		#include <QDateTime>
28		#include <QScopedPointer>
29		#include <QString>
30
31		#include "notificationmanager_export.h"
32
33		namespace NotificationManager
34		{
35
36		/**
37		* @short Notification settings and state
38		*
39		* This class encapsulates all global settings related to notifications
40		* as well as do not disturb mode and other state.
41		*
42		* This class can be used by applications to alter their behavior
43		* depending on user's notification preferences.
44		*
45		* @author Kai Uwe Broulik <kde@privat.broulik.de>
46		**/
47		class NOTIFICATIONMANAGER_EXPORT Settings : public QObject
48		{
49		Q_OBJECT
50
51		/**
52		* Whether to show critical notification popups in do not disturb mode.
53		*/
54		Q_PROPERTY(bool criticalPopupsInDoNotDisturbMode READ criticalPopupsInDoNotDisturbMode WRITE setCriticalPopupsInDoNotDisturbMode NOTIFY settingsChanged)
55		/**
56		* Whether to keep critical notifications always on top.
57		*/
58		Q_PROPERTY(bool keepCriticalAlwaysOnTop READ keepCriticalAlwaysOnTop WRITE setKeepCriticalAlwaysOnTop NOTIFY settingsChanged)
59		/**
60		* Whether to show popups for low priority notifications.
61		*/
62		Q_PROPERTY(bool lowPriorityPopups READ lowPriorityPopups WRITE setLowPriorityPopups NOTIFY settingsChanged)
63		/**
64		* Whether to add low priority notifications to the history.
65		*/
66		Q_PROPERTY(bool lowPriorityHistory READ lowPriorityHistory WRITE setLowPriorityHistory NOTIFY settingsChanged)
67
68		/**
69		* The notification popup position on screen.
70		* CloseToWidget means they should be positioned closely to where the plasmoid is located on screen.
71		*/
72		Q_PROPERTY(PopupPosition popupPosition READ popupPosition WRITE setPopupPosition NOTIFY settingsChanged)
73
74		/**
75		* The default timeout for notification popups that do not have an explicit timeout set,
76		* in milliseconds. Default is 5000ms (5 seconds).
77		*/
78		Q_PROPERTY(int popupTimeout READ popupTimeout WRITE setPopupTimeout RESET resetPopupTimeout NOTIFY settingsChanged)
79
80		/**
81		* Whether to show application jobs in task manager
82		*/
83		Q_PROPERTY(bool jobsInTaskManager READ jobsInTaskManager WRITE setJobsInTaskManager /RESET resetJobsInTaskManager/ NOTIFY settingsChanged)
84		/**
85		* Whether to show application jobs as notifications
86		*/
87		Q_PROPERTY(bool jobsInNotifications READ jobsInNotifications WRITE setJobsInNotifications /RESET resetJobsPopup/ NOTIFY settingsChanged)
88		/**
89		* Whether application jobs stay visible for the whole duration of the job
90		*/
91		Q_PROPERTY(bool permanentJobPopups READ permanentJobPopups WRITE setPermanentJobPopups /RESET resetAutoHideJobsPopup/ NOTIFY settingsChanged)
92
93		/**
94		* Whether to show notification badges (numbers in circles) in task manager
95		*/
96		Q_PROPERTY(bool badgesInTaskManager READ badgesInTaskManager WRITE setBadgesInTaskManager NOTIFY settingsChanged)
97
98		/**
99		* A list of desktop entries of applications that have been seen sending a notification.
100		*/
101		Q_PROPERTY(QStringList knownApplications READ knownApplications NOTIFY knownApplicationsChanged)
102
103		/**
104		* A list of desktop entries of applications for which no popups should be shown.
105		*/
106		Q_PROPERTY(QStringList popupBlacklistedApplications READ popupBlacklistedApplications NOTIFY settingsChanged)
107		/**
108		* A list of notifyrc names of services for which no popups should be shown.
109		*/
110		Q_PROPERTY(QStringList popupBlacklistedServices READ popupBlacklistedServices NOTIFY settingsChanged)
111
112		/**
113		* A list of desktop entries of applications for which a popup should be shown even in do not disturb mode.
114		*/
115		Q_PROPERTY(QStringList doNotDisturbPopupWhitelistedApplications
116		READ doNotDisturbPopupWhitelistedApplications
117		NOTIFY settingsChanged)
118		/**
119		* A list of notifyrc names of services for which a popup should be shown even in do not disturb mode.
120		*/
121		Q_PROPERTY(QStringList doNotDisturbPopupWhitelistedServices
122		READ doNotDisturbPopupWhitelistedServices
123		NOTIFY settingsChanged)
124
125		/**
126		* A list of desktop entries of applications which shouldn't be shown in the history.
127		*/
128		Q_PROPERTY(QStringList historyBlacklistedApplications READ historyBlacklistedApplications NOTIFY settingsChanged)
129		/**
130		* A list of notifyrc names of services which shouldn't be shown in the history.
131		*/
132		Q_PROPERTY(QStringList historyBlacklistedServices READ historyBlacklistedServices NOTIFY settingsChanged)
133
134		/**
135		* The date until which do not disturb mode is enabled.
136		*
137		* When invalid or in the past, do not disturb mode should be considered disabled.
138		* Do not disturb mode is considered active when this property points to a date
139		* in the future OR notificationsInhibitedByApplication is true.
140		*/
141		Q_PROPERTY(QDateTime notificationsInhibitedUntil
142		READ notificationsInhibitedUntil
143		WRITE setNotificationsInhibitedUntil
144		RESET resetNotificationsInhibitedUntil
145		NOTIFY settingsChanged)
146
147		/**
148		* Whether an application currently requested do not disturb mode.
149		*
150		* Do not disturb mode is considered active when this property is true OR
151		* notificationsInhibitedUntil points to a date in the future.
152		*
153		* @sa revokeApplicationInhibitions
154		*/
155		Q_PROPERTY(bool notificationsInhibitedByApplication
156		READ notificationsInhibitedByApplication
157		NOTIFY notificationsInhibitedByApplicationChanged)
158
159		Q_PROPERTY(QStringList notificationInhibitionApplications
160		READ notificationInhibitionApplications
161		NOTIFY notificationInhibitionApplicationsChanged)
162
163		Q_PROPERTY(QStringList notificationInhibitionReasons
164		READ notificationInhibitionReasons
165		NOTIFY notificationInhibitionApplicationsChanged)
166
167		/**
168		* Whether notification sounds should be disabled
169		*
170		* This does not reflect the actual mute state of the Notification Sounds
171		* stream but only remembers what value was assigned to this property.
172		*
173		* This way you can tell whether to unmute notification sounds or not, in case
174		* the user had them explicitly muted previously.
175		*
176		* @note This does not actually mute or unmute the actual sound stream,
177		* you need to do this yourself using e.g. PulseAudio.
178		*/
179		Q_PROPERTY(bool notificationSoundsInhibited
180		READ notificationSoundsInhibited
181		WRITE setNotificationSoundsInhibited
182		NOTIFY settingsChanged)
183
184		/**
185		* Whether to update the properties immediately when they are changed on disk
186		*
187		* This can be undesirable for a settings dialog where outside changes
188		* should not suddenly cause the UI to change.
189		*
190		* Default is true.
191		*/
192		Q_PROPERTY(bool live READ live WRITE setLive NOTIFY liveChanged)
193
194		/**
195		* Whether the settings have changed and need to be saved
196		*
197		* @sa save()
198		*/
199		Q_PROPERTY(bool dirty READ dirty NOTIFY dirtyChanged)
200
201		public:
202		explicit Settings(QObject *parent = nullptr);
203		Settings(const KSharedConfig::Ptr &config, QObject *parent = nullptr);
204		~Settings() override;
205
206		enum PopupPosition {
207		CloseToWidget = 0,
208		TopLeft,
209		TopCenter,
210		TopRight,
211		BottomLeft,
212		BottomCenter,
213		BottomRight
214		};
	ngrahamUnsubmitted Done I like `CloseToWidget` ngraham: I like `CloseToWidget`
215		Q_ENUM(PopupPosition)
216
217		enum NotificationBehavior {
218		ShowPopups = 1 << 1,
219		ShowPopupsInDoNotDisturbMode = 1 << 2,
220		ShowInHistory = 1 << 3,
221		ShowBadges = 1 << 4
222		};
223		Q_ENUM(NotificationBehavior)
224		Q_DECLARE_FLAGS(NotificationBehaviors, NotificationBehavior)
225		Q_FLAG(NotificationBehaviors)
226
227		Q_INVOKABLE NotificationBehaviors applicationBehavior(const QString &desktopEntry) const;
228		Q_INVOKABLE void setApplicationBehavior(const QString &desktopEntry, NotificationBehaviors behaviors);
229
230		Q_INVOKABLE NotificationBehaviors serviceBehavior(const QString &desktopEntry) const;
231		Q_INVOKABLE void setServiceBehavior(const QString &desktopEntry, NotificationBehaviors behaviors);
232
233		Q_INVOKABLE void registerKnownApplication(const QString &desktopEntry);
234		Q_INVOKABLE void forgetKnownApplication(const QString &desktopEntry);
235
236		Q_INVOKABLE void load();
237		Q_INVOKABLE void save();
238		Q_INVOKABLE void defaults();
239
240		bool live() const;
241		void setLive(bool live);
242
243		bool dirty() const;
244
245		bool criticalPopupsInDoNotDisturbMode() const;
246		void setCriticalPopupsInDoNotDisturbMode(bool enable);
247
248		bool keepCriticalAlwaysOnTop() const;
249		void setKeepCriticalAlwaysOnTop(bool enable);
250
251		bool lowPriorityPopups() const;
252		void setLowPriorityPopups(bool enable);
253
254		bool lowPriorityHistory() const;
255		void setLowPriorityHistory(bool enable);
256
257		PopupPosition popupPosition() const;
258		void setPopupPosition(PopupPosition popupPosition);
259
260		int popupTimeout() const;
261		void setPopupTimeout(int popupTimeout);
262		void resetPopupTimeout();
263
264		bool jobsInTaskManager() const;
265		void setJobsInTaskManager(bool enable);
266
267		bool jobsInNotifications() const;
268		void setJobsInNotifications(bool enable);
269
270		bool permanentJobPopups() const;
271		void setPermanentJobPopups(bool enable);
272
273		bool badgesInTaskManager() const;
274		void setBadgesInTaskManager(bool enable);
275
276		QStringList knownApplications() const;
277
278		QStringList popupBlacklistedApplications() const;
279		QStringList popupBlacklistedServices() const;
280
281		QStringList doNotDisturbPopupWhitelistedApplications() const;
282		QStringList doNotDisturbPopupWhitelistedServices() const;
283
284		QStringList historyBlacklistedApplications() const;
285		QStringList historyBlacklistedServices() const;
286
287		QDateTime notificationsInhibitedUntil() const;
288		void setNotificationsInhibitedUntil(const QDateTime &time);
289		void resetNotificationsInhibitedUntil();
290
291		bool notificationsInhibitedByApplication() const;
292		QStringList notificationInhibitionApplications() const;
293		QStringList notificationInhibitionReasons() const;
294
295		bool notificationSoundsInhibited() const;
296		void setNotificationSoundsInhibited(bool inhibited);
297
298		/**
299		* Revoke application notification inhibitions.
300		*
301		* @note Applications are not notified of the fact that their
302		* inhibition might have been taken away.
303		*/
304		Q_INVOKABLE void revokeApplicationInhibitions();
305
306		signals:
307		void settingsChanged();
308
309		void liveChanged();
310		void dirtyChanged();
311
312		void knownApplicationsChanged();
313
314		void notificationsInhibitedByApplicationChanged(bool notificationsInhibitedByApplication);
315		void notificationInhibitionApplicationsChanged();
316
317		private:
318		class Private;
319		QScopedPointer<Private> d;
320
321		};
322
323		} // namespace NotificationManager
324
325		Q_DECLARE_OPERATORS_FOR_FLAGS(NotificationManager::Settings::NotificationBehaviors)