QOrganizerRecurrenceRule Class Reference

Member Function Documentation

QOrganizerRecurrenceRule::QOrganizerRecurrenceRule ()

Constructs a QOrganizerRecurrenceRule object describing a weekly recurrence.

QOrganizerRecurrenceRule::QOrganizerRecurrenceRule ( const QOrganizerRecurrenceRule & other )

* Constructs a QOrganizerRecurrenceRule object as a copy of other.

This function was introduced in Qt Mobility 1.1.

QOrganizerRecurrenceRule::~QOrganizerRecurrenceRule ()

Destroys the QOrganizerRecurrenceRule object.

void QOrganizerRecurrenceRule::clearLimit ()

Clear any recurrence rule limitation conditions.

This function was introduced in Qt Mobility 1.1.

QSet<int> QOrganizerRecurrenceRule::daysOfMonth () const

* Returns a list of the days of the month that the item should recur on. If not set, this is the * empty list, which signifies that it should be implied, if necessary, by the day-of-month of the * item.

This function was introduced in Qt Mobility 1.1.

See also setDaysOfMonth().

QSet<Qt::DayOfWeek> QOrganizerRecurrenceRule::daysOfWeek () const

* Returns a list of the days of week that the item should recur on. If not set, this is the empty * list, which signifies that it should be implied, if necessary, by the day-of-week of the item.

This function was introduced in Qt Mobility 1.1.

See also setDaysOfWeek().

QSet<int> QOrganizerRecurrenceRule::daysOfYear () const

* Returns a list of the days of the year that the item should recur on. If not set, this is the * empty list, which signifies that it should be implied, if necessary, by the day-of-year of the * item.

This function was introduced in Qt Mobility 1.1.

See also setDaysOfYear().

Qt::DayOfWeek QOrganizerRecurrenceRule::firstDayOfWeek () const

* Returns the day that the week starts on. If not set, this is Monday.

This function was introduced in Qt Mobility 1.1.

See also setFirstDayOfWeek().

Frequency QOrganizerRecurrenceRule::frequency () const

* Returns the frequency with which the item recurs. The default frequency is Invalid.

This function was introduced in Qt Mobility 1.1.

See also setFrequency().

int QOrganizerRecurrenceRule::interval () const

* Returns the interval of recurrence. The default interval is 1.

This function was introduced in Qt Mobility 1.1.

See also setInterval().

int QOrganizerRecurrenceRule::limitCount () const

Returns the "count" condition specified by the recurrence rule. The default count is -1 (ie. * unlimited)

This function was introduced in Qt Mobility 1.1.

QDate QOrganizerRecurrenceRule::limitDate () const

Returns the end-date condition specified by the recurrence rule. The default end date is the * null date (ie. no end date).

This function was introduced in Qt Mobility 1.1.

LimitType QOrganizerRecurrenceRule::limitType () const

Returns the type of limitation specified by the recurrence rule. The default limit type is NoLimit (ie. * unlimited)

This function was introduced in Qt Mobility 1.1.

QSet<Month> QOrganizerRecurrenceRule::monthsOfYear () const

* Returns a list of the months that the item should recur on. If not set, this is the * empty list, which signifies that it should be implied, if necessary, by the month of the * item.

This function was introduced in Qt Mobility 1.1.

See also setMonthsOfYear().

QSet<int> QOrganizerRecurrenceRule::positions () const

* Returns the position-list of the recurrence rule. If not set, this is the empty list, which * signifies that the recurrence dates should not be restricted by position.

This function was introduced in Qt Mobility 1.1.

See also setPositions().

void QOrganizerRecurrenceRule::setDaysOfMonth ( const QSet<int> & days )

* Sets the days of the month on which the item should recur to days. Negative values in the list * represent the number of days from the end of the month. eg. 1 represents the first day of the * month and -1 represents the last day of the month. * * This corresponds to the BYMONTHDAY fragment in iCalendar's RRULE.

This function was introduced in Qt Mobility 1.1.

See also daysOfMonth().

void QOrganizerRecurrenceRule::setDaysOfWeek ( const QSet<Qt::DayOfWeek> & days )

* Sets the days of week on which the item should recur to days. * * This corresponds to the BYDAY fragment in iCalendar's RRULE.

This function was introduced in Qt Mobility 1.1.

See also daysOfWeek().

void QOrganizerRecurrenceRule::setDaysOfYear ( const QSet<int> & days )

