KDE PIM / Developers / API Docs / libkcal
KCal::Todo

KCal::Todo Class Reference

This class provides a Todo in the sense of RFC2445. More...

#include <todo.h>

Inherits KCal::Incidence.

List of all members.

Public Types

Public Member Functions

Detailed Description

This class provides a Todo in the sense of RFC2445.

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.

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 occurence (if the todo is recurrent).

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 occurence will be returned.If false and recurrent, the date of the current occurence will be returned. If non-recurrent, the normal due date will be returned.

QString Todo::dtDueTimeStr (   )  const
 

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

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.

QString Todo::dtDueStr (   )  const
 

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

bool Todo::hasDueDate (   )  const
 

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

void Todo::setHasDueDate (  bool  hasDueDate  ) 
 

Set if the todo has a due date.

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

bool Todo::hasStartDate (   )  const
 

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

void Todo::setHasStartDate (  bool  hasStartDate  ) 
 

Set if the todo has a start date.

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

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 occurence will be returned. If false and the todo recurs, the relative startdate will be returned, based on the date returned by dtRecurrence().

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

Sets the startdate of the todo.

Reimplemented from KCal::Incidence.

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 occurence will be returned. If false and the todo recurs, the relative startdate will be returned, based on the date returned by dtRecurrence().

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 occurence will be returned. If false and the todo recurs, the relative startdate will be returned, based on the date returned by dtRecurrence().

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 occurence will be returned. If false and the todo recurs, the relative startdate will be returned, based on the date returned by dtRecurrence().

bool Todo::isCompleted (   )  const
 

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

void Todo::setCompleted (  bool  completed  ) 
 

Set completed state.

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

int Todo::percentComplete (   )  const
 

Returns how many percent of the task are completed.

Returns a value between 0 and 100.

void Todo::setPercentComplete (  int   ) 
 

Set how many percent of the task are completed.

Valid values are in the range from 0 to 100.

QDateTime Todo::completed (   )  const
 

Returns date and time when todo was completed.

QString Todo::completedStr (   )  const
 

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

void Todo::setCompleted (  const QDateTime &  completed  ) 
 

Set date and time of completion.

bool Todo::hasCompletedDate (   )  const
 

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

void Todo::setDtRecurrence (  const QDateTime &  dt  ) 
 

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

QDateTime Todo::dtRecurrence (   )  const
 

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

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 occurence between the recurstart and today.

Reimplemented from KCal::Incidence.

bool Todo::isOverdue (   )  const
 

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

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

The documentation for this class was generated from the following files: