KDE PIM / Developers / API Docs / libkcal

KCal::Incidence Class Reference

This class provides the base class common to all calendar components. More...

#include <incidence.h>

Inherits KCal::IncidenceBase.

Inherited by KCal::Event, KCal::Journal, and KCal::Todo.

List of all members.

Public Types

Public Member Functions

Static Public Member Functions

Classes


Detailed Description

This class provides the base class common to all calendar components.


Member Enumeration Documentation

enum KCal::Incidence::Status
 

Enumeration for describing an event's status.

anonymous enum
 

enumeration for describing an event's secrecy.

Reimplemented from KCal::IncidenceBase.


Member Function Documentation

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

Return copy of this object.

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.

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.

void Incidence::setCreated const QDateTime &   ) 
 

Set creation date.

QDateTime Incidence::created  )  const
 

Return time and date of creation.

void Incidence::setRevision int  rev  ) 
 

Set the number of revisions this event has seen.

int Incidence::revision  )  const
 

Return the number of revisions this event has seen.

void Incidence::setDtStart const QDateTime &  dtStart  )  [virtual]
 

Set starting date/time.

Reimplemented from KCal::IncidenceBase.

Reimplemented in KCal::Todo.

virtual QDateTime KCal::Incidence::dtEnd  )  const [inline, virtual]
 

Return the incidence's ending date/time as a QDateTime.

Reimplemented in KCal::Event.

void Incidence::setDescription const QString &  description  ) 
 

Set the long description.

QString Incidence::description  )  const
 

Return long description.

void Incidence::setSummary const QString &  summary  ) 
 

Set short summary.

QString Incidence::summary  )  const
 

Return short summary.

void Incidence::setCategories const QStringList &  categories  ) 
 

Set categories.

void Incidence::setCategories const QString &  catStr  ) 
 

Set categories based on a comma delimited string.

QStringList Incidence::categories  )  const
 

Return categories as a list of strings.

QString Incidence::categoriesStr  )  const
 

Return categories as a comma separated string.

void Incidence::setRelatedToUid const QString &   ) 
 

Point at some other event to which the event relates.

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

QString Incidence::relatedToUid  )  const
 

What event does this one relate to? This function should only be used when constructing a calendar before the related Incidence exists.

void Incidence::setRelatedTo Incidence relatedTo  ) 
 

Point at some other event to which the event relates.

Incidence * Incidence::relatedTo  )  const
 

What event does this one relate to?

Incidence::List Incidence::relations  )  const
 

All events that are related to this event.

void Incidence::addRelation Incidence  ) 
 

Add an event which is related to this event.

void Incidence::removeRelation Incidence  ) 
 

Remove event that is related to this event.

DateList Incidence::exDates  )  const
 

Returns the list of dates which are exceptions to the recurrence rule.

DateTimeList Incidence::exDateTimes  )  const
 

Returns the list of date/times which are exceptions to the recurrence rule.

void Incidence::setExDates const DateList &  exDates  ) 
 

Sets the list of dates which are exceptions to the recurrence rule.

This does not affect the date-time exception list.

void Incidence::setExDateTimes const DateTimeList &  exDateTimes  ) 
 

Sets the list of date/times which are exceptions to the recurrence rule.

This does not affect the date-only exception list.

void Incidence::addExDate const QDate &  date  ) 
 

Add a date to the list of exceptions of the recurrence rule.

void Incidence::addExDateTime const QDateTime &  dateTime  ) 
 

Add a date/time to the list of exceptions of the recurrence rule.

bool Incidence::isException const QDate &  qd  )  const
 

Returns true if there is an exception for this date in the recurrence rule set, or false otherwise.

Does not check the date/time exception list.

bool Incidence::isException const QDateTime &  qdt  )  const
 

Returns true if there is an exception for this date/time in the recurrence rule set, or false otherwise.

Does not check the date-only exception list.

void Incidence::addAttachment Attachment attachment  ) 
 

Add attachment.

void Incidence::deleteAttachment Attachment attachment  ) 
 

Remove and delete a specific attachment.

void Incidence::deleteAttachments const QString &  mime  ) 
 

Remove and delete all attachments with this mime type.

Attachment::List Incidence::attachments  )  const
 

Return list of all associated attachments.

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

Find a list of attachments with this mime type.

void Incidence::clearAttachments  ) 
 

Remove and delete all attachments.

void Incidence::setSecrecy int   ) 
 

Sets secrecy status.

This can be Public, Private or Confidential. See separate enum.

int Incidence::secrecy  )  const
 

Return the event's secrecy.

QString Incidence::secrecyStr  )  const
 

Return secrecy as translated string.

QStringList Incidence::secrecyList  )  [static]
 

Return list of all available secrecy states as list of translated strings.

QString Incidence::secrecyName int   )  [static]
 

Return human-readable translated name of secrecy class.

void Incidence::setStatus Status  status  ) 
 

Sets the incidence status to a standard status value.

See separate enum. Note that StatusX cannot be specified.

void Incidence::setCustomStatus const QString &  status  ) 
 

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

Parameters:
status non-standard status string. If empty, the incidence status will be set to StatusNone.

Incidence::Status Incidence::status  )  const
 

Return the event's status.

QString Incidence::statusStr  )  const
 

Return the event's status string.

QString Incidence::statusName Status   )  [static]
 

Return human-readable translated name of status value.

bool Incidence::recursOn const QDate &  qd  )  const [virtual]
 

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

Reimplemented in KCal::Todo.

bool Incidence::recursAt const QDateTime &  qdt  )  const
 

Returns true if the date/time specified is one on which the incidence will recur.

void Incidence::setResources const QStringList &  resources  ) 
 

Set resources used, such as Office, Car, etc.

QStringList Incidence::resources  )  const
 

Return list of current resources.

void Incidence::setPriority int  priority  ) 
 

Set the incidences priority, 0 is undefined, 1 highest (decreasing order).

int Incidence::priority  )  const
 

Return priority.

The priority is a number between 1 and 5. 1 is highest priority.

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

All alarms that are associated with this incidence.

Alarm * Incidence::newAlarm  ) 
 

Create a new alarm which is associated with this incidence.

void Incidence::addAlarm Alarm  ) 
 

Add an alarm which is associated with this incidence.

void Incidence::removeAlarm Alarm  ) 
 

Remove an alarm that is associated with this incidence.

void Incidence::clearAlarms  ) 
 

Remove all alarms that are associated with this incidence.

bool Incidence::isAlarmEnabled  )  const
 

Return whether any alarm associated with this incidence is enabled.

Recurrence * Incidence::recurrence  )  const
 

Return the recurrence rule associated with this incidence.

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

ushort Incidence::doesRecur  )  const
 

Forward to Recurrence::doesRecur().

void Incidence::setLocation const QString &  location  ) 
 

Set the event's/todo's location.

Do _not_ use it with journal.

QString Incidence::location  )  const
 

Return the event's/todo's location.

Do _not_ use it with journal.

void Incidence::setSchedulingID const QString &  sid  ) 
 

Set the event's/todo's scheduling ID.

Does not make sense for 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.

QString Incidence::schedulingID  )  const
 

Return the event's/todo's scheduling ID.

Does not make sense for journals If this is not set, it will return uid().


The documentation for this class was generated from the following files: