/usr/include/KF5/KNotifications/knotificationrestrictions.h is in libkf5notifications-dev 5.44.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | /* This file is part of the KDE libraries
Copyright (C) 2006 Aaron Seigo <aseigo@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KDELIBS_KNOTIFICATIONRESTRICTIONS_H
#define KDELIBS_KNOTIFICATIONRESTRICTIONS_H
#include <knotifications_export.h>
#include <QtCore/QObject>
/**
* @class KNotificationRestrictions knotificationrestrictions.h KNotificationRestrictions
*
* KNotificationRestrictions provides a simple mechanism to avoid disruptions
* during full screen presentations or other use cases where the screensaver or
* desktop notifcations are inappropriate.
*
* Using KNotificationRestrictions is quite straightforward: create an instance
* of KNotificationRestrictions, passing in the set of or'd flags representing
* the services that should be prevented from interrupting the user. When done
* (for instance when the presentation is complete) simply delete the
* KNotificationRestrictions object.
*
* Example: to ensure the screensaver does not turn on during a presentation:
* @code
* void MyApp::doPresentation()
* {
* KNotificationRestrictions restrict(KNotificationRestrictions::ScreenSaver);
* // show presentation
* }
* @endcode
*/
class KNOTIFICATIONS_EXPORT KNotificationRestrictions : public QObject
{
Q_OBJECT
public:
/**
* @enum Service
*/
enum Service {
/**
* The baseline "don't disable anything" value.
*/
NoServices = 0,
/**
* Causes the screensaver to be prevented from automatically
* turning on.
*/
ScreenSaver = 1,
/**
* Causes instant messaging and email notifications to not appear.
*
* @note <b>not implemented yet</b>
*/
MessagingPopups = 2,
/**
* Causes non-critical desktop messages to be suppressed.
*
* @note <b>not implemented yet</b>
*/
Notifications = 4,
/**
* Causes all desktop notifications, including critical ones
* (such as as "battery low" warnings) to be suppressed.
*
* @note <b>not implemented yet</b>
*/
CriticalNotifications = 8,
NonCriticalServices = ScreenSaver |
MessagingPopups |
Notifications,
AllServices = NonCriticalServices | CriticalNotifications
};
Q_DECLARE_FLAGS(Services, Service)
/**
* Constructs a new service for restrict some services.
*
* @param control the services to be restricted
* @param parent the parent of this object
*/
explicit KNotificationRestrictions(Services control = NonCriticalServices,
QObject *parent = nullptr);
virtual ~KNotificationRestrictions();
/**
* Constructs a new service for restrict some services.
*
* @param control the services to be restricted
* @param reason the reason for restriction
* @param parent the parent of this object
*/
// TODO KF6 make reason optional
explicit KNotificationRestrictions(Services control,
const QString &reason,
QObject *parent = nullptr);
private:
class Private;
Private *const d;
Q_PRIVATE_SLOT(d, void screensaverFakeKeyEvent())
};
Q_DECLARE_OPERATORS_FOR_FLAGS(KNotificationRestrictions::Services)
#endif
|