libkcal

KCal::Todo Class Reference

#include <todo.h>

Inheritance diagram for KCal::Todo:

KCal::Incidence KCal::IncidenceBase KCal::CustomProperties List of all members.

Detailed Description

This class provides a Todo in the sense of RFC2445.

Definition at line 31 of file todo.h.


Public Types

typedef ListBase< TodoList

Public Member Functions

 Todo (const Todo &)
bool operator== (const Todo &) const
QCString type () const
Todoclone ()
void setDtDue (const QDateTime &dtDue, bool first=false)
QDateTime dtDue (bool first=false) const
QString dtDueTimeStr () const
QString dtDueDateStr (bool shortfmt=true) const
QString dtDueStr () const
bool hasDueDate () const
void setHasDueDate (bool hasDueDate)
bool hasStartDate () const
void setHasStartDate (bool hasStartDate)
QDateTime dtStart (bool first=false) const
void setDtStart (const QDateTime &dtStart)
QString dtStartTimeStr (bool first=false) const
QString dtStartDateStr (bool shortfmt=true, bool first=false) const
QString dtStartStr (bool first=false) const
bool isCompleted () const
void setCompleted (bool completed)
int percentComplete () const
void setPercentComplete (int)
QDateTime completed () const
QString completedStr () const
void setCompleted (const QDateTime &completed)
bool hasCompletedDate () const
void setDtRecurrence (const QDateTime &dt)
QDateTime dtRecurrence () const
virtual bool recursOn (const QDate &date) const
bool isOverdue () const

Protected Member Functions

virtual QDateTime endDateRecurrenceBase () const

Member Function Documentation

Todo * Todo::clone  )  [virtual]
 

Returns an exact copy of this todo.

The returned object is owned by the caller.

Implements KCal::Incidence.

Definition at line 54 of file todo.cpp.

QDateTime Todo::completed  )  const
 

Returns date and time when todo was completed.

Definition at line 211 of file todo.cpp.

QString Todo::completedStr  )  const
 

Returns string contaiting date and time when the todo was completed formatted according to the users locale settings.

Definition at line 219 of file todo.cpp.

QDateTime Todo::dtDue bool  first = false  )  const
 

Returns due date and time.

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

Definition at line 104 of file todo.cpp.

QString Todo::dtDueDateStr bool  shortfmt = true  )  const
 

Returns due date as string formatted according to the users locale settings.

Parameters:
shortfmt If set to true, use short date format, if set to false use long format.

Definition at line 117 of file todo.cpp.

QString Todo::dtDueStr  )  const
 

Returns due date and time as string formatted according to the users locale settings.

Definition at line 122 of file todo.cpp.

QString Todo::dtDueTimeStr  )  const
 

Returns due time as string formatted according to the users locale settings.

Definition at line 112 of file todo.cpp.

QDateTime Todo::dtRecurrence  )  const
 

Returns the due date/time of the current occurrence if recurrent.

Definition at line 256 of file todo.cpp.

QDateTime Todo::dtStart bool  first = false  )  const
 

Returns the startdate of the todo.

Parameters:
first If true, the startdate of the todo will be returned. If the todo recurs, the startdate of the first occurrence will be returned. If false and the todo recurs, the relative startdate will be returned, based on the date returned by dtRecurrence().

Definition at line 160 of file todo.cpp.

QString Todo::dtStartDateStr bool  shortfmt = true,
bool  first = false
const
 

Returns an todo's starting date as a string formatted according to the users locale settings.

Parameters:
shortfmt If true, use short date format, if set to false use long format.
first If true, the startdate of the todo will be returned. If the todo recurs, the startdate of the first occurrence will be returned. If false and the todo recurs, the relative startdate will be returned, based on the date returned by dtRecurrence().

Definition at line 183 of file todo.cpp.

QString Todo::dtStartStr bool  first = false  )  const
 

Returns an todo's starting date and time as a string formatted according to the users locale settings.

Parameters:
first If true, the startdate of the todo will be returned. If the todo recurs, the startdate of the first occurrence will be returned. If false and the todo recurs, the relative startdate will be returned, based on the date returned by dtRecurrence().

Definition at line 188 of file todo.cpp.

QString Todo::dtStartTimeStr bool  first = false  )  const
 

Returns an todo's starting time as a string formatted according to the users locale settings.

Parameters:
first If true, the startdate of the todo will be returned. If the todo recurs, the startdate of the first occurrence will be returned. If false and the todo recurs, the relative startdate will be returned, based on the date returned by dtRecurrence().

Definition at line 178 of file todo.cpp.

virtual QDateTime KCal::Todo::endDateRecurrenceBase  )  const [inline, protected, virtual]
 

Return the end date/time of the base incidence.

Reimplemented from KCal::Incidence.

Definition at line 216 of file todo.h.

bool Todo::hasCompletedDate  )  const
 

Returns true, if todo has a date associated with completion, otherwise return false.

Definition at line 234 of file todo.cpp.

bool Todo::hasDueDate  )  const
 

Returns true if the todo has a due date, otherwise return false.

Definition at line 127 of file todo.cpp.

bool Todo::hasStartDate  )  const
 

Returns true if the todo has a start date, otherwise return false.

Definition at line 140 of file todo.cpp.

bool Todo::isCompleted  )  const
 

Returns true if the todo is 100% completed, otherwise return false.

Definition at line 193 of file todo.cpp.

bool Todo::isOverdue  )  const
 

Returns true if this todo is overdue (e.g.

due date is lower than today and not completed), else false.

Definition at line 293 of file todo.cpp.

int Todo::percentComplete  )  const
 

Returns how many percent of the task are completed.

Returns a value between 0 and 100.

Definition at line 239 of file todo.cpp.

bool Todo::recursOn const QDate &  date  )  const [virtual]
 

Returns true if the date specified is one on which the todo will recur.

Todo's are a special case, hence the overload. It adds an extra check, which make it return false if there's an occurrence between the recurstart and today.

Reimplemented from KCal::Incidence.

Definition at line 261 of file todo.cpp.

void Todo::setCompleted const QDateTime &  completed  ) 
 

Set date and time of completion.

Definition at line 224 of file todo.cpp.

void Todo::setCompleted bool  completed  ) 
 

Set completed state.

Parameters:
completed If true set completed state to 100%, if false set completed state to 0%.

Definition at line 199 of file todo.cpp.

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

Sets due date and time.

Parameters:
dtDue The due date/time.
first Set the date of the first occurrence (if the todo is recurrent).

Definition at line 72 of file todo.cpp.

void Todo::setDtRecurrence const QDateTime &  dt  ) 
 

Sets the due date/time of the current occurrence if recurrent.

Definition at line 251 of file todo.cpp.

void Todo::setDtStart const QDateTime &  dtStart  )  [virtual]
 

Sets the startdate of the todo.

Reimplemented from KCal::Incidence.

Definition at line 168 of file todo.cpp.

void Todo::setHasDueDate bool  hasDueDate  ) 
 

Set if the todo has a due date.

Parameters:
hasDueDate true if todo has a due date, otherwise false

Definition at line 132 of file todo.cpp.

void Todo::setHasStartDate bool  hasStartDate  ) 
 

Set if the todo has a start date.

Parameters:
hasStartDate true if todo has a start date, otherwise false

Definition at line 145 of file todo.cpp.

void Todo::setPercentComplete int   ) 
 

Set how many percent of the task are completed.

Valid values are in the range from 0 to 100.

Definition at line 244 of file todo.cpp.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys