QtMobility Reference Documentation

QOrganizerTodo Class Reference

The QOrganizerTodo class provides a task which should be completed More...

 #include <QOrganizerTodo>

Inherits: QOrganizerItem.

This class was introduced in Qt Mobility 1.1.

Public Functions

QDateTime dueDateTime () const
QSet<QDate> exceptionDates () const
QOrganizerRecurrenceRule exceptionRule () const
QSet<QOrganizerRecurrenceRule> exceptionRules () const
QDateTime finishedDateTime () const
bool isAllDay () const
QOrganizerItemPriority::Priority priority () const
int progressPercentage () const
QSet<QDate> recurrenceDates () const
QOrganizerRecurrenceRule recurrenceRule () const
QSet<QOrganizerRecurrenceRule> recurrenceRules () const
void setAllDay ( bool isAllDay )
void setDueDateTime ( const QDateTime & dueDateTime )
void setExceptionDates ( const QSet<QDate> & exdates )
void setExceptionRule ( const QOrganizerRecurrenceRule & exrule )
void setExceptionRules ( const QSet<QOrganizerRecurrenceRule> & exrules )
void setFinishedDateTime ( const QDateTime & finishedDateTime )
void setPriority ( QOrganizerItemPriority::Priority priority )
void setProgressPercentage ( int percentage )
void setRecurrenceDates ( const QSet<QDate> & rdates )
void setRecurrenceRule ( const QOrganizerRecurrenceRule & rrule )
void setRecurrenceRules ( const QSet<QOrganizerRecurrenceRule> & rrules )
void setStartDateTime ( const QDateTime & startDateTime )
void setStatus ( QOrganizerTodoProgress::Status status )
QDateTime startDateTime () const
QOrganizerTodoProgress::Status status () const

Detailed Description

The QOrganizerTodo class provides a task which should be completed

A todo is an item which contains information about a task which has to be completed. It might be associated with a particular point in time (for example, water the garden tomorrow evening) or it might have no specific temporal association (for example, climb Mount Everest someday).

A todo can reoccur (for example, water the garden every evening) or it can occur only once.

Todos can be used to schedule agenda items or tasks in a meaningful manner.

Member Function Documentation

QDateTime QOrganizerTodo::dueDateTime () const

Returns the date time by which the task should be completed (for recurring tasks, this applies to the first instance). For all-day tasks, the time part is meaningless.

This function was introduced in Qt Mobility 1.1.

See also setDueDateTime().

QSet<QDate> QOrganizerTodo::exceptionDates () const

Returns the dates on which the todo does not occur, where it otherwise would occur as described by the recurrence rules.

This function was introduced in Qt Mobility 1.1.

See also setExceptionDates().

QOrganizerRecurrenceRule QOrganizerTodo::exceptionRule () const

Returns a recurrence rule which describe the dates on which the todo does not occur, where it otherwise would occur as described by the recurrence rules. If more than one exception rule was set for the todo item, one of those exception rules will be returned at random.

This function was introduced in Qt Mobility 1.1.

See also setExceptionRule().

QSet<QOrganizerRecurrenceRule> QOrganizerTodo::exceptionRules () const

Returns the recurrence rules which describe the dates on which the todo does not occur, where it otherwise would occur as described by the recurrence rules set the setRecurrenceRules().

This function was introduced in Qt Mobility 1.1.

See also setExceptionRules().

QDateTime QOrganizerTodo::finishedDateTime () const

Returns the date and time at which the task was completed, if known.

This function was introduced in Qt Mobility 1.1.

See also setFinishedDateTime().

bool QOrganizerTodo::isAllDay () const

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

This function was introduced in Qt Mobility 1.1.

QOrganizerItemPriority::Priority QOrganizerTodo::priority () const

Returns the priority of the task.

This function was introduced in Qt Mobility 1.1.

See also setPriority().

int QOrganizerTodo::progressPercentage () const

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

This function was introduced in Qt Mobility 1.1.

See also setProgressPercentage().

