Qt Mobility Reference Documentation

QOrganizerEvent Class Reference

The QOrganizerEvent class provides an event in time which may reoccur More...

 #include <QOrganizerEvent>

Inherits QOrganizerItem.


Public Functions

Q_DECLARE_CUSTOM_ORGANIZER_ITEM ( QOrganizerEvent, QOrganizerItemType::TypeEvent )
QDateTime endDateTime () const
QList<QDate> exceptionDates () const
QList<QOrganizerItemRecurrenceRule> exceptionRules () const
bool isTimeSpecified () const
QString locationAddress () const
QString locationGeoCoordinates () const
QString locationName () const
QOrganizerItemPriority::Priority priority () const
QList<QDate> recurrenceDates () const
QList<QOrganizerItemRecurrenceRule> recurrenceRules () const
void setEndDateTime ( const QDateTime & endDateTime )
void setExceptionDates ( const QList<QDate> & exdates )
void setExceptionRules ( const QList<QOrganizerItemRecurrenceRule> & exrules )
void setLocationAddress ( const QString & locationAddress )
void setLocationGeoCoordinates ( const QString & locationCoordinates ) (preliminary)
void setLocationName ( const QString & locationName )
void setPriority ( QOrganizerItemPriority::Priority priority )
void setRecurrenceDates ( const QList<QDate> & rdates )
void setRecurrenceRules ( const QList<QOrganizerItemRecurrenceRule> & rrules )
void setTimeSpecified ( bool isTimeSpecified )
QDateTime startDateTime () const

Detailed Description

The QOrganizerEvent class provides an event in time which may reoccur

A QOrganizerEvent is an item which occurs at a particular point in time and may be associated with a location or have other details. It may have a set of recurrence rules or dates on which the event occurs associated with it, and also exceptions to those recurrences.


Member Function Documentation

QOrganizerEvent::Q_DECLARE_CUSTOM_ORGANIZER_ITEM ( QOrganizerEvent, QOrganizerItemType::TypeEvent )

QDateTime QOrganizerEvent::endDateTime () const

Returns the date time at which the first instance of the event ends

See also setEndDateTime().

QList<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().

QList<QOrganizerItemRecurrenceRule> QOrganizerEvent::exceptionRules () const

Returns the list of exception rules for the event

See also setExceptionRules().

bool QOrganizerEvent::isTimeSpecified () const

Returns whether the time component of the start datetime or end datetime are significant.

QString QOrganizerEvent::locationAddress () const

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

See also setLocationAddress().

QString QOrganizerEvent::locationGeoCoordinates () const

Returns the geo-coordinates of the location at which the event occurs, if known

See also setLocationGeoCoordinates().

QString QOrganizerEvent::locationName () const

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

See also setLocationName().

QOrganizerItemPriority::Priority QOrganizerEvent::priority () const

Returns the priority of the event

See also setPriority().

QList<QDate> QOrganizerEvent::recurrenceDates () const

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

See also setRecurrenceDates().

QList<QOrganizerItemRecurrenceRule> QOrganizerEvent::recurrenceRules () const

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

See also setRecurrenceRules().

void QOrganizerEvent::setEndDateTime ( const QDateTime & endDateTime )

Sets the end date time of the event to endDateTime

See also endDateTime().

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

Sets the given list of dates exdates to be dates on which the event explicitly does not occur, when the recurrence rules suggest that the event should occur on those dates.

See also exceptionDates().

void QOrganizerEvent::setExceptionRules ( const QList<QOrganizerItemRecurrenceRule> & exrules )

Sets the given list of recurrence rules exrules to be the rules which define when the event does not occur.

See also exceptionRules().

void QOrganizerEvent::setLocationAddress ( const QString & locationAddress )

Sets the address of the location at which the event occurs to locationAddress

See also locationAddress().

void QOrganizerEvent::setLocationGeoCoordinates ( const QString & locationCoordinates )

This function is under development and is subject to change.

Sets the geo-coordinates of the location at which the event occurs to locationCoordinates. The coordinates should be in the format "latitude;longitude"

See also locationGeoCoordinates().

void QOrganizerEvent::setLocationName ( const QString & locationName )

Sets the name of the location at which the event occurs to locationName

See also locationName().

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

Sets the priority of this event to priority

See also priority().

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

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

See also recurrenceDates().

void QOrganizerEvent::setRecurrenceRules ( const QList<QOrganizerItemRecurrenceRule> & 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::setTimeSpecified ( bool isTimeSpecified )

Sets whether the time component of the start datetime or end datetime are significant.

See also isTimeSpecified().

QDateTime QOrganizerEvent::startDateTime () const

Returns the date time at which the first instance of the event starts

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.