QOrganizerEvent Class Reference

Member Function Documentation

QDateTime QOrganizerEvent::endDateTime () const

Returns the date time at which the event ends (for recurring events, this applies to the first instance). For all-day events, the time part is meaningless, and the date is to be interpreted as the inclusive end date.

See also setEndDateTime().

QSet<QDate> QOrganizerEvent::exceptionDates () const

Returns the list of dates on which the event explicitly does not occur despite the recurrence rules for the event

See also setExceptionDates().

QOrganizerRecurrenceRule QOrganizerEvent::exceptionRule () const

Returns an exception rule which has been explicitly set for the event. Note: if more than one exception rule exists, the order of the rules is undefined, so any one could be returned.

See also setExceptionRule().

QSet<QOrganizerRecurrenceRule> QOrganizerEvent::exceptionRules () const

Returns the list of exception rules for the event

See also setExceptionRules().

bool QOrganizerEvent::isAllDay () const

Returns true if and only if the time component of the start date/time or end date/time are insignificant.

QString QOrganizerEvent::location () const

Returns the label of the location at which the event occurs, if known

See also setLocation().

QOrganizerItemPriority::Priority QOrganizerEvent::priority () const

Returns the priority of the event

See also setPriority().

QSet<QDate> QOrganizerEvent::recurrenceDates () const

Returns the list of dates which have been explicitly set as dates on which the event occurs

See also setRecurrenceDates().

QOrganizerRecurrenceRule QOrganizerEvent::recurrenceRule () const

Returns a recurrence rule which has been explicitly set for the event. Note: if more than one rule exists, the order of the rules is undefined, so any one could be returned.

See also setRecurrenceRule().

QSet<QOrganizerRecurrenceRule> QOrganizerEvent::recurrenceRules () const

Returns the list of recurrence rules which define when the event occurs

See also setRecurrenceRules().

void QOrganizerEvent::setAllDay ( bool isAllDay )

Sets whether the time-of-day component of the event's start date-time or end date-time is insignificant (eg. this is generally set to true for a birthday). If isAllDay is true, the time-of-day component is considered insignificant, and the event will be an all-day item.

See also isAllDay().

void QOrganizerEvent::setEndDateTime ( const QDateTime & endDateTime )

Sets the end date time of the event to endDateTime (for recurring events, this applies to the first instance). For all-day events, the time part can be set to any valid value, and the date is to be interpreted as the inclusive end date.

See also endDateTime().

void QOrganizerEvent::setExceptionDates ( const QSet<QDate> & exdates )

Sets the given list of dates exdates to be dates on which the event explicitly does not occur, even if the recurrence rules suggest that the event should occur on those dates. Any previously specified exception dates will be cleared when this function is called.

See also exceptionDates().

void QOrganizerEvent::setExceptionRule ( const QOrganizerRecurrenceRule & xrule )

Sets the given single recurrence rules xrule to be the rule which defines when the event does not occur. Any previously specified exception rules will be cleared when this function is called.

See also exceptionRule() and setExceptionRules().

void QOrganizerEvent::setExceptionRules ( const QSet<QOrganizerRecurrenceRule> & exrules )

Sets the given list of recurrence rules exrules to be the rules which define when the event does not occur. Any previously specified exception rules will be cleared when this function is called.

See also exceptionRules().

void QOrganizerEvent::setLocation ( const QString & location )

Sets the label of the location at which the event occurs to location

See also location().

void QOrganizerEvent::setPriority ( QOrganizerItemPriority::Priority priority )

Sets the priority of this event to priority

See also priority().

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

Sets the list of dates rdates to be dates on which the event occurs

See also recurrenceDates().

void QOrganizerEvent::setRecurrenceRule ( const QOrganizerRecurrenceRule & rrule )

Sets a single recurrence rule rrule to be the rule which define when the event occurs, other than those dates specified explicitly via setRecurrenceDates().

See also recurrenceRule() and setRecurrenceRules().

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

Sets the list of recurrence rules rrules to be the rules which define when the event occurs, other than those dates specified explicitly via setRecurrenceDates().

See also recurrenceRules().

void QOrganizerEvent::setStartDateTime ( const QDateTime & startDateTime )

Sets the start date time of the event to startDateTime (for recurring events, this applies to the first instance). For all-day events, the time part can be set to any valid value.

See also startDateTime().

QDateTime QOrganizerEvent::startDateTime () const

Returns the date time at which the event starts (for recurring events, this applies to the first instance). For all-day events, the time part is meaningless.

See also setStartDateTime().