QSet<QDate> QOrganizerTodo::recurrenceDates () const

Returns the dates on which the todo reoccurs, which have been explicitly set by calling setRecurrenceDates()

This function was introduced in Qt Mobility 1.1.

See also setRecurrenceDates().

QOrganizerRecurrenceRule QOrganizerTodo::recurrenceRule () const

Returns a recurrence rule which defines when the todo occurs. If more than one recurrence rule has been set in the todo, one will be returned at random.

This function was introduced in Qt Mobility 1.1.

See also setRecurrenceRule().

QSet<QOrganizerRecurrenceRule> QOrganizerTodo::recurrenceRules () const

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

This function was introduced in Qt Mobility 1.1.

See also setRecurrenceRules().

void QOrganizerTodo::setAllDay ( bool isAllDay )

Sets whether the time-of-day component of the todo'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 todo will be an all-day item.

This function was introduced in Qt Mobility 1.1.

See also isAllDay().

void QOrganizerTodo::setDueDateTime ( const QDateTime & dueDateTime )

Sets the date time by which the task should be completed to dueDateTime (for recurring tasks, this applies to the first instance). For all-day tasks, the time part can be set to any valid value

This function was introduced in Qt Mobility 1.1.

See also dueDateTime().

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

Sets the dates on which the todo does not occur despite the date fulfilling the recurrence rules of the todo, to exdates

This function was introduced in Qt Mobility 1.1.

See also exceptionDates().

void QOrganizerTodo::setExceptionRule ( const QOrganizerRecurrenceRule & exrule )

Clears the set of recurrence rules which describe the dates on which the todo does not occur, where it otherwise would occur as described by the recurrence rules, and inserts into the cleared list the single exception rule exrule.

This function was introduced in Qt Mobility 1.1.

See also exceptionRule().

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

Sets the recurrence rules which describe the dates on which the todo does not occur, where it otherwise would occur as described by the recurrence rules set with setRecurrenceRules(), to exrules

This function was introduced in Qt Mobility 1.1.

See also exceptionRules().

void QOrganizerTodo::setFinishedDateTime ( const QDateTime & finishedDateTime )

Sets the date and time at which the task was completed to finishedDateTime

This function was introduced in Qt Mobility 1.1.

See also finishedDateTime().

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

Sets the priority of the todo to priority

This function was introduced in Qt Mobility 1.1.

See also priority().

void QOrganizerTodo::setProgressPercentage ( int percentage )

Sets the percentage of progress completed on the task described by the todo item to percentage

This function was introduced in Qt Mobility 1.1.

See also progressPercentage().

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

Sets the dates on which the todo reoccurs to rdates

This function was introduced in Qt Mobility 1.1.

See also recurrenceDates().

void QOrganizerTodo::setRecurrenceRule ( const QOrganizerRecurrenceRule & rrule )

Clears the set of recurrence rules which define when the todo occurs, and replaces it will the single recurrence rule rrule.

This function was introduced in Qt Mobility 1.1.

See also recurrenceRule().

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

Sets the recurrence rules which define when the todo occurs to rrules

This function was introduced in Qt Mobility 1.1.

See also recurrenceRules().

void QOrganizerTodo::setStartDateTime ( const QDateTime & startDateTime )

Sets the date time at which the task should be started to startDateTime (for recurring tasks, this applies to the first instance). For all-day tasks, the time part can be set to any valid value.

This function was introduced in Qt Mobility 1.1.

See also startDateTime().

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

Sets the progress status of the task to status

This function was introduced in Qt Mobility 1.1.

See also status().

QDateTime QOrganizerTodo::startDateTime () const

Returns the date time at which the task should be started (for recurring tasks, this applies to the first instance). For all-day tasks, the time part is meaningless.

This function was introduced in Qt Mobility 1.1.

See also setStartDateTime().

QOrganizerTodoProgress::Status QOrganizerTodo::status () const

Returns the progress status of the task described by the todo

This function was introduced in Qt Mobility 1.1.

See also setStatus().

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.