libkcal Library API Documentation

KCal::Todo Class Reference

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

#include <todo.h>

Inheritance diagram for KCal::Todo:

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

Public Member Functions

 Todo (const Todo &)
QCString type () const
Incidenceclone ()
 Return an exact copy of this todo.

void setDtDue (const QDateTime &dtDue)
 for setting the todo's due date/time with a QDateTime.

QDateTime dtDue () const
 returns an event's Due date/time as a QDateTime.

QString dtDueTimeStr () const
 returns an event's due time as a string formatted according to the users locale settings

QString dtDueDateStr (bool shortfmt=true) const
 returns an event's due date as a string formatted according to the users locale settings

QString dtDueStr () const
 returns an event's due date and time as a string formatted according to the users locale settings

bool hasDueDate () const
 returns TRUE or FALSE depending on whether the todo has a due date

void setHasDueDate (bool f)
 sets the event's hasDueDate value.

bool hasStartDate () const
 returns TRUE or FALSE depending on whether the todo has a start date

void setHasStartDate (bool f)
 sets the event's hasStartDate value.

bool isCompleted () const
 return, if this todo is completed

void setCompleted (bool)
 set completed state of this todo

int percentComplete () const
 Return how many percent of the task are completed.

void setPercentComplete (int)
 Set how many percent of the task are completed.

QDateTime completed () const
 return date and time when todo was completed

QString completedStr () const
void setCompleted (const QDateTime &completed)
 set date and time of completion

bool hasCompletedDate () const
 Return true, if todo has a date associated with completion.


Detailed Description

This class provides a Todo in the sense of RFC2445.

Definition at line 33 of file todo.h.


Member Function Documentation

Incidence * Todo::clone  )  [virtual]
 

Return an exact copy of this todo.

Implements KCal::Incidence.

Definition at line 54 of file todo.cpp.

void Todo::setDtDue const QDateTime dtDue  ) 
 

for setting the todo's due date/time with a QDateTime.

Definition at line 59 of file todo.cpp.

Referenced by KCal::VCalFormat::VTodoToEvent().

QDateTime Todo::dtDue  )  const
 

returns an event's Due date/time as a QDateTime.

Definition at line 81 of file todo.cpp.

Referenced by KCal::VCalFormat::eventToVTodo(), KCal::Alarm::time(), and KCal::CalendarLocal::todos().

QString Todo::dtDueTimeStr  )  const
 

returns an event's due time as a string formatted according to the users locale settings

Definition at line 86 of file todo.cpp.

References QDateTime::time().

QString Todo::dtDueDateStr bool  shortfmt = true  )  const
 

returns an event's due date as a string formatted according to the users locale settings

Definition at line 91 of file todo.cpp.

References QDateTime::date().

QString Todo::dtDueStr  )  const
 

returns an event's due date and time as a string formatted according to the users locale settings

Definition at line 96 of file todo.cpp.

bool Todo::hasDueDate  )  const
 

returns TRUE or FALSE depending on whether the todo has a due date

Definition at line 101 of file todo.cpp.

Referenced by KCal::VCalFormat::eventToVTodo(), and KCal::CalendarLocal::todos().

void Todo::setHasDueDate bool  f  ) 
 

sets the event's hasDueDate value.

Definition at line 106 of file todo.cpp.

Referenced by KCal::VCalFormat::VTodoToEvent().

bool Todo::hasStartDate  )  const
 

returns TRUE or FALSE depending on whether the todo has a start date

Definition at line 114 of file todo.cpp.

Referenced by KCal::VCalFormat::eventToVTodo().

void Todo::setHasStartDate bool  f  ) 
 

sets the event's hasStartDate value.

Definition at line 119 of file todo.cpp.

Referenced by KCal::VCalFormat::VTodoToEvent().

bool Todo::isCompleted  )  const
 

return, if this todo is completed

Definition at line 200 of file todo.cpp.

Referenced by KCal::VCalFormat::eventToVTodo(), and KCal::CalFilter::filterTodo().

void Todo::setCompleted bool   ) 
 

set completed state of this todo

Definition at line 206 of file todo.cpp.

Referenced by KCal::VCalFormat::VTodoToEvent().

int Todo::percentComplete  )  const
 

Return how many percent of the task are completed.

Returns a value between 0 and 100.

Definition at line 236 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 241 of file todo.cpp.

QDateTime Todo::completed  )  const
 

return date and time when todo was completed

Definition at line 213 of file todo.cpp.

Referenced by KCal::VCalFormat::eventToVTodo().

void Todo::setCompleted const QDateTime completed  ) 
 

set date and time of completion

Definition at line 223 of file todo.cpp.

bool Todo::hasCompletedDate  )  const
 

Return true, if todo has a date associated with completion.

Definition at line 231 of file todo.cpp.

Referenced by KCal::VCalFormat::eventToVTodo().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.5.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Sun Feb 15 11:40:28 2004 by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2001