KNotificationRestrictions Class Reference

#include <knotificationrestrictions.h>

Inheritance diagram for KNotificationRestrictions:

Public Types
enum	Service {   NoServices = 0, ScreenSaver = 1, MessagingPopups = 2, Notifications = 4,   CriticalNotifications = 8, NonCriticalServices, AllServices = NonCriticalServices | CriticalNotifications }

Public Member Functions
	KNotificationRestrictions (Services control=NonCriticalServices, QObject *parent=0)
virtual	~KNotificationRestrictions ()
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

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:

void MyApp::doPresentation()
{
  KNotificationRestrictions restrict(KNotificationRestrictions::ScreenSaver);
  // show presentation
}

Definition at line 47 of file knotificationrestrictions.h.

Member Enumeration Documentation

enum KNotificationRestrictions::Service

Enumerator
NoServices	The baseline "don't disable anything" value.
ScreenSaver	Causes the screensaver to be prevented from automatically turning on.
MessagingPopups	Causes instant messaging and email notifications to not appear. Note not implemented yet
Notifications	Causes non-critical desktop messages to be suppressed. Note not implemented yet
CriticalNotifications	Causes all desktop notifications, including critical ones (such as as "battery low" warnings) to be suppressed. Note not implemented yet
NonCriticalServices
AllServices

Definition at line 55 of file knotificationrestrictions.h.

Constructor & Destructor Documentation

KNotificationRestrictions::KNotificationRestrictions ( Services  control = NonCriticalServices, QObject *  parent = 0  )

explicit

Constructs a new service for restrict some services.

Parameters

control	the services to be restricted
parent	the parent of this object

Definition at line 75 of file knotificationrestrictions.cpp.

KNotificationRestrictions::~KNotificationRestrictions ( )

virtual

Definition at line 85 of file knotificationrestrictions.cpp.

---

The documentation for this class was generated from the following files:

• knotificationrestrictions.h
• knotificationrestrictions.cpp