NotificationSink Class Reference

#include <notificationsink.h>

Inheritance diagram for NotificationSink:

[legend]

Collaboration diagram for NotificationSink:

[legend]

List of all members.

Public Slots
virtual void	addNotification (const Notification &notification)=0
virtual void	removeNotification (uint notificationId)=0
virtual void	addGroup (uint groupId, const NotificationParameters &parameters)
virtual void	removeGroup (uint groupId)
Signals
void	notificationRemovalRequested (uint notificationId)
void	notificationGroupClearingRequested (uint groupId)
Public Member Functions
	NotificationSink ()
bool	applicationEventsEnabled ()
	Returns whether the the sink should process notifications with ApplicationEvent type.
void	setApplicationEventsEnabled (bool enabled)
Protected Member Functions
bool	canAddNotification (const Notification &notification)

---

Detailed Description

Notification sink is an abstract interface for classes that can present notifications. Concrete notification sinks are responsible for presenting notifications and possibly notifying the NotificationManagerInterface if the notification was dismissed.

Definition at line 31 of file notificationsink.h.

---

Constructor & Destructor Documentation

NotificationSink::NotificationSink

(

)

Definition at line 22 of file notificationsink.cpp.

                                   : appEventsEnabled(true)
{
}

---

Member Function Documentation

void NotificationSink::addGroup	(	uint	groupId,
		const NotificationParameters &	parameters
	)			[virtual, slot]

Creates a notification group.

Parameters:

	groupId	the ID of the group
	parameters	NotificationParameters for the group

Definition at line 26 of file notificationsink.cpp.

{
    Q_UNUSED(groupId)
    Q_UNUSED(parameters)
}

virtual void NotificationSink::addNotification

(

const Notification &

notification

)

[pure virtual, slot]

Adds a notification to be presented.

Parameters:

notification

the data of the notification

Implemented in UnlockNotificationSink.

bool NotificationSink::applicationEventsEnabled

(

)

Returns whether the the sink should process notifications with ApplicationEvent type.

Definition at line 37 of file notificationsink.cpp.

{
    return appEventsEnabled;
}

bool NotificationSink::canAddNotification

(

const Notification &

notification

)

[protected]

Returns whether the sink should add the given notification

Parameters:

notification

the notification

Reimplemented in UnlockNotificationSink.

Definition at line 47 of file notificationsink.cpp.

{
    return appEventsEnabled || notification.type() == Notification::SystemEvent;
}

Here is the call graph for this function:

void NotificationSink::notificationGroupClearingRequested

(

uint

groupId

)

[signal]

Requests removal of notifications in a group.

Parameters:

groupId

Id of the group to be cleared.

void NotificationSink::notificationRemovalRequested

(

uint

notificationId

)

[signal]

Requests removal of a notification from the notification system. This can be connected to the associated NotificationManagerInterface::removeNotification().

Parameters:

notificationId

Id of the notification to be removed from the system.

void NotificationSink::removeGroup

(

uint

groupId

)

[virtual, slot]

Removes a notification group.

Parameters:

groupId

the ID of the group

Definition at line 32 of file notificationsink.cpp.

{
    Q_UNUSED(groupId)
}

virtual void NotificationSink::removeNotification

(

uint

notificationId

)

[pure virtual, slot]

Removes a notification.

Parameters:

notificationId

the ID of the notification to be removed

Implemented in UnlockNotificationSink.

void NotificationSink::setApplicationEventsEnabled

(

bool

enabled

)

Sets whether the the sink should process notifications with ApplicationEvent type

Parameters:

enabled

the new status

Definition at line 42 of file notificationsink.cpp.

{
    appEventsEnabled = enabled;
}

---

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

• src/libnotificationsystem/notificationsink.h (080a9b99aae731d08256cbfacde1ae3a0ee0b7c9)
• src/libnotificationsystem/notificationsink.cpp (e1ecea8f0a4c4ade39ea658f72b926bbcbc38aae)