• Skip to content
  • Skip to link menu
KDE 4.0 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

KCal Library

KCal::Incidence

KCal::Incidence Class Reference

#include <incidence.h>

Inheritance diagram for KCal::Incidence:

Inheritance graph
[legend]

List of all members.


Detailed Description

Provides the abstract base class common to non-FreeBusy (Events, To-dos, Journals) calendar components known as incidences.

Several properties are not allowed for VFREEBUSY objects (see rfc:2445), so they are not in IncidenceBase. The hierarchy is:

IncidenceBase

  • FreeBusy
  • Incidence
  • Event
  • Todo
  • Journal

So IncidenceBase contains all properties that are common to all classes, and Incidence contains all additional properties that are common to Events, Todos and Journals, but are not allowed for FreeBusy entries.

Definition at line 63 of file incidence.h.


Public Types

enum  Status {
  StatusNone, StatusTentative, StatusConfirmed, StatusCompleted,
  StatusNeedsAction, StatusCanceled, StatusInProcess, StatusDraft,
  StatusFinal, StatusX
}
enum  Secrecy { SecrecyPublic = 0, SecrecyPrivate = 1, SecrecyConfidential = 2 }
typedef ListBase< Incidence > List

Public Member Functions

 Incidence ()
 Incidence (const Incidence &other)
 ~Incidence ()
virtual Incidence * clone ()=0
void setReadOnly (bool readonly)
void setAllDay (bool allDay)
void recreate ()
void setCreated (const KDateTime &dt)
KDateTime created () const
void setRevision (int rev)
int revision () const
virtual void setDtStart (const KDateTime &dt)
virtual KDateTime dtEnd () const
virtual void shiftTimes (const KDateTime::Spec &oldSpec, const KDateTime::Spec &newSpec)
void setDescription (const QString &description, bool isRich=false)
QString description () const
bool descriptionIsRich () const
void setSummary (const QString &summary, bool isRich=false)
QString summary () const
bool summaryIsRich () const
void setLocation (const QString &location, bool isRich=false)
QString location () const
bool locationIsRich () const
void setCategories (const QStringList &categories)
void setCategories (const QString &catStr)
QStringList categories () const
QString categoriesStr () const
void setRelatedToUid (const QString &uid)
QString relatedToUid () const
void setRelatedTo (Incidence *incidence)
Incidence * relatedTo () const
Incidence::List relations () const
void addRelation (Incidence *incidence)
void removeRelation (Incidence *incidence)
Recurrence * recurrence () const
void clearRecurrence ()
bool recurs () const
ushort recurrenceType () const
virtual bool recursOn (const QDate &date, const KDateTime::Spec &timeSpec) const
bool recursAt (const KDateTime &dt) const
virtual QList< KDateTime > startDateTimesForDate (const QDate &date, const KDateTime::Spec &timeSpec=KDateTime::LocalZone) const
virtual QList< KDateTime > startDateTimesForDateTime (const KDateTime &datetime) const
virtual KDateTime endDateForStart (const KDateTime &startDt) const
void addAttachment (Attachment *attachment)
void deleteAttachment (Attachment *attachment)
void deleteAttachments (const QString &mime)
Attachment::List attachments () const
Attachment::List attachments (const QString &mime) const
void clearAttachments ()
void setSecrecy (Secrecy secrecy)
Secrecy secrecy () const
QString secrecyStr () const
void setStatus (Status status)
void setCustomStatus (const QString &status)
Status status () const
QString statusStr () const
void setResources (const QStringList &resources)
QStringList resources () const
void setPriority (int priority)
int priority () const
const Alarm::List & alarms () const
Alarm * newAlarm ()
void addAlarm (Alarm *alarm)
void removeAlarm (Alarm *alarm)
void clearAlarms ()
bool isAlarmEnabled () const
void setSchedulingID (const QString &sid)
QString schedulingID () const
virtual void recurrenceUpdated (Recurrence *recurrence)
bool operator== (const Incidence &incidence) const

Static Public Member Functions

static QStringList secrecyList ()
static QString secrecyName (Secrecy secrecy)
static QString statusName (Status status)

Protected Member Functions

virtual KDateTime endDateRecurrenceBase () const

Member Typedef Documentation

typedef ListBase<Incidence> KCal::Incidence::List

List of incidences.

Reimplemented in KCal::Event, KCal::Journal, and KCal::Todo.

Definition at line 161 of file incidence.h.


Member Enumeration Documentation

enum KCal::Incidence::Status

Template for a class that implements a visitor for adding an Incidence to a resource supporting addEvent(), addTodo() and addJournal() calls.

Template for a class that implements a visitor for deleting an Incidence from a resource supporting deleteEvent(), deleteTodo() and deleteJournal() calls. The different types of overall incidence status or confirmation. The meaning is specific to the incidence type in context.

Enumerator:
StatusNone  No status.
StatusTentative  event is tentative
StatusConfirmed  event is definite
StatusCompleted  to-do completed
StatusNeedsAction  to-do needs action
StatusCanceled  event or to-do canceled; journal removed
StatusInProcess  to-do in process
StatusDraft  journal is draft
StatusFinal  journal is final
StatusX  a non-standard status string

Definition at line 136 of file incidence.h.

enum KCal::Incidence::Secrecy

The different types of incidence access classifications.

Enumerator:
SecrecyPublic  Not secret (default).
SecrecyPrivate  Secret to the owner.
SecrecyConfidential  Secret to the owner and some others.

Definition at line 152 of file incidence.h.


Constructor & Destructor Documentation

Incidence::Incidence (  ) 

Constructs an empty incidence.

Private class that helps to provide binary compatibility between releases.

*

Definition at line 111 of file incidence.cpp.

Incidence::Incidence ( const Incidence &  other  ) 

Copy constructor.

Parameters:
other is the incidence to copy.

Definition at line 120 of file incidence.cpp.

Incidence::~Incidence (  ) 

Destroys an incidence.

Definition at line 150 of file incidence.cpp.


Member Function Documentation

virtual Incidence* KCal::Incidence::clone (  )  [pure virtual]

Returns an exact copy of this incidence.

The returned object is owned by the caller.

Implemented in KCal::Event, KCal::Journal, and KCal::Todo.

void Incidence::setReadOnly ( bool  readonly  )  [virtual]

Set readonly state of incidence.

Parameters:
readonly If true, the incidence is set to readonly, if false the incidence is set to readwrite.

Reimplemented from KCal::IncidenceBase.

Definition at line 236 of file incidence.cpp.

void Incidence::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 KCal::IncidenceBase.

Definition at line 244 of file incidence.cpp.

void Incidence::recreate (  ) 

Recreate event.

The event is made a new unique event, but already stored event information is preserved. Sets uniquie id, creation date, last modification date and revision number.

Definition at line 223 of file incidence.cpp.

void Incidence::setCreated ( const KDateTime &  dt  ) 

Sets the incidence creation date/time.

It is stored as a UTC date/time.

Parameters:
dt is the creation date/time.
See also:
created().

Definition at line 255 of file incidence.cpp.

KDateTime Incidence::created (  )  const

Returns the incidence creation date/time.

See also:
setCreated().

Definition at line 267 of file incidence.cpp.

void Incidence::setRevision ( int  rev  ) 

Sets the number of revisions this incidence has seen.

Parameters:
rev is the incidence revision number.
See also:
revision().

Definition at line 272 of file incidence.cpp.

int Incidence::revision (  )  const

Returns the number of revisions this incidence has seen.

See also:
setRevision().

Definition at line 283 of file incidence.cpp.

void Incidence::setDtStart ( const KDateTime &  dt  )  [virtual]

Sets the incidence starting date/time.

Parameters:
dt is the starting date/time.
See also:
IncidenceBase::dtStart().

Reimplemented from KCal::IncidenceBase.

Reimplemented in KCal::Todo.

Definition at line 288 of file incidence.cpp.

KDateTime Incidence::dtEnd (  )  const [virtual]

Returns the incidence ending date/time.

See also:
IncidenceBase::dtStart().

Reimplemented in KCal::Event.

Definition at line 297 of file incidence.cpp.

void Incidence::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::IncidenceBase.

Reimplemented in KCal::Event, and KCal::Todo.

Definition at line 302 of file incidence.cpp.

void Incidence::setDescription ( const QString &  description,
bool  isRich = false 
)

Sets the incidence description.

Parameters:
description is the incidence description string.
isRich if true indicates the description string contains richtext.
See also:
description().

Definition at line 314 of file incidence.cpp.

QString Incidence::description (  )  const

Returns the incidence description.

See also:
setDescription().

Definition at line 324 of file incidence.cpp.

bool Incidence::descriptionIsRich (  )  const

Returns true if incidence description contains RichText; false otherwise.

See also:
setDescription(), description().

Definition at line 329 of file incidence.cpp.

void Incidence::setSummary ( const QString &  summary,
bool  isRich = false 
)

Sets the incidence summary.

Parameters:
summary is the incidence summary string.
isRich if true indicates the summary string contains richtext.
See also:
summary().

Definition at line 334 of file incidence.cpp.

QString Incidence::summary (  )  const

Returns the incidence summary.

See also:
setSummary().

Definition at line 344 of file incidence.cpp.

bool Incidence::summaryIsRich (  )  const

Returns true if incidence summary contains RichText; false otherwise.

See also:
setSummary(), summary().

Definition at line 349 of file incidence.cpp.

void Incidence::setLocation ( const QString &  location,
bool  isRich = false 
)

Sets the incidence location.

Do _not_ use with journals.

Parameters:
location is the incidence location string.
isRich if true indicates the location string contains richtext.
See also:
location().

Definition at line 822 of file incidence.cpp.

QString Incidence::location (  )  const

Returns the incidence location.

Do _not_ use with journals.

See also:
setLocation().

Definition at line 833 of file incidence.cpp.

bool Incidence::locationIsRich (  )  const

Returns true if incidence location contains RichText; false otherwise.

See also:
setLocation(), location().

Definition at line 838 of file incidence.cpp.

void Incidence::setCategories ( const QStringList &  categories  ) 

Sets the incidence category list.

Parameters:
categories is a list of category strings.
See also:
setCategories( const QString &), categories().

Definition at line 354 of file incidence.cpp.

void Incidence::setCategories ( const QString &  catStr  ) 

Sets the incidence category list based on a comma delimited string.

Parameters:
catStr is a QString containing a list of categories which are delimited by a comma character.
See also:
setCategories( const QStringList &), categories().

Definition at line 363 of file incidence.cpp.

QStringList Incidence::categories (  )  const

Returns the incidence categories as a list of strings.

See also:
setCategories( const QStringList &), setCategories( Const QString &).

Definition at line 384 of file incidence.cpp.

QString Incidence::categoriesStr (  )  const

Returns the incidence categories as a comma separated string.

See also:
categories().

Definition at line 389 of file incidence.cpp.

void Incidence::setRelatedToUid ( const QString &  uid  ) 

Relates another incidence to this one, by UID.

This function should only be used when constructing a calendar before the related incidence exists.

Parameters:
uid is a QString containing a UID for another incidence.
See also:
relatedToUid(), setRelatedTo().

Definition at line 394 of file incidence.cpp.

QString Incidence::relatedToUid (  )  const

Returns a UID string for the incidence that is related to this one.

This function should only be used when constructing a calendar before the related incidence exists.

See also:
setRelatedToUid(), relatedTo().

Definition at line 403 of file incidence.cpp.

void Incidence::setRelatedTo ( Incidence *  incidence  ) 

Relates another incidence to this one.

This function should only be used when constructing a calendar before the related incidence exists.

Parameters:
incidence is a pointer to another incidence object.
See also:
relatedTo(), setRelatedToUid().

Definition at line 408 of file incidence.cpp.

Incidence * Incidence::relatedTo (  )  const

Returns a pointer for the incidence that is related to this one.

This function should only be used when constructing a calendar before the related incidence exists.

See also:
setRelatedTo(), relatedToUid().

Definition at line 427 of file incidence.cpp.

Incidence::List Incidence::relations (  )  const

Returns a list of all incidences related to this one.

See also:
addRelation, removeRelation().

Definition at line 432 of file incidence.cpp.

void Incidence::addRelation ( Incidence *  incidence  ) 

Adds an incidence that is related to this one.

Parameters:
incidence is a pointer to an Incidence object.
See also:
removeRelation(), relations().

Definition at line 437 of file incidence.cpp.

void Incidence::removeRelation ( Incidence *  incidence  ) 

Removes an incidence that is related to this one.

Parameters:
incidence is a pointer to an Incidence object.
See also:
addRelation(), relations().

Definition at line 444 of file incidence.cpp.

Recurrence * Incidence::recurrence (  )  const

Returns the recurrence rule associated with this incidence.

If there is none, returns an appropriate (non-0) object.

Definition at line 453 of file incidence.cpp.

void Incidence::clearRecurrence (  ) 

Removes all recurrence and exception rules and dates.

Definition at line 466 of file incidence.cpp.

bool Incidence::recurs (  )  const

Returns whether the event recurs at all.

Definition at line 481 of file incidence.cpp.

ushort Incidence::recurrenceType (  )  const

Returns the event's recurrence status.

See the enumeration at the top of this file for possible values.

Definition at line 472 of file incidence.cpp.

bool Incidence::recursOn ( const QDate &  date,
const KDateTime::Spec &  timeSpec 
) const [virtual]

Returns true if the date specified is one on which the event will recur.

Parameters:
date date to check.
timeSpec time specification for date.

Reimplemented in KCal::Todo.

Definition at line 490 of file incidence.cpp.

bool Incidence::recursAt ( const KDateTime &  dt  )  const

Returns true if the date/time specified is one at which the event will recur.

Times are rounded down to the nearest minute to determine the result.

Parameters:
dt is the date/time to check.

Definition at line 496 of file incidence.cpp.

QList< KDateTime > Incidence::startDateTimesForDate ( const QDate &  date,
const KDateTime::Spec &  timeSpec = KDateTime::LocalZone 
) const [virtual]

Calculates the start date/time for all recurrences that happen at some time on the given date (might start before that date, but end on or after the given date).

Parameters:
date the date when the incidence should occur
timeSpec time specification for date.
Returns:
the start date/time of all occurrences that overlap with the given date; an empty list if the incidence does not overlap with the date at all.

Definition at line 501 of file incidence.cpp.

QList< KDateTime > Incidence::startDateTimesForDateTime ( const KDateTime &  datetime  )  const [virtual]

Calculates the start date/time for all recurrences that happen at the given time.

Parameters:
datetime the date/time when the incidence should occur.
Returns:
the start date/time of all occurrences that overlap with the given date/time; an empty list if the incidence does not happen at the given time at all.

Definition at line 542 of file incidence.cpp.

KDateTime Incidence::endDateForStart ( const KDateTime &  startDt  )  const [virtual]

Returns the end date/time of the incidence occurrence if it starts at specified date/time.

Parameters:
startDt is the specified starting date/time.
Returns:
the corresponding end date/time for the occurrence; or the start date/time if the end date/time is invalid; or the end date/time if the start date/time is invalid.

Definition at line 582 of file incidence.cpp.

void Incidence::addAttachment ( Attachment *  attachment  ) 

Adds an attachment to the incidence.

Parameters:
attachment is a pointer to a valid Attachment object.
See also:
deleteAttachment().

Definition at line 596 of file incidence.cpp.

void Incidence::deleteAttachment ( Attachment *  attachment  ) 

Removes the specified attachment from the incidence.

Additionally, the memory used by the attachment is freed.

Parameters:
attachment is a pointer to a valid Attachment object.
See also:
addAttachment(), deleteAttachments().

Definition at line 606 of file incidence.cpp.

void Incidence::deleteAttachments ( const QString &  mime  ) 

Removes all attachments of the specified MIME type from the incidence.

The memory used by all the removed attachments is freed.

Parameters:
mime is a QString containing the MIME type.
See also:
deleteAttachment().

Definition at line 611 of file incidence.cpp.

Attachment::List Incidence::attachments (  )  const

Returns a list of all incidence attachments.

See also:
attachments( const QString &).

Definition at line 623 of file incidence.cpp.

Attachment::List Incidence::attachments ( const QString &  mime  )  const

Returns a list of all incidence attachments with the specified MIME type.

Parameters:
mime is a QString containing the MIME type.
See also:
attachments().

Definition at line 628 of file incidence.cpp.

void Incidence::clearAttachments (  ) 

Removes all attachments and frees the memory used by them.

See also:
deleteAttachment( Attachment *), deleteAttachments( const QString &).

Definition at line 640 of file incidence.cpp.

void Incidence::setSecrecy ( Incidence::Secrecy  secrecy  ) 

Sets the incidence Secrecy.

Parameters:
secrecy is the incidence Secrecy to set.
See also:
secrecy(), secrecyStr().

Definition at line 737 of file incidence.cpp.

Incidence::Secrecy Incidence::secrecy (  )  const

Returns the incidence Secrecy.

See also:
setSecrecy(), secrecyStr().

Definition at line 747 of file incidence.cpp.

QString Incidence::secrecyStr (  )  const

Returns the incidence Secrecy as translated string.

See also:
secrecy().

Definition at line 752 of file incidence.cpp.

QStringList Incidence::secrecyList (  )  [static]

Returns a list of all available Secrecy types as a list of translated strings.

See also:
secrecyName().

Definition at line 771 of file incidence.cpp.

QString Incidence::secrecyName ( Incidence::Secrecy  secrecy  )  [static]

Returns the translated string form of a specified Secrecy.

Parameters:
secrecy is a Secrecy type.
See also:
secrecyList().

Definition at line 757 of file incidence.cpp.

void Incidence::setStatus ( Incidence::Status  status  ) 

Sets the incidence status to a standard Status value.

Note that StatusX cannot be specified.

Parameters:
status is the incidence Status to set.
See also:
status(), setCustomStatus().

Definition at line 675 of file incidence.cpp.

void Incidence::setCustomStatus ( const QString &  status  ) 

