Qt Mobility Reference Documentation

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.


Public Types

enum ReminderType { NoReminder, AudibleReminder, VisualReminder, TactileReminder }

Public Functions

QDateTime dateTime () const
ReminderType reminderType () const
int repetitionCount () const
int repetitionDelay () const
void setDateTime ( const QDateTime & dateTime )
void setRepetition ( int count, int delaySeconds )
void setTimeDelta ( int secondsBefore )
int timeDelta () const

Public Variables

const char * DefinitionName
const char * FieldDateTime
const char * FieldReminderType
const char * FieldRepetitionCount
const char * FieldRepetitionDelay
const char * FieldTimeDelta

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

ConstantValueDescription
QOrganizerItemReminder::NoReminder0This reminder is entirely unobtrusive
QOrganizerItemReminder::AudibleReminder2This reminder has an audible element
QOrganizerItemReminder::VisualReminder1This reminder has a visual element
QOrganizerItemReminder::TactileReminder?This reminder has a tactile element

Member Function Documentation

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

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

QDateTime QOrganizerItemReminder::dateTime () const

Returns the date time at which the user should be reminded of the item.

See also setDateTime().

ReminderType QOrganizerItemReminder::reminderType () const

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

int QOrganizerItemReminder::repetitionCount () const

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

See also repetitionDelay().

int QOrganizerItemReminder::repetitionDelay () const

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

See also repetitionCount().

void QOrganizerItemReminder::setDateTime ( const QDateTime & dateTime )

Sets the date time at which the user should be reminded of the item to dateTime.

Calling this function will clear the time delta, if set.

See also dateTime() and setTimeDelta().

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

void QOrganizerItemReminder::setTimeDelta ( int secondsBefore )

Sets the number of seconds prior to the activation of the item at which the user wants to be reminded of the item to secondsBefore. 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.

See also timeDelta() and setDateTime().

int QOrganizerItemReminder::timeDelta () 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.

See also setTimeDelta().


Member Variable Documentation

const char * QOrganizerItemReminder::DefinitionName

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

const char * QOrganizerItemReminder::FieldDateTime

The constant key for which the date time at which the user should be reminded of the item is stored in details of the QOrganizerItemReminder type.

const char * QOrganizerItemReminder::FieldReminderType

The constant key for which the reminder type value is stored in details of the QOrganizerItemReminder type (and its subclasses).

const char * QOrganizerItemReminder::FieldRepetitionCount

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

const char * 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 char * QOrganizerItemReminder::FieldTimeDelta

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.

X

Thank you for giving your feedback.

Make sure it is related to this specific page. For more general bugs and requests, please use the Qt Bug Tracker.