MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

QOrganizerItemReminder Class Reference

The QOrganizerItemReminder class contains information about when and how the user wants to reminded of the item More...

 #include <QOrganizerItemReminder>

Inherits: QOrganizerItemDetail.

Inherited by: QOrganizerItemAudibleReminder, QOrganizerItemEmailReminder, and QOrganizerItemVisualReminder.

This class was introduced in Qt Mobility 1.1.

Public Types

enum ReminderType { NoReminder, AudibleReminder, VisualReminder, EmailReminder }

Public Functions

ReminderType reminderType () const
int repetitionCount () const
int repetitionDelay () const
int secondsBeforeStart () const
void setRepetition ( int count, int delaySeconds )
void setSecondsBeforeStart ( int seconds )

Static Public Members

const QLatin1Constant DefinitionName
const QLatin1Constant FieldRepetitionCount
const QLatin1Constant FieldRepetitionDelay
const QLatin1Constant FieldSecondsBeforeStart

Protected Functions

QOrganizerItemReminder ( const char * definitionName )
QOrganizerItemReminder ( const QOrganizerItemDetail & detail, const char * definitionName )

Macros

Q_DECLARE_CUSTOM_ORGANIZER_REMINDER_DETAIL

Detailed Description

The QOrganizerItemReminder class contains information about when and how the user wants to reminded of the item

Note that the Organizer API does not enforce that the user is reminded of the item; rather, it simply allows clients to store and manipulate data which might be used by the platform to implement alarms and reminders.

Member Type Documentation

enum QOrganizerItemReminder::ReminderType

Constant Value Description
QOrganizerItemReminder::NoReminder 0 This reminder is entirely unobtrusive
QOrganizerItemReminder::AudibleReminder 2 This reminder has an audible element
QOrganizerItemReminder::VisualReminder 1 This reminder has a visual element
QOrganizerItemReminder::EmailReminder 3 This reminder has a email element

Member Function Documentation

QOrganizerItemReminder::QOrganizerItemReminder ( const char * definitionName ) [protected]

Constructor of a QOrganizerItemReminder object by defining the definitionName.

This function was introduced in Qt Mobility 1.1.

QOrganizerItemReminder::QOrganizerItemReminder ( const QOrganizerItemDetail & detail, const char * definitionName ) [protected]

Constructor of a QOrganizerItemReminder object by defining the detail, and definitionName.

This function was introduced in Qt Mobility 1.1.

ReminderType QOrganizerItemReminder::reminderType () const

Returns the reminder type of this reminder for an organizer item.

This function was introduced in Qt Mobility 1.1.

int QOrganizerItemReminder::repetitionCount () const

Returns the number of times the user should be reminded of the item.

This function was introduced in Qt Mobility 1.1.

See also repetitionDelay().

int QOrganizerItemReminder::repetitionDelay () const

Returns the delay (in seconds) between each repetition of the reminder.

This function was introduced in Qt Mobility 1.1.

See also repetitionCount().

int QOrganizerItemReminder::secondsBeforeStart () const

Returns the number of seconds prior to the activation of the item at which the user wants to be reminded of the item. The exact datetime of activation of the item depends on the type of item: for a QOrganizerTodo or QOrganizerTodoOccurrence it is the due date time; for a QOrganizerEvent or QOrganizerEventOccurrence it is the start date time.

This function was introduced in Qt Mobility 1.1.

See also setSecondsBeforeStart().

void QOrganizerItemReminder::setRepetition ( int count, int delaySeconds )

Sets the number of repetitions of the reminderto count, and the delay (in seconds) between each repetition of the reminder to delaySeconds.

This function was introduced in Qt Mobility 1.1.

See also repetitionCount() and repetitionDelay().

void QOrganizerItemReminder::setSecondsBeforeStart ( int seconds )

Sets the number of seconds prior to the activation of the item at which the user wants to be reminded of the item to seconds. The exact datetime of activation of the item depends on the type of item: for a QOrganizerTodo or QOrganizerTodoOccurrence it is the due date time; for a QOrganizerEvent or QOrganizerEventOccurrence it is the start date time.

Calling this function will clear the absolute date time, if set.

This function was introduced in Qt Mobility 1.1.

See also secondsBeforeStart().

Member Variable Documentation

const QLatin1Constant QOrganizerItemReminder::DefinitionName

The constant string which identifies the definition of details which contain reminder information of an organizer item.

const QLatin1Constant QOrganizerItemReminder::FieldRepetitionCount

The constant key for which the number of repetitions of the reminder is stored in details of the QOrganizerItemReminder type.

const QLatin1Constant QOrganizerItemReminder::FieldRepetitionDelay

The constant key for which the delay (in seconds) between repetitions of the reminder is stored in details of the QOrganizerItemReminder type.

const QLatin1Constant QOrganizerItemReminder::FieldSecondsBeforeStart

The constant key for which time delta (in seconds prior to the item activation time) at which the user should be reminded of the item is stored in details of the QOrganizerItemReminder type.

Macro Documentation

Q_DECLARE_CUSTOM_ORGANIZER_REMINDER_DETAIL

Macro for simplifying declaring custom (leaf) reminder detail classes.

The first argument is the name of the class, and the second argument is a Latin-1 string literal naming the detail type, and the third argument is the reminder type of the leaf reminder detail class.

If you are creating a convenience class for a type of QOrganizerItemReminder, you should use this macro when declaring your class to ensure that it interoperates with other organizer item functionality.