MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

Contents

QOrganizerItemRecurrence Class Reference

The QOrganizerItemRecurrence class contains a list of rules and dates on which the recurrent item occurs, and a list of rules and dates on which exceptions occur. More...

 #include <QOrganizerItemRecurrence>

Inherits: QOrganizerItemDetail.

This class was introduced in Qt Mobility 1.1.

Public Functions

QSet<QDate> exceptionDates () const
QSet<QOrganizerRecurrenceRule> exceptionRules () const
QSet<QDate> recurrenceDates () const
QSet<QOrganizerRecurrenceRule> recurrenceRules () const
void setExceptionDates ( const QSet<QDate> & xdates )
void setExceptionRules ( const QSet<QOrganizerRecurrenceRule> & xrules )
void setRecurrenceDates ( const QSet<QDate> & rdates )
void setRecurrenceRules ( const QSet<QOrganizerRecurrenceRule> & rrules )
bool operator== ( const QOrganizerItemRecurrence & other ) const

Static Public Members

const QLatin1Constant DefinitionName
const QLatin1Constant FieldExceptionDates
const QLatin1Constant FieldExceptionRules
const QLatin1Constant FieldRecurrenceDates
const QLatin1Constant FieldRecurrenceRules

Detailed Description

The QOrganizerItemRecurrence class contains a list of rules and dates on which the recurrent item occurs, and a list of rules and dates on which exceptions occur.

Member Function Documentation

QSet<QDate> QOrganizerItemRecurrence::exceptionDates () const

Returns the set of exception dates.

This function was introduced in Qt Mobility 1.1.

See also setExceptionDates().

QSet<QOrganizerRecurrenceRule> QOrganizerItemRecurrence::exceptionRules () const

Returns the set of exception rules.

This function was introduced in Qt Mobility 1.1.

See also setExceptionRules().

QSet<QDate> QOrganizerItemRecurrence::recurrenceDates () const

Returns the set of recurrence dates.

This function was introduced in Qt Mobility 1.1.

See also setRecurrenceDates().

QSet<QOrganizerRecurrenceRule> QOrganizerItemRecurrence::recurrenceRules () const

Returns the set of recurrence rules.

This function was introduced in Qt Mobility 1.1.

See also setRecurrenceRules().

void QOrganizerItemRecurrence::setExceptionDates ( const QSet<QDate> & xdates )

Sets the set of exception dates to xdates.

This function was introduced in Qt Mobility 1.1.

See also exceptionDates().

void QOrganizerItemRecurrence::setExceptionRules ( const QSet<QOrganizerRecurrenceRule> & xrules )

Sets the set of exception rules to xrules.

This function was introduced in Qt Mobility 1.1.

See also exceptionRules().

void QOrganizerItemRecurrence::setRecurrenceDates ( const QSet<QDate> & rdates )

Sets the set of recurrence dates to rdates.

This function was introduced in Qt Mobility 1.1.

See also recurrenceDates().

void QOrganizerItemRecurrence::setRecurrenceRules ( const QSet<QOrganizerRecurrenceRule> & rrules )

Sets the set of recurrence rules to rrules.

This function was introduced in Qt Mobility 1.1.

See also recurrenceRules().

bool QOrganizerItemRecurrence::operator== ( const QOrganizerItemRecurrence & other ) const

Returns true if the other recurrence detail is equal to this detail; otherwise, false.

Since the data types stored in this detail are custom data types, the base class operator==() doesn't know how to perform the comparison without calling this function. However, it means that if (in the future) a backend were to extend the detail with more fields, this operator== would no longer work; it'd have to be updated to compare the other fields also.

This function was introduced in Qt Mobility 1.1.

Member Variable Documentation

const QLatin1Constant QOrganizerItemRecurrence::DefinitionName

The constant string which identifies the definition of details which are organizer item recurrence specifications.

const QLatin1Constant QOrganizerItemRecurrence::FieldExceptionDates

The constant key for the value which is stored in details of the QOrganizerItemRecurrence type which describes the dates on which an item should not recur.

If a recurrence rule or the recurrence dates list specifies that an item should occur on a particular date and that date appears in the exception dates list, the item should not occur on that date.

const QLatin1Constant QOrganizerItemRecurrence::FieldExceptionRules

The constant key for the value which is stored in details of the QOrganizerItemRecurrence type which describes the rules for when an item should not recur.

If a recurrence rule or the recurrence dates list specifies that an item should occur on a particular date and any of the exception rules include that date, the item should not occur on that date.

const QLatin1Constant QOrganizerItemRecurrence::FieldRecurrenceDates

The constant key for the value which is stored in details of the QOrganizerItemRecurrence type which describes the dates on which an item should recur.

const QLatin1Constant QOrganizerItemRecurrence::FieldRecurrenceRules

The constant key for the value which is stored in details of the QOrganizerItemRecurrence type which describes the rules for when an item should recur.

When multiple rules are specified, the list of recurrence dates are calculated separately for each rule and the results are unioned.

© 2008-2011 Nokia Corporation and/or its subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation in Finland and/or other countries worldwide.

All other trademarks are property of their respective owners. Privacy Policy


Licensees holding valid Qt Commercial licenses may use this document in accordance with the Qt Commercial License Agreement provided with the Software or, alternatively, in accordance with the terms contained in a written agreement between you and Nokia.

Alternatively, this document may be used under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation.