#include <todo.h>

Public Types | |
typedef QVector< Ptr > | List |
typedef QSharedPointer< Todo > | Ptr |
Public Member Functions | |
Todo () | |
Todo (const Todo &other) | |
~Todo () | |
Todo * | clone () const |
KDateTime | completed () const |
KDateTime | dateTime (DateTimeRole role) const |
KDateTime | dtDue (bool first=false) const |
KDateTime | dtRecurrence () const |
virtual KDateTime | dtStart () const |
KDateTime | dtStart (bool first) const |
bool | hasCompletedDate () const |
bool | hasDueDate () const |
bool | hasStartDate () const |
QLatin1String | iconName (const KDateTime &recurrenceId=KDateTime()) const |
bool | isCompleted () const |
bool | isInProgress (bool first) const |
bool | isNotStarted (bool first) const |
bool | isOpenEnded () const |
bool | isOverdue () const |
QLatin1String | mimeType () const |
int | percentComplete () const |
virtual bool | recursOn (const QDate &date, const KDateTime::Spec &timeSpec) const |
void | setAllDay (bool allDay) |
void | setCompleted (bool completed) |
void | setCompleted (const KDateTime &completeDate) |
void | setDateTime (const KDateTime &dateTime, DateTimeRole role) |
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) |
IncidenceType | type () const |
QByteArray | typeStr () const |
Static Public Member Functions | |
static QLatin1String | todoMimeType () |
Protected Member Functions | |
virtual IncidenceBase & | assign (const IncidenceBase &other) |
virtual bool | equals (const IncidenceBase &todo) const |
virtual void | virtual_hook (int id, void *data) |
Detailed Description
Member Typedef Documentation
typedef QVector<Ptr> KCalCore::Todo::List |
typedef QSharedPointer<Todo> KCalCore::Todo::Ptr |
A shared pointer to a Todo object.
Reimplemented from KCalCore::Incidence.
Constructor & Destructor Documentation
Todo::Todo | ( | ) |
Todo::Todo | ( | const Todo & | other | ) |
Todo::~Todo | ( | ) |
Member Function Documentation
IncidenceBase & Todo::assign | ( | const IncidenceBase & | other | ) | [protected, virtual] |
Provides polymorfic assignment.
- Parameters:
-
other is the IncidenceBase to assign.
Reimplemented from KCalCore::Incidence.
Todo * Todo::clone | ( | ) | const [virtual] |
Returns an exact copy of this todo.
The returned object is owned by the caller.
Implements KCalCore::Incidence.
KDateTime Todo::completed | ( | ) | const |
KDateTime Todo::dateTime | ( | DateTimeRole | role | ) | const [virtual] |
Returns a date/time corresponding to the specified DateTimeRole.
- Parameters:
-
role is a DateTimeRole.
Implements KCalCore::IncidenceBase.
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.
KDateTime Todo::dtRecurrence | ( | ) | const |
KDateTime Todo::dtStart | ( | ) | const [virtual] |
Returns an incidence's starting date/time as a KDateTime.
- See also:
- setDtStart().
Reimplemented from KCalCore::IncidenceBase.
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().
bool Todo::equals | ( | const IncidenceBase & | todo | ) | const [protected, virtual] |
Compare this with todo
for equality.
- Parameters:
-
todo is the to-do to compare.
Reimplemented from KCalCore::Incidence.
bool Todo::hasCompletedDate | ( | ) | const |
bool Todo::hasDueDate | ( | ) | const |
bool Todo::hasStartDate | ( | ) | const |
QLatin1String Todo::iconName | ( | const KDateTime & | recurrenceId = KDateTime() | ) | const [virtual] |
Implements KCalCore::Incidence.
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)
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()
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)
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)
QLatin1String Todo::mimeType | ( | ) | const [virtual] |
Returns the Akonadi specific sub MIME type of a KCalCore::IncidenceBase item, e.g.
getting "application/x-vnd.akonadi.calendar.event" for a KCalCore::Event.
Implements KCalCore::IncidenceBase.
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 KCalCore::Incidence.
void Todo::setAllDay | ( | bool | allDay | ) |
Sets whether the incidence is all-day, i.e.
has a date but no time attached to it.
- Parameters:
-
allDay sets whether the incidence is all-day.
- See also:
- allDay()
Reimplemented from KCalCore::Incidence.
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::setCompleted | ( | const KDateTime & | completeDate | ) |
void Todo::setDateTime | ( | const KDateTime & | dateTime, |
DateTimeRole | role | ||
) | [virtual] |
Sets the date/time corresponding to the specified DateTimeRole.
- Parameters:
-
dateTime is KDateTime value to set. role is a DateTimeRole.
Implements KCalCore::IncidenceBase.
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 KCalCore::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 KCalCore::Incidence.
QLatin1String Todo::todoMimeType | ( | ) | [static] |
Returns the Akonadi specific sub MIME type of a KCalCore::Todo.
Incidence::IncidenceType Todo::type | ( | ) | const [virtual] |
Returns the incidence type.
Implements KCalCore::IncidenceBase.
QByteArray Todo::typeStr | ( | ) | const [virtual] |
Prints the type of incidence as a string.
Implements KCalCore::IncidenceBase.
void Todo::virtual_hook | ( | int | id, |
void * | data | ||
) | [protected, virtual] |
Standard trick to add virtuals later.
- Parameters:
-
id is any integer unique to this class which we will use to identify the method to be called. data is a pointer to some glob of data, typically a struct.
Implements KCalCore::IncidenceBase.
The documentation for this class was generated from the following files: