Home · All Namespaces · All Classes
Public Types | Public Member Functions | Friends

Notification Class Reference

A class for storing notification information. More...

#include <notification.h>

Collaboration diagram for Notification:
Collaboration graph
[legend]

List of all members.

Public Types

enum  NotificationType { ApplicationEvent, SystemEvent }

Public Member Functions

 Notification ()
 Notification (uint notificationId, uint groupId, uint userId, const NotificationParameters &parameters, NotificationType type, int timeout)
 ~Notification ()
uint notificationId () const
uint userId () const
uint groupId () const
const NotificationParametersparameters () const
void setParameters (const NotificationParameters &parameters)
void updateParameters (const NotificationParameters &parameters)
NotificationType type () const
int timeout () const

Friends

QDataStream & operator<< (QDataStream &, const Notification &)
QDataStream & operator>> (QDataStream &, Notification &)
QDBusArgument & operator<< (QDBusArgument &, const Notification &notification)
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.

Notification::Notification ( uint  notificationId,
uint  groupId,
uint  userId,
const NotificationParameters parameters,
NotificationType  type,
int  timeout 
)

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 (  ) 

Destructor.


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
const NotificationParameters & Notification::parameters (  )  const

Returns the parameters list for this notification.

Returns:
parameters list for this notification
void Notification::setParameters ( const NotificationParameters parameters  ) 

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
Notification::NotificationType Notification::type (  )  const

Returns the type of this notification.

Returns:
type of this notification
void Notification::updateParameters ( const NotificationParameters parameters  ) 

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:

Copyright © 2011 Nokia Corporation Generated on Tue Aug 30 2011 16:38:13
Doxygen 1.7.1
MeeGo Touch