* Sets the days of the year on which the item should recur to days. Negative values in the list * represent the number of days from the end of the year. eg. 1 represents the first day of the * year and -1 represents the last day of the year. * * This corresponds to the BYYEARDAY fragment in iCalendar's RRULE.

This function was introduced in Qt Mobility 1.1.

See also daysOfYear().

void QOrganizerRecurrenceRule::setFirstDayOfWeek ( Qt::DayOfWeek day )

Sets the day that the week starts on to day, for the purposes of calculating recurrences. * This is significant when the frequency is Weekly and the interval is greater than 1, or when * weekOfYear is set. See the iCalendar spec for examples of its significance. * * This corresponds to the BYWKST fragment in iCalendar's RRULE.

This function was introduced in Qt Mobility 1.1.

See also firstDayOfWeek().

void QOrganizerRecurrenceRule::setFrequency ( Frequency freq )

* Sets the frequency with which the item recurs to freq. * * This corresponds to the FREQ fragment in iCalendar's RRULE.

This function was introduced in Qt Mobility 1.1.

See also frequency().

void QOrganizerRecurrenceRule::setInterval ( int interval )

* Sets the interval, between cycles of length given by frequency(), in which the item should recur * to interval. * * For example, if the frequency() is QOrganizerRecurrenceRule::Daily and the interval is set to * 2, the item should recur every second day. * * This corresponds to the INTERVAL fragment in iCalendar's RRULE.

This function was introduced in Qt Mobility 1.1.

See also interval().

void QOrganizerRecurrenceRule::setLimit ( int count )

Sets the "count" condition of the recurrence rule to count. If an end-date was previously * set, it is removed as count and endDate are mutually exclusive. * * The "count" condition is the maximum number of times the item should recur. Calling clearLimit() or setting this * to a negative value removes the count condition. * * This corresponds to the COUNT fragment in iCalendar's RRULE. *

This function was introduced in Qt Mobility 1.1.

See also clearLimit().

void QOrganizerRecurrenceRule::setLimit ( const QDate & date )

Sets the end-date condition of the recurrence rule to date. If a "count" condition was * previously set, it is removed as count and endDate are mutually exclusive. * * The end-date condition is the date after which the item should not recur. Calling clearLimit() or setting this to * the null date removes the end-date condition. * * This corresponds to the UNTIL fragment in iCalendar's RRULE. *

This function was introduced in Qt Mobility 1.1.

See also clearLimit().

void QOrganizerRecurrenceRule::setMonthsOfYear ( const QSet<Month> & months )

* Sets the months on which the item should recur to months. * * This corresponds to the BYMONTHDAY fragment in iCalendar's RRULE.

This function was introduced in Qt Mobility 1.1.

See also monthsOfYear().

void QOrganizerRecurrenceRule::setPositions ( const QSet<int> & pos )

* Sets the list of positions that the item should recur on to pos. This specifies that the item * should only recur on the nth occurrence within the set of events otherwise specified by the rule, * for the values of n in pos. * * Negative values in the list represnet a position counting from the end of the set. * * For example, if frequency() == Monthly and months() is the list Monday, Tuesday, Wednesday, * Thursday, Friday, and positions() == -1, this specifies that the item should recur on the last * weekday of each month. * * This corresponds to the BYSETPOS fragment in iCalendar's RRULE.

This function was introduced in Qt Mobility 1.1.

See also positions().

void QOrganizerRecurrenceRule::setWeeksOfYear ( const QSet<int> & weeks )

* Sets the weeks of the year on which the item should recur to weeks. Negative values in the list * represent the number of weeks from the end of the year. eg. 1 represents the first week of the * year and -1 represents the last week of the year. * * This corresponds to the BYWEEK fragment in iCalendar's RRULE.

This function was introduced in Qt Mobility 1.1.

See also weeksOfYear().

QSet<int> QOrganizerRecurrenceRule::weeksOfYear () const

* Returns a list of the weeks of the year that the item should recur on. If not set, this is the * empty list, which signifies that it should be implied, if necessary, by the week number of the * item.

This function was introduced in Qt Mobility 1.1.

See also setWeeksOfYear().

QOrganizerRecurrenceRule & QOrganizerRecurrenceRule::operator= ( const QOrganizerRecurrenceRule & other )

* Assigns this detail to be equal to other.

This function was introduced in Qt Mobility 1.1.

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

Returns true if this recurrence rule is equal to the other; otherwise returns false.

This function was introduced in Qt Mobility 1.1.