• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.10.5 API Reference
  • KDE Home
  • Contact Us
 

KCal Library

  • KCal
  • Todo
Public Types | Public Member Functions | Protected Member Functions | List of all members
KCal::Todo Class Reference

#include <todo.h>

Inheritance diagram for KCal::Todo:
KCal::Incidence KCal::IncidenceBase KCal::CustomProperties

Public Types

typedef boost::shared_ptr
< const Todo > 
ConstPtr
 
typedef ListBase< Todo > List
 
typedef boost::shared_ptr< Todo > Ptr
 
- Public Types inherited from KCal::Incidence
typedef boost::shared_ptr
< const Incidence > 
ConstPtr
 
typedef ListBase< Incidence > List
 
typedef boost::shared_ptr
< Incidence > 
Ptr
 
enum  Secrecy { SecrecyPublic =0, SecrecyPrivate =1, SecrecyConfidential =2 }
 
enum  Status {
  StatusNone, StatusTentative, StatusConfirmed, StatusCompleted,
  StatusNeedsAction, StatusCanceled, StatusInProcess, StatusDraft,
  StatusFinal, StatusX
}
 

Public Member Functions

 Todo ()
 
 Todo (const Todo &other)
 
 ~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
 
virtual KDateTime dtStart () const
 
KDateTime dtStart (bool first) const
 
QString dtStartDateStr (bool shortfmt, bool first, const KDateTime::Spec &spec=KDateTime::Spec()) const
 
virtual QString dtStartDateStr (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 dtStartStr (bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec()) const
 
QString dtStartTimeStr (bool shortfmt, bool first, const KDateTime::Spec &spec=KDateTime::Spec()) const
 
virtual QString dtStartTimeStr (bool shortfmt=true, 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 (bool completed)
 
void setCompleted (const KDateTime &completeDate)
 
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
 
- Public Member Functions inherited from KCal::Incidence
 Incidence ()
 
 Incidence (const Incidence &other)
 
 ~Incidence ()
 
void addAlarm (Alarm *alarm)
 
void addAttachment (Attachment *attachment)
 
void addRelation (Incidence *incidence)
 
const Alarm::List & alarms () const
 
Attachment::List attachments () const
 
Attachment::List attachments (const QString &mime) const
 
QStringList categories () const
 
QString categoriesStr () const
 
void clearAlarms ()
 
void clearAttachments ()
 
void clearRecurrence ()
 
void clearTempFiles ()
 
KDateTime created () const
 
void deleteAttachment (Attachment *attachment)
 
void deleteAttachments (const QString &mime)
 
QString description () const
 
bool descriptionIsRich () const
 
virtual KDateTime dtEnd () const
 
virtual KDateTime endDateForStart (const KDateTime &startDt) const
 
float & geoLatitude () const
 
float & geoLongitude () const
 
bool hasGeo () const
 
bool isAlarmEnabled () const
 
QString location () const
 
bool locationIsRich () const
 
Alarm * newAlarm ()
 
Incidence & operator= (const Incidence &other)
 
bool operator== (const Incidence &incidence) const
 
int priority () const
 
void recreate ()
 
Recurrence * recurrence () const
 
ushort recurrenceType () const
 
virtual void recurrenceUpdated (Recurrence *recurrence)
 
bool recurs () const
 
bool recursAt (const KDateTime &dt) const
 
Incidence * relatedTo () const
 
QString relatedToUid () const
 
Incidence::List relations () const
 
void removeAlarm (Alarm *alarm)
 
void removeRelation (Incidence *incidence)
 
QStringList resources () const
 
int revision () const
 
QString richDescription () const
 
QString richLocation () const
 
QString richSummary () const
 
QString schedulingID () const
 
Secrecy secrecy () const
 
QString secrecyStr () const
 
void setAllDay (bool allDay)
 
void setCategories (const QStringList &categories)
 
void setCategories (const QString &catStr)
 
void setCreated (const KDateTime &dt)
 
void setCustomStatus (const QString &status)
 
void setDescription (const QString &description, bool isRich)
 
void setDescription (const QString &description)
 
void setGeoLatitude (float geolatitude)
 
void setGeoLongitude (float geolongitude)
 
void setHasGeo (bool hasGeo)
 
void setLocation (const QString &location, bool isRich)
 
void setLocation (const QString &location)
 
void setPriority (int priority)
 
void setReadOnly (bool readonly)
 
void setRelatedTo (Incidence *incidence)
 
void setRelatedToUid (const QString &uid)
 
void setResources (const QStringList &resources)
 
void setRevision (int rev)
 
void setSchedulingID (const QString &sid)
 
void setSecrecy (Secrecy secrecy)
 
void setStatus (Status status)
 
void setSummary (const QString &summary, bool isRich)
 
void setSummary (const QString &summary)
 
virtual QList< KDateTime > startDateTimesForDate (const QDate &date, const KDateTime::Spec &timeSpec=KDateTime::LocalZone) const
 
virtual QList< KDateTime > startDateTimesForDateTime (const KDateTime &datetime) const
 
Status status () const
 
QString statusStr () const
 
QString summary () const
 
bool summaryIsRich () const
 
QString writeAttachmentToTempFile (Attachment *attachment) const
 
- Public Member Functions inherited from KCal::IncidenceBase
 IncidenceBase ()
 
 IncidenceBase (const IncidenceBase &ib)
 
virtual ~IncidenceBase ()
 
void addAttendee (Attendee *attendee, bool doUpdate=true)
 
void addComment (const QString &comment)
 
bool allDay () const
 
Attendee * attendeeByMail (const QString &email) const
 
Attendee * attendeeByMails (const QStringList &emails, const QString &email=QString()) const
 
Attendee * attendeeByUid (const QString &uid) const
 
int attendeeCount () const
 
const Attendee::List & attendees () const
 
void clearAttendees ()
 
void clearComments ()
 
QStringList comments () const
 
Duration duration () const
 
void endUpdates ()
 
bool hasDuration () const
 
bool isReadOnly () const
 
KDateTime lastModified () const
 
IncidenceBase & operator= (const IncidenceBase &other)
 
bool operator== (const IncidenceBase &ib) const
 
Person organizer () const
 
void registerObserver (IncidenceObserver *observer)
 
bool removeComment (const QString &comment)
 
void setAllDay (bool allDay)
 
virtual void setDuration (const Duration &duration)
 
void setHasDuration (bool hasDuration)
 
void setLastModified (const KDateTime &lm)
 
void setOrganizer (const Person &organizer)
 
void setOrganizer (const QString &organizer)
 
void setUid (const QString &uid)
 
void startUpdates ()
 
QString uid () const
 
void unRegisterObserver (IncidenceObserver *observer)
 
void updated ()
 
KUrl uri () const
 
- Public Member Functions inherited from KCal::CustomProperties
 CustomProperties ()
 
 CustomProperties (const CustomProperties &other)
 
virtual ~CustomProperties ()
 
QMap< QByteArray, QString > customProperties () const
 
QString customProperty (const QByteArray &app, const QByteArray &key) const
 
QString nonKDECustomProperty (const QByteArray &name) const
 
CustomProperties & operator= (const CustomProperties &other)
 
bool operator== (const CustomProperties &properties) const
 
void removeCustomProperty (const QByteArray &app, const QByteArray &key)
 
void removeNonKDECustomProperty (const QByteArray &name)
 
void setCustomProperties (const QMap< QByteArray, QString > &properties)
 
void setCustomProperty (const QByteArray &app, const QByteArray &key, const QString &value)
 
void setNonKDECustomProperty (const QByteArray &name, const QString &value)
 
- Public Member Functions inherited from KCal::Recurrence::RecurrenceObserver
virtual void recurrenceUpdated (Recurrence *r)=0
 

Protected Member Functions

virtual KDateTime endDateRecurrenceBase () const
 

Additional Inherited Members

- Static Public Member Functions inherited from KCal::Incidence
static QStringList secrecyList ()
 
static QString secrecyName (Secrecy secrecy)
 
static QString statusName (Status status)
 
- Protected Attributes inherited from KCal::IncidenceBase
bool mReadOnly
 

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.

Definition at line 60 of file todo.h.

typedef ListBase<Todo> KCal::Todo::List

List of to-dos.

Definition at line 50 of file todo.h.

typedef boost::shared_ptr<Todo> KCal::Todo::Ptr

A shared pointer to a Todo object.

Definition at line 55 of file todo.h.

Constructor & Destructor Documentation

Todo::Todo ( )

Constructs an empty to-do.

Private class that helps to provide binary compatibility between releases.

Definition at line 91 of file todo.cpp.

Todo::Todo ( const Todo &  other)

Copy constructor.

Parameters
otheris the to-do to copy.

Definition at line 96 of file todo.cpp.

Todo::~Todo ( )

Destroys a to-do.

Definition at line 102 of file todo.cpp.

Member Function Documentation

Todo * Todo::clone ( )
virtual

Implements KCal::Incidence.

Definition at line 107 of file todo.cpp.

KDateTime Todo::completed ( ) const

Returns date and time when todo was completed.

Definition at line 431 of file todo.cpp.

QString Todo::completedStr ( bool  shortfmt = false) const

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

Parameters
shortfmtIf set, use short date format; else use long format.

Definition at line 440 of file todo.cpp.

KDateTime Todo::dtDue ( bool  first = false) const

Returns due date and time.

Parameters
firstIf 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 180 of file todo.cpp.

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
shortfmtIf set, use short date format; else use long format.
specIf set, return the date in the given spec, else use the todo's current spec.
Deprecated:
use IncidenceFormatter::dateToString()

Definition at line 209 of file todo.cpp.

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
shortfmtIf set, use short date format; else use long format.
specIf set, return the date/time in the given spec, else use the todo's current spec.
Deprecated:
use IncidenceFormatter::dateTimeToString()

Definition at line 228 of file todo.cpp.

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
shortfmtIf set, use short date format; else use long format.
specIf set, return the time in the given spec, else use the todo's current spec.
Deprecated:
use IncidenceFormatter::timeToString()

Definition at line 192 of file todo.cpp.

KDateTime Todo::dtRecurrence ( ) const

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

Definition at line 556 of file todo.cpp.

KDateTime Todo::dtStart ( ) const
virtual

See Also
setDtStart().

Reimplemented from KCal::IncidenceBase.

Definition at line 288 of file todo.cpp.

KDateTime Todo::dtStart ( bool  first) const

Returns the start date of the todo.

Parameters
firstIf 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().

Definition at line 293 of file todo.cpp.

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
shortfmtIf set, use short date format; else use long format.
firstIf 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().
specIf set, returns the date in the given spec, else use the todo's current spec.
Deprecated:
use IncidenceFormatter::dateToString()

Definition at line 340 of file todo.cpp.

QString Todo::dtStartDateStr ( bool  shortfmt = true,
const KDateTime::Spec &  spec = KDateTime::Spec() 
) const
virtual

Parameters
shortfmtIf set to true, use short date format, if set to false use long format.
specIf set, return the date in the given spec, else use the incidence's current spec.
Deprecated:
use IncidenceFormatter::dateToString()

Reimplemented from KCal::IncidenceBase.

Definition at line 359 of file todo.cpp.

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
shortfmtIf set, use short date format; else use long format.
firstIf 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().
specIf set, returns the date and time in the given spec, else use the todo's current spec.
Deprecated:
use IncidenceFormatter::dateTimeToString()

Definition at line 364 of file todo.cpp.

QString Todo::dtStartStr ( bool  shortfmt = true,
const KDateTime::Spec &  spec = KDateTime::Spec() 
) const
virtual

Parameters
shortfmtIf set to true, use short date format, if set to false use long format.
specIf set, return the date and time in the given spec, else use the incidence's current spec.
Deprecated:
use IncidenceFormatter::dateTimeToString()

Reimplemented from KCal::IncidenceBase.

Definition at line 387 of file todo.cpp.

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
shortfmtIf set, use short date format; else use long format.
firstIf 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().
specIf set, returns the time in the given spec, else use the todo's current spec.
Deprecated:
use IncidenceFormatter::timeToString()

Definition at line 318 of file todo.cpp.

QString Todo::dtStartTimeStr ( bool  shortfmt = true,
const KDateTime::Spec &  spec = KDateTime::Spec() 
) const
virtual

Parameters
shortfmtIf set to true, use short date format, if set to false use long format.
specIf set, return the time in the given spec, else use the incidence's current spec.
Deprecated:
use IncidenceFormatter::timeToString()

Reimplemented from KCal::IncidenceBase.

Definition at line 335 of file todo.cpp.

KDateTime Todo::endDateRecurrenceBase ( ) const
protectedvirtual

Returns the end date/time of the base incidence.

Reimplemented from KCal::Incidence.

Definition at line 582 of file todo.cpp.

bool Todo::hasCompletedDate ( ) const

Returns true, if the to-do has a date associated with completion, otherwise return false.

Definition at line 457 of file todo.cpp.

bool Todo::hasDueDate ( ) const

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

Definition at line 251 of file todo.cpp.

bool Todo::hasStartDate ( ) const

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

Definition at line 265 of file todo.cpp.

bool Todo::isCompleted ( ) const

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

See Also
isOverdue, isInProgress(), isOpenEnded(), isNotStarted(bool), setCompleted(), percentComplete()

Definition at line 410 of file todo.cpp.

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
firstIf 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

Definition at line 477 of file todo.cpp.

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
firstIf 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

Definition at line 513 of file todo.cpp.

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

Definition at line 504 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.

See Also
isCompleted(), isInProgress(), isOpenEnded(), isNotStarted(bool)

Definition at line 570 of file todo.cpp.

Todo & Todo::operator= ( const Todo &  other)

Assignment operator.

Parameters
otheris the to-do to assign.

Definition at line 112 of file todo.cpp.

bool Todo::operator== ( const Todo &  todo) const

Compare this with todo for equality.

Parameters
todois the to-do to compare.

Definition at line 124 of file todo.cpp.

int Todo::percentComplete ( ) const

Returns what percentage of the to-do is completed.

Returns a value between 0 and 100.

Definition at line 462 of file todo.cpp.

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
dateis the date to check.
timeSpecis the

Reimplemented from KCal::Incidence.

Definition at line 561 of file todo.cpp.

void Todo::setCompleted ( bool  completed)

Sets completed state.

Parameters
completedIf true set completed state to 100%, if false set completed state to 0%.
See Also
isCompleted(), percentComplete()

Definition at line 419 of file todo.cpp.

void Todo::setCompleted ( const KDateTime &  completeDate)

Sets date and time of completion.

Parameters
completeDateis the to-do completion date.

Definition at line 447 of file todo.cpp.

void Todo::setDtDue ( const KDateTime &  dtDue,
bool  first = false 
)

Sets due date and time.

Parameters
dtDueThe due date/time.
firstIf 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 147 of file todo.cpp.

void Todo::setDtRecurrence ( const KDateTime &  dt)

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

Parameters
dtis the

Definition at line 551 of file todo.cpp.

void Todo::setDtStart ( const KDateTime &  dtStart)
virtual

Sets the start date of the todo.

Parameters
dtStartis the to-do start date.

Reimplemented from KCal::Incidence.

Definition at line 307 of file todo.cpp.

void Todo::setHasDueDate ( bool  hasDueDate)

Sets if the todo has a due date.

Parameters
hasDueDatetrue if todo has a due date, otherwise false

Definition at line 256 of file todo.cpp.

void Todo::setHasStartDate ( bool  hasStartDate)

Sets if the todo has a start date.

Parameters
hasStartDatetrue if todo has a start date, otherwise false

Definition at line 270 of file todo.cpp.

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
percentis the completion percentage, which as integer value between 0 and 100, inclusive.
See Also
isCompleted(), setCompleted()

Definition at line 467 of file todo.cpp.

void Todo::shiftTimes ( const KDateTime::Spec &  oldSpec,
const KDateTime::Spec &  newSpec 
)
virtual

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
oldSpecthe time specification which provides the clock times
newSpecthe new time specification

Reimplemented from KCal::Incidence.

Definition at line 535 of file todo.cpp.

QByteArray Todo::type ( ) const
virtual

Implements KCal::IncidenceBase.

Definition at line 136 of file todo.cpp.


The documentation for this class was generated from the following files:
  • todo.h
  • todo.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Sat Jul 13 2013 01:29:21 by doxygen 1.8.3.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KCal Library

Skip menu "KCal Library"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.10.5 API Reference

Skip menu "kdepimlibs-4.10.5 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal