A class for storing notification information.
More...
#include <notification.h>
List of all members.
Public Types |
enum | NotificationType { ApplicationEvent,
SystemEvent
} |
Public Member Functions |
| Notification () |
| Notification (uint notificationId, uint groupId, uint userId, const NotificationParameters ¶meters, NotificationType type, int timeout) |
| ~Notification () |
uint | notificationId () const |
uint | userId () const |
uint | groupId () const |
const NotificationParameters & | parameters () const |
void | setParameters (const NotificationParameters ¶meters) |
void | updateParameters (const NotificationParameters ¶meters) |
NotificationType | type () const |
int | timeout () const |
Friends |
QDataStream & | operator<< (QDataStream &, const Notification &) |
QDataStream & | operator>> (QDataStream &, Notification &) |
QDBusArgument & | operator<< (QDBusArgument &, const Notification ¬ification) |
const QDBusArgument & | operator>> (const QDBusArgument &, Notification &) |
Detailed Description
A class for storing notification information.
The information can also be serialized in and out of a QDataStream.
Member Enumeration Documentation
Notification types.
- Enumerator:
ApplicationEvent |
|
SystemEvent |
|
Constructor & Destructor Documentation
Notification::Notification |
( |
|
) |
|
Empty constructor. Initializes the values to defaults.
Constructor.
- Parameters:
-
| notificationId | the ID of this notification |
| groupId | the group ID of this notification |
| userId | the user ID associated to this notification |
| parameters | parameters for the notification to be presented |
| type | the type of the notification to be presented. |
- See also:
- NotificationType.
- Parameters:
-
| timeout | The number of milliseconds to present the notification for |
Notification::~Notification |
( |
|
) |
|
Member Function Documentation
uint Notification::groupId |
( |
|
) |
const |
Returns the group ID of this notification.
- Returns:
- group ID of this notification
uint Notification::notificationId |
( |
|
) |
const |
Returns the ID of this notification.
- Returns:
- ID of this notification
Returns the parameters list for this notification.
- Returns:
- parameters list for this notification
Sets the parameters list for this notification.
- Parameters:
-
| parameters | parameters for this notification |
- See also:
- updateParameters
int Notification::timeout |
( |
|
) |
const |
Returns the timeout of this notification.
- Returns:
- timeout of this notification
Returns the type of this notification.
- Returns:
- type of this notification
Updates the parameters of this notification. The existing parameters in the notification remain as they are. Only new values from the argument are appended/updated.
- Parameters:
-
| parameters | the parameters that will be updated |
- See also:
- setParameters
uint Notification::userId |
( |
|
) |
const |
Returns the user ID associated with this notification.
- Returns:
- user ID associated with this notification
Friends And Related Function Documentation
QDataStream& operator<< |
( |
QDataStream & |
, |
|
|
const Notification & |
| |
|
) |
| | [friend] |
Serializes the given Notification to a QDataStream
- Parameters:
-
| datastream | QDataStream to write to |
| notification | Notification object to serialize |
QDBusArgument& operator<< |
( |
QDBusArgument & |
argument, |
|
|
const Notification & |
notification | |
|
) |
| | [friend] |
const QDBusArgument& operator>> |
( |
const QDBusArgument & |
argument, |
|
|
Notification & |
notification | |
|
) |
| | [friend] |
QDataStream& operator>> |
( |
QDataStream & |
, |
|
|
Notification & |
| |
|
) |
| | [friend] |
Deserializes a Notification from a QDataStream
- Parameters:
-
| datastream | QDataStream to read from |
| notification | the target Notification object, its previous state will be reset |
The documentation for this class was generated from the following files:
- /home/bifh1/cs2009q3-i386/work/system-ui-1.0.23/src/libnotificationsystem/notification.h
- /home/bifh1/cs2009q3-i386/work/system-ui-1.0.23/src/libnotificationsystem/notification.cpp