QOrganizerTodoOccurrence Class

The QOrganizerTodoOccurrence class provides an occurrence of a task which should be completed More...

Header: #include <QOrganizerTodoOccurrence>
Inherits: QOrganizerItem.

Public Functions

Q_DECLARE_CUSTOM_ORGANIZER_ITEM(QOrganizerTodoOccurrence, QOrganizerItemType::TypeTodoOccurrence)
QDateTime dueDateTime() const
QDateTime finishedDateTime() const
QDate originalDate() const
QOrganizerItemId parentId() const
QOrganizerItemPriority::Priority priority() const
int progressPercentage() const
void setDueDateTime(const QDateTime & dueDateTime)
void setFinishedDateTime(const QDateTime & finishedDateTime)
void setOriginalDate(const QDate & date)
void setParentId(const QOrganizerItemId & parentId)
void setPriority(QOrganizerItemPriority::Priority priority)
void setProgressPercentage(int percentage)
void setStatus(QOrganizerTodoProgress::Status status)
QDateTime startDateTime() const
QOrganizerTodoProgress::Status status() const

Detailed Description

The QOrganizerTodoOccurrence class provides an occurrence of a task which should be completed

A todo occurrence is a specific instance of a todo item. An occurrence which is retrieved from a manager may not actually be persisted in that manager (for example, it may be generated automatically from the recurrence rule of the parent todo stored in the manager), in which case it will have a zero-id and differ from the parent todo only in its start date. Alternatively, it may be persisted in the manager (that is, the client has saved the occurrence previously) where it is stored as an exception to its parent todo.

Member Function Documentation

QOrganizerTodoOccurrence::Q_DECLARE_CUSTOM_ORGANIZER_ITEM(QOrganizerTodoOccurrence, QOrganizerItemType::TypeTodoOccurrence)

QDateTime QOrganizerTodoOccurrence::dueDateTime() const

Returns the date time by which the task should be completed. For all-day tasks, the time part is meaningless.

See also setDueDateTime().

QDateTime QOrganizerTodoOccurrence::finishedDateTime() const

Returns the date and time at which the task described by the todo occurrence was completed.

See also setFinishedDateTime().

QDate QOrganizerTodoOccurrence::originalDate() const

Returns the date at which the occurrence was originally going to occur.

See also setOriginalDate().

QOrganizerItemId QOrganizerTodoOccurrence::parentId() const

Returns the id of the todo which is this occurrence's parent.

See also setParentId().

QOrganizerItemPriority::Priority QOrganizerTodoOccurrence::priority() const

Returns the priority of the todo occurrence..

See also setPriority().

int QOrganizerTodoOccurrence::progressPercentage() const

Returns the percentage of progress completed on the task described by the todo occurrence.

See also setProgressPercentage().

void QOrganizerTodoOccurrence::setDueDateTime(const QDateTime & dueDateTime)

Sets the date time by which the task should be completed to dueDateTime. For all-day tasks, the time part can be set to any valid value.

See also dueDateTime().

void QOrganizerTodoOccurrence::setFinishedDateTime(const QDateTime & finishedDateTime)

Sets the date and time at which the task described by the todo occurrence was completed to finishedDateTime.

See also finishedDateTime().

void QOrganizerTodoOccurrence::setOriginalDate(const QDate & date)

Sets the date at which this occurrence was originally going to occur, to the given date.

See also originalDate().

void QOrganizerTodoOccurrence::setParentId(const QOrganizerItemId & parentId)

Sets the todo occurrence's parent to be the todo identified by the given parentId.

See also parentId().

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

Sets the priority of the todo occurrence to priority.

See also priority().

void QOrganizerTodoOccurrence::setProgressPercentage(int percentage)

Sets the percentage of progress completed on the task described by the todo occurrence item to percentage. Note that the given percentage must be between 0 and 100, otherwise ignored.

See also progressPercentage().

void QOrganizerTodoOccurrence::setStatus(QOrganizerTodoProgress::Status status)

Sets the progress status of the todo occurrence to status.

See also status().

QDateTime QOrganizerTodoOccurrence::startDateTime() const

Returns the date time at which the task should be started. For all-day tasks, the time part is meaningless.

QOrganizerTodoProgress::Status QOrganizerTodoOccurrence::status() const

Returns the progress status of the task described by the todo occurrence.

See also setStatus().