Sets the incidence Status to a non-standard status value.

Parameters:
status is a non-standard status string. If empty, the incidence Status will be set to StatusNone.
See also:
setStatus(), status().

Definition at line 686 of file incidence.cpp.

Incidence::Status Incidence::status (  )  const

Returns the incidence Status.

See also:
setStatus(), setCustomStatus(), statusStr().

Definition at line 697 of file incidence.cpp.

QString Incidence::statusStr (  )  const

Returns the incidence Status as translated string.

See also:
status().

Definition at line 702 of file incidence.cpp.

QString Incidence::statusName ( Incidence::Status  status  )  [static]

Returns the translated string form of a specified Status.

Parameters:
status is a Status type.

Definition at line 711 of file incidence.cpp.

void Incidence::setResources ( const QStringList &  resources  ) 

Sets a list of incidence resources.

(Note: resources in this context means items used by the incidence such as money, fuel, hours, etc).

Parameters:
resources is a list of resource strings.
See also:
resources().

Definition at line 645 of file incidence.cpp.

QStringList Incidence::resources (  )  const

Returns the incidence resources as a list of strings.

See also:
setResources().

Definition at line 655 of file incidence.cpp.

void Incidence::setPriority ( int  priority  ) 

Sets the incidences priority.

The priority must be an integer value between 0 and 9, where 0 is undefined, 1 is the highest, and 9 is the lowest priority (decreasing order).

Parameters:
priority is the incidence priority to set.
See also:
priority().

Definition at line 660 of file incidence.cpp.

int Incidence::priority (  )  const

Returns the incidence priority.

See also:
setPriority().

Definition at line 670 of file incidence.cpp.

const Alarm::List & Incidence::alarms (  )  const

Returns a list of all incidence alarms.

Definition at line 781 of file incidence.cpp.

Alarm * Incidence::newAlarm (  ) 

Create a new incidence alarm.

Definition at line 786 of file incidence.cpp.

void Incidence::addAlarm ( Alarm *  alarm  ) 

Adds an alarm to the incidence.

Parameters:
alarm is a pointer to a valid Alarm object.
See also:
removeAlarm().

Definition at line 793 of file incidence.cpp.

void Incidence::removeAlarm ( Alarm *  alarm  ) 

Removes the specified alarm from the incidence.

Parameters:
alarm is a pointer to a valid Alarm object.
See also:
addAlarm().

Definition at line 799 of file incidence.cpp.

void Incidence::clearAlarms (  ) 

Removes all alarms.

See also:
removeAlarm().

Definition at line 805 of file incidence.cpp.

bool Incidence::isAlarmEnabled (  )  const

Returns true if any of the incidence alarms are enabled; false otherwise.

Definition at line 811 of file incidence.cpp.

void Incidence::setSchedulingID ( const QString &  sid  ) 

Set the incidence scheduling ID.

Do _not_ use with journals. This is used for accepted invitations as the place to store the UID of the invitation. It is later used again if updates to the invitation comes in. If we did not set a new UID on incidences from invitations, we can end up with more than one resource having events with the same UID, if you have access to other peoples resources.

Parameters:
sid is a QString containing the scheduling ID.
See also:
schedulingID().

Definition at line 843 of file incidence.cpp.

QString Incidence::schedulingID (  )  const

Returns the incidence scheduling ID.

Do _not_ use with journals. If a scheduling ID is not set, then return the incidence UID.

See also:
setSchedulingID().

Definition at line 848 of file incidence.cpp.

void Incidence::recurrenceUpdated ( Recurrence *  recurrence  )  [virtual]

Observer interface for the recurrence class.

If the recurrence is changed, this method will be called for the incidence the recurrence object belongs to.

Parameters:
recurrence is a pointer to a valid Recurrence object.
If the recurrence is changed, this method will be called for the incidence the recurrence object belongs to.

Definition at line 860 of file incidence.cpp.

bool Incidence::operator== ( const Incidence &  incidence  )  const

Compare this with incidence for equality.

Parameters:
incidence is the incidence to compare.

Definition at line 176 of file incidence.cpp.

virtual KDateTime KCal::Incidence::endDateRecurrenceBase (  )  const [inline, protected, virtual]

Returns the end date/time of the base incidence (e.g.

due date/time for to-dos, end date/time for events). This method must be reimplemented by derived classes.

Reimplemented in KCal::Event, and KCal::Todo.

Definition at line 729 of file incidence.h.


The documentation for this class was generated from the following files:
  • incidence.h
  • incidence.cpp

KCal Library

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

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • kabc
  • kblog
  • kcal
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.5
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal