KCal Library
KCal::Todo Class Reference
Provides a To-do in the sense of RFC2445. More...
#include <todo.h>

Public Types | |
typedef boost::shared_ptr < const Todo > | ConstPtr |
typedef ListBase< Todo > | List |
typedef boost::shared_ptr< Todo > | Ptr |
Public Member Functions | |
Todo (const Todo &other) | |
Todo () | |
~Todo () | |
Todo * | clone () |
KDateTime | completed () const |
QString | completedStr (bool shortfmt=false) const |
KDateTime | dtDue (bool first=false) const |
QString | dtDueDateStr (bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec()) const |
QString | dtDueStr (bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec()) const |
QString | dtDueTimeStr (bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec()) const |
KDateTime | dtRecurrence () const |
KDateTime | dtStart (bool first) const |
virtual KDateTime | dtStart () const |
virtual QString | dtStartDateStr (bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec()) const |
QString | dtStartDateStr (bool shortfmt, bool first, const KDateTime::Spec &spec=KDateTime::Spec()) const |
virtual QString | dtStartStr (bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec()) const |
QString | dtStartStr (bool shortfmt, bool first, const KDateTime::Spec &spec=KDateTime::Spec()) const |
virtual QString | dtStartTimeStr (bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec()) const |
QString | dtStartTimeStr (bool shortfmt, bool first, const KDateTime::Spec &spec=KDateTime::Spec()) const |
bool | hasCompletedDate () const |
bool | hasDueDate () const |
bool | hasStartDate () const |
bool | isCompleted () const |
bool | isInProgress (bool first) const |
bool | isNotStarted (bool first) const |
bool | isOpenEnded () const |
bool | isOverdue () const |
Todo & | operator= (const Todo &other) |
bool | operator== (const Todo &todo) const |
int | percentComplete () const |
virtual bool | recursOn (const QDate &date, const KDateTime::Spec &timeSpec) const |
void | setCompleted (const KDateTime &completeDate) |
void | setCompleted (bool completed) |
void | setDtDue (const KDateTime &dtDue, bool first=false) |
void | setDtRecurrence (const KDateTime &dt) |
void | setDtStart (const KDateTime &dtStart) |
void | setHasDueDate (bool hasDueDate) |
void | setHasStartDate (bool hasStartDate) |
void | setPercentComplete (int percent) |
virtual void | shiftTimes (const KDateTime::Spec &oldSpec, const KDateTime::Spec &newSpec) |
QByteArray | type () const |
Protected Member Functions | |
virtual KDateTime | endDateRecurrenceBase () const |
Detailed Description
Provides a To-do in the sense of RFC2445.
Definition at line 44 of file todo.h.
Member Typedef Documentation
typedef boost::shared_ptr<const Todo> KCal::Todo::ConstPtr |
A shared pointer to a non-mutable Todo object.
Reimplemented from KCal::Incidence.
typedef ListBase<Todo> KCal::Todo::List |
typedef boost::shared_ptr<Todo> KCal::Todo::Ptr |
A shared pointer to a Todo object.
Reimplemented from KCal::Incidence.
Constructor & Destructor Documentation
Todo::Todo | ( | ) |
Todo::Todo | ( | const Todo & | other | ) |
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.
KDateTime Todo::completed | ( | ) | const |
QString Todo::completedStr | ( | bool | shortfmt = false |
) | const |
KDateTime 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.
QString Todo::dtDueDateStr | ( | bool | shortfmt = true , |
|
const KDateTime::Spec & | spec = KDateTime::Spec() | |||
) | const |
Returns due date as string formatted according to the user's locale settings.
- Parameters:
-
shortfmt If set, use short date format; else use long format. spec If set, return the date in the given spec, else use the todo's current spec.
QString Todo::dtDueStr | ( | bool | shortfmt = true , |
|
const KDateTime::Spec & | spec = KDateTime::Spec() | |||
) | const |
Returns due date and time as string formatted according to the user's locale settings.
- Parameters:
-
shortfmt If set, use short date format; else use long format. spec If set, return the date/time in the given spec, else use the todo's current spec.
QString Todo::dtDueTimeStr | ( | bool | shortfmt = true , |
|
const KDateTime::Spec & | spec = KDateTime::Spec() | |||
) | const |
Returns due time as string formatted according to the user's locale settings.
- Parameters:
-
shortfmt If set, use short date format; else use long format. spec If set, return the time in the given spec, else use the todo's current spec.
KDateTime Todo::dtRecurrence | ( | ) | const |
KDateTime Todo::dtStart | ( | bool | first | ) | const |
Returns the start date of the todo.
- Parameters:
-
first If true, the start date of the todo will be returned; also, if the todo recurs, the start date of the first occurrence will be returned. If false and the todo recurs, the relative start date will be returned, based on the date returned by dtRecurrence().
KDateTime Todo::dtStart | ( | ) | const [virtual] |
Returns an incidence's starting date/time as a KDateTime.
- See also:
- setDtStart().
Reimplemented from KCal::IncidenceBase.
QString Todo::dtStartDateStr | ( | bool | shortfmt = true , |
|
const KDateTime::Spec & | spec = KDateTime::Spec() | |||
) | const [virtual] |
Returns an incidence's starting date as a string formatted according to the user's locale settings.
- Parameters:
-
shortfmt If set to true, use short date format, if set to false use long format. spec If set, return the date in the given spec, else use the incidence's current spec.
Reimplemented from KCal::IncidenceBase.
QString Todo::dtStartDateStr | ( | bool | shortfmt, | |
bool | first, | |||
const KDateTime::Spec & | spec = KDateTime::Spec() | |||
) | const |
Returns a todo's starting date as a string formatted according to the user's locale settings.
- Parameters:
-
shortfmt If set, use short date format; else use long format. first If true, the start date of the todo will be returned; also, if the todo recurs, the start date of the first occurrence will be returned. If false and the todo recurs, the relative start date will be returned, based on the date returned by dtRecurrence(). spec If set, returns the date in the given spec, else use the todo's current spec.
QString Todo::dtStartStr | ( | bool | shortfmt = true , |
|
const KDateTime::Spec & | spec = KDateTime::Spec() | |||
) | const [virtual] |
Returns an incidence's starting date and time as a string formatted according to the user's locale settings.
- Parameters:
-
shortfmt If set to true, use short date format, if set to false use long format. spec If set, return the date and time in the given spec, else use the incidence's current spec.
Reimplemented from KCal::IncidenceBase.
QString Todo::dtStartStr | ( | bool | shortfmt, | |
bool | first, | |||
const KDateTime::Spec & | spec = KDateTime::Spec() | |||
) | const |
Returns a todo's starting date and time as a string formatted according to the user's locale settings.
- Parameters:
-
shortfmt If set, use short date format; else use long format. first If true, the start date of the todo will be returned; also, if the todo recurs, the start date of the first occurrence will be returned. If false and the todo recurs, the relative start date will be returned, based on the date returned by dtRecurrence(). spec If set, returns the date and time in the given spec, else use the todo's current spec.
QString Todo::dtStartTimeStr | ( | bool | shortfmt = true , |
|
const KDateTime::Spec & | spec = KDateTime::Spec() | |||
) | const [virtual] |
Returns an incidence's starting time as a string formatted according to the user's locale settings.
- Parameters:
-
shortfmt If set to true, use short date format, if set to false use long format. spec If set, return the time in the given spec, else use the incidence's current spec.
Reimplemented from KCal::IncidenceBase.
QString Todo::dtStartTimeStr | ( | bool | shortfmt, | |
bool | first, | |||
const KDateTime::Spec & | spec = KDateTime::Spec() | |||
) | const |
Returns a todo's starting time as a string formatted according to the user's locale settings.
- Parameters:
-
shortfmt If set, use short date format; else use long format. first If true, the start date of the todo will be returned; also, if the todo recurs, the start date of the first occurrence will be returned. If false and the todo recurs, the relative start date will be returned, based on the date returned by dtRecurrence(). spec If set, returns the time in the given spec, else use the todo's current spec.
KDateTime Todo::endDateRecurrenceBase | ( | ) | const [protected, virtual] |
Returns the end date/time of the base incidence.
Reimplemented from KCal::Incidence.
bool Todo::hasCompletedDate | ( | ) | const |
bool Todo::hasDueDate | ( | ) | const |
bool Todo::hasStartDate | ( | ) | const |
bool Todo::isCompleted | ( | ) | const |
Returns true if the todo is 100% completed, otherwise return false.
- See also:
- isOverdue, isInProgress(), isOpenEnded(), isNotStarted(bool), setCompleted(), 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.
- Parameters:
-
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(), isNotStarted(bool)
- Since:
- 4.4
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.
- Parameters:
-
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(), isOpenEnded()
- Since:
- 4.4
bool Todo::isOpenEnded | ( | ) | const |
Returns true, if the to-do is open-ended (no due date); false otherwise.
- See also:
- isOverdue(), isCompleted(), isInProgress(), isNotStarted(bool)
- Since:
- 4.4
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(), isNotStarted(bool)
bool Todo::operator== | ( | const Todo & | todo | ) | const |
Compare this with todo
for equality.
- Parameters:
-
todo is the to-do to compare.
Reimplemented from KCal::Incidence.
int Todo::percentComplete | ( | ) | const |
bool Todo::recursOn | ( | const QDate & | date, | |
const KDateTime::Spec & | timeSpec | |||
) | const [virtual] |
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.
- Parameters:
-
date is the date to check. timeSpec is the
Reimplemented from KCal::Incidence.
void Todo::setCompleted | ( | const KDateTime & | completeDate | ) |
void Todo::setCompleted | ( | bool | completed | ) |
Sets completed state.
- Parameters:
-
completed If true set completed state to 100%, if false set completed state to 0%.
- See also:
- isCompleted(), percentComplete()
void Todo::setDtDue | ( | const KDateTime & | dtDue, | |
bool | first = false | |||
) |
Sets due date and time.
- Parameters:
-
dtDue The due date/time. 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.
void Todo::setDtRecurrence | ( | const KDateTime & | dt | ) |
void Todo::setDtStart | ( | const KDateTime & | dtStart | ) | [virtual] |
Sets the start date of the todo.
- Parameters:
-
dtStart is the to-do start date.
Reimplemented from KCal::Incidence.
void Todo::setHasDueDate | ( | bool | hasDueDate | ) |
void Todo::setHasStartDate | ( | bool | hasStartDate | ) |
void Todo::setPercentComplete | ( | int | percent | ) |
Sets what percentage of the to-do is completed.
Valid values are in the range from 0 to 100.
- Parameters:
-
percent is the completion percentage, which as integer value between 0 and 100, inclusive.
- See also:
- isCompleted(), setCompleted()
void Todo::shiftTimes | ( | const KDateTime::Spec & | oldSpec, | |
const KDateTime::Spec & | newSpec | |||
) | [virtual] |
Shift the times of the incidence so that they appear at the same clock time as before but in a new time zone. The shift is done from a viewing time zone rather than from the actual incidence time zone.For example, shifting an incidence whose start time is 09:00 America/New York, using an old viewing time zone (oldSpec
) of Europe/London, to a new time zone (newSpec
) of Europe/Paris, will result in the time being shifted from 14:00 (which is the London time of the incidence start) to 14:00 Paris time.
- Parameters:
-
oldSpec the time specification which provides the clock times newSpec the new time specification
Reimplemented from KCal::Incidence.
QByteArray Todo::type | ( | ) | const [virtual] |
Prints the type of Incidence as a string.
Implements KCal::IncidenceBase.
The documentation for this class was generated from the following files: