KCalendarCore::Todo Class

Member Function Documentation

Todo::Todo()

Constructs an empty to-do.

[since 4.14] Todo::Todo(const KCalendarCore::Incidence &other)

Costructs a todo out of an incidence This constructs allows to make it easy to create a todo from an event.

other is the incidence to copy.

This function was introduced in 4.14.

Todo::Todo(const KCalendarCore::Todo &other)

Copy constructor.

other is the to-do to copy.

[override virtual noexcept] Todo::~Todo()

Destroys a to-do.

[override virtual protected] KCalendarCore::IncidenceBase &Todo::assign(const KCalendarCore::IncidenceBase &other)

Reimplements: Incidence::assign(const KCalendarCore::IncidenceBase &other).

[override virtual] KCalendarCore::Todo *Todo::clone() const

Reimplements: Incidence::clone() const.

Returns an exact copy of this todo. The returned object is owned by the caller. Returns A pointer to a Todo containing an exact copy of this object.

QDateTime Todo::completed() const

Returns the to-do was completion datetime.

Returns A QDateTime for the completion datetime of the to-do.

See also setCompleted() and hasCompletedDate().

[override virtual] QDateTime Todo::dateTime(KCalendarCore::IncidenceBase::DateTimeRole role) const

Reimplements: IncidenceBase::dateTime(KCalendarCore::IncidenceBase::DateTimeRole role) const.

See also setDateTime().

QDateTime Todo::dtDue(bool first = false) const

Returns the todo due datetime.

first If true and the todo recurs, the due datetime of the first occurrence will be returned. If false and recurrent, the datetime of the current occurrence will be returned. If non-recurrent, the normal due datetime will be returned.

Returns A QDateTime containing the todo due datetime.

See also setDtDue().

QDateTime Todo::dtRecurrence() const

Returns an identifier for the earliest uncompleted occurrence of a recurring Todo.

See also setDtRecurrence().

[override virtual] QDateTime Todo::dtStart() const

Reimplements: IncidenceBase::dtStart() const.

QDateTime Todo::dtStart(bool first) const

Returns the start datetime of the todo.

first If true, the start datetime of the todo will be returned; also, if the todo recurs, the start datetime of the first occurrence will be returned. If false and the todo recurs, the relative start datetime will be returned, based on the datetime returned by dtRecurrence().

Returns A QDateTime for the start datetime of the todo.

[override virtual protected] bool Todo::equals(const KCalendarCore::IncidenceBase &todo) const

Reimplements: Incidence::equals(const KCalendarCore::IncidenceBase &incidence) const.

Compare this with todo for equality.

todo is the to-do to compare.

Returns true if todo is equal to this object, or false if they are different.

bool Todo::hasCompletedDate() const

Returns if the to-do has a completion datetime.

Returns true if the to-do has a date associated with completion; false otherwise.

See also setCompleted() and completed().

bool Todo::hasDueDate() const

Returns if the todo has a due datetime. Returns true if the todo has a due datetime; false otherwise.

bool Todo::hasStartDate() const

Returns if the todo has a start datetime. Returns true if the todo has a start datetime; false otherwise.

[override virtual] QLatin1String Todo::iconName(const QDateTime &recurrenceId = {}) const

Reimplements: Incidence::iconName(const QDateTime &recurrenceId) const.

bool Todo::isCompleted() const

Returns whether the todo is completed or not. Returns true if the todo is 100% completed, has status StatusCompleted, or has a completed date; false otherwise.

See also isOverdue, isInProgress(), isOpenEnded(), isNotStarted(bool), setCompleted(), and percentComplete().

bool Todo::isInProgress(bool first) const

Returns true, if the to-do is in-progress (started, or >0% completed); otherwise return false. If the to-do is overdue, then it is not considered to be in-progress.

first If true, the start and due dates of the todo will be used; also, if the todo recurs, the start date and due date of the first occurrence will be used. If false and the todo recurs, the relative start and due dates will be used, based on the date returned by dtRecurrence().

See also isOverdue(), isCompleted(), isOpenEnded(), and isNotStarted(bool).

bool Todo::isNotStarted(bool first) const

Returns true, if the to-do has yet to be started (no start date and 0% completed); otherwise return false.

first If true, the start date of the todo will be used; also, if the todo recurs, the start date of the first occurrence will be used. If false and the todo recurs, the relative start date will be used, based on the date returned by dtRecurrence().

