mirror of
https://bitbucket.org/smil3y/kdelibs.git
synced 2025-02-24 02:42:48 +00:00
110 lines
3.7 KiB
C++
110 lines
3.7 KiB
C++
/* 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 <kdeui_export.h>
|
|
|
|
#include <QtCore/QObject>
|
|
|
|
/**
|
|
* 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 KDEUI_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 = 0);
|
|
virtual ~KNotificationRestrictions();
|
|
|
|
private:
|
|
class Private;
|
|
Private * const d;
|
|
|
|
Q_PRIVATE_SLOT( d, void screensaverFakeKeyEvent() )
|
|
};
|
|
|
|
Q_DECLARE_OPERATORS_FOR_FLAGS(KNotificationRestrictions::Services)
|
|
#endif
|