See also isOverdue(), isCompleted(), isInProgress(), and isOpenEnded().

bool Todo::isOpenEnded() const

Returns true, if the to-do is open-ended (no due date); false otherwise.

See also isOverdue(), isCompleted(), isInProgress(), and isNotStarted(bool).

bool Todo::isOverdue() const

Returns true if this todo is overdue (e.g. due date is lower than today and not completed), else false.

See also isCompleted(), isInProgress(), isOpenEnded(), and isNotStarted(bool).

[override virtual] QLatin1String Todo::mimeType() const

Reimplements: IncidenceBase::mimeType() const.

int Todo::percentComplete() const

Returns what percentage of the to-do is completed. Returns The percentage complete of the to-do as an integer between 0 and 100, inclusive.

See also setPercentComplete() and isCompleted().

[override virtual] bool Todo::recursOn(const QDate &date, const QTimeZone &timeZone) const

Reimplements: Incidence::recursOn(const QDate &date, const QTimeZone &timeZone) const.

Returns true if the date specified is one on which the to-do will recur. Todos are a special case, hence the overload. It adds an extra check, which make it return false if there's an occurrence between the recur start and today.

date is the date to check. timeZone is the time zone

[override virtual] void Todo::setAllDay(bool allDay)

Reimplements: Incidence::setAllDay(bool allDay).

void Todo::setCompleted(bool completed)

Sets completion percentage and status.

completed If true, percentage complete is set to 100%, and status is set to StatusCompleted; the completion date is not set or cleared. If false, percentage complete is set to 0%, status is set to StatusNone, and the completion date is cleared.

See also completed(), isCompleted(), percentComplete(), and hasCompletedDate().

void Todo::setCompleted(const QDateTime &completeDate)

Marks this Todo, or its current recurrence, as completed.

If the todo does not recur, its completion percentage is set to 100%, and its completion date is set to completeDate. If its status is not StatusNone, it is set to StatusCompleted.

If the todo recurs, the first incomplete recurrence is marked complete.

completeDate is the to-do completion date.

See also completed() and hasCompletedDate().

[override virtual] void Todo::setDateTime(const QDateTime &dateTime, KCalendarCore::IncidenceBase::DateTimeRole role)

Reimplements: IncidenceBase::setDateTime(const QDateTime &dateTime, KCalendarCore::IncidenceBase::DateTimeRole role).

See also dateTime().

void Todo::setDtDue(const QDateTime &dtDue, bool first = false)

Sets due date and time.

dtDue The due date/time.

first If true and the todo recurs, the due date of the first occurrence will be set. If false and the todo recurs, the occurrence at that date/time becomes the current occurrence. If the todo does not recur, the due date of the todo will be set.

See also dtDue().

void Todo::setDtRecurrence(const QDateTime &dt)

Identify the earliest uncompleted occurrence of a recurring Todo.

dt Normally, the start date-time of the occurrence. For backwards compatibility, if the Todo does not have a dtStart() then pass the occurrence's due date-time.

See also dtRecurrence().

void Todo::setPercentComplete(int percent)

Sets what percentage of the to-do is completed.

To prevent inconsistency, if percent is not 100, completed() is cleared, and if status() is StatusCompleted it is reset to StatusNone.

percent is the completion percentage. Values greater than 100 are treated as 100; values less than p are treated as 0.

See also percentComplete(), isCompleted(), and setCompleted().

[override virtual] void Todo::shiftTimes(const QTimeZone &oldZone, const QTimeZone &newZone)

Reimplements: Incidence::shiftTimes(const QTimeZone &oldZone, const QTimeZone &newZone).

[override virtual] bool Todo::supportsGroupwareCommunication() const

Reimplements: Incidence::supportsGroupwareCommunication() const.

[static] QLatin1String Todo::todoMimeType()

Returns the Akonadi specific sub MIME type of a KCalendarCore::Todo.

[override virtual] KCalendarCore::IncidenceBase::IncidenceType Todo::type() const

Reimplements: IncidenceBase::type() const.

[override virtual] QByteArray Todo::typeStr() const

Reimplements: IncidenceBase::typeStr() const.

[override virtual protected] void Todo::virtual_hook(KCalendarCore::IncidenceBase::VirtualHook id, void *data)

Reimplements: IncidenceBase::virtual_hook(KCalendarCore::IncidenceBase::VirtualHook id, void *data).