libkcal

KCal::Incidence Class Reference

#include <incidence.h>

Inheritance diagram for KCal::Incidence:

KCal::IncidenceBase KCal::Recurrence::Observer KCal::CustomProperties KCal::Event KCal::Journal KCal::Todo List of all members.

Detailed Description

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

Definition at line 43 of file incidence.h.


Public Types

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

Public Member Functions

 Incidence ()
 Incidence (const Incidence &)
 ~Incidence ()
bool operator== (const Incidence &) const
virtual Incidenceclone ()=0
void setReadOnly (bool readonly)
void setFloats (bool f)
void recreate ()
void setCreated (const QDateTime &)
QDateTime created () const
void setRevision (int rev)
int revision () const
virtual void setDtStart (const QDateTime &dtStart)
virtual QDateTime dtEnd () const
void setDescription (const QString &description)
QString description () const
void setSummary (const QString &summary)
QString summary () const
void setCategories (const QStringList &categories)
void setCategories (const QString &catStr)
QStringList categories () const
QString categoriesStr () const
void setRelatedToUid (const QString &)
QString relatedToUid () const
void setRelatedTo (Incidence *relatedTo)
IncidencerelatedTo () const
Incidence::List relations () const
void addRelation (Incidence *)
void removeRelation (Incidence *)
Recurrencerecurrence () const
void clearRecurrence ()
bool doesRecur () const
uint recurrenceType () const
virtual bool recursOn (const QDate &qd) const
bool recursAt (const QDateTime &qdt) const
virtual QValueList< QDateTime > startDateTimesForDate (const QDate &date) const
virtual QValueList< QDateTime > startDateTimesForDateTime (const QDateTime &datetime) const
virtual QDateTime endDateForStart (const QDateTime &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 (int)
int 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::Listalarms () const
AlarmnewAlarm ()
void addAlarm (Alarm *)
void removeAlarm (Alarm *)
void clearAlarms ()
bool isAlarmEnabled () const
void setLocation (const QString &location)
QString location () const
void setSchedulingID (const QString &sid)
QString schedulingID () const
virtual void recurrenceUpdated (Recurrence *)

Static Public Member Functions

static QStringList secrecyList ()
static QString secrecyName (int)
static QString statusName (Status)

Protected Member Functions

virtual QDateTime endDateRecurrenceBase () const

Classes

class  AddVisitor
 This class implements a visitor for adding an Incidence to a resource supporting addEvent(), addTodo() and addJournal() calls. More...
class  DeleteVisitor
 This class implements a visitor for deleting an Incidence from a resource supporting deleteEvent(), deleteTodo() and deleteJournal() calls. More...

Member Enumeration Documentation

Enumeration for describing an event's status.

Definition at line 83 of file incidence.h.

anonymous enum

enumeration for describing an event's secrecy.

Definition at line 91 of file incidence.h.


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.

Definition at line 168 of file incidence.cpp.

void Incidence::setFloats ( bool  f  ) 

Set whether the incidence floats, i.e.

has a date but no time attached to it.

Reimplemented from KCal::IncidenceBase.

Definition at line 175 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 154 of file incidence.cpp.

void Incidence::setCreated ( const QDateTime &   ) 

Set creation date.

Definition at line 183 of file incidence.cpp.

QDateTime Incidence::created (  )  const

Return time and date of creation.

Definition at line 192 of file incidence.cpp.

void Incidence::setRevision ( int  rev  ) 

Set the number of revisions this event has seen.

Definition at line 197 of file incidence.cpp.

int Incidence::revision (  )  const

Return the number of revisions this event has seen.

Definition at line 205 of file incidence.cpp.

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

Set starting date/time.

Reimplemented from KCal::IncidenceBase.

Reimplemented in KCal::Todo.

Definition at line 210 of file incidence.cpp.

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

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

Reimplemented in KCal::Event.

Definition at line 149 of file incidence.h.

void Incidence::setDescription ( const QString &  description  ) 

Set the long description.

Definition at line 219 of file incidence.cpp.

QString Incidence::description (  )  const

Return long description.

Definition at line 226 of file incidence.cpp.

void Incidence::setSummary ( const QString &  summary  ) 

Set short summary.

Definition at line 232 of file incidence.cpp.

QString Incidence::summary (  )  const

Return short summary.

Definition at line 239 of file incidence.cpp.

void Incidence::setCategories ( const QStringList &  categories  ) 

Set categories.

Definition at line 244 of file incidence.cpp.

void Incidence::setCategories ( const QString &  catStr  ) 

Set categories based on a comma delimited string.

Definition at line 252 of file incidence.cpp.

QStringList Incidence::categories (  )  const

Return categories as a list of strings.

Definition at line 269 of file incidence.cpp.

QString Incidence::categoriesStr (  )  const

Return categories as a comma separated string.

Definition at line 274 of file incidence.cpp.

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.

Definition at line 279 of file incidence.cpp.

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.

Definition at line 286 of file incidence.cpp.

void Incidence::setRelatedTo ( Incidence relatedTo  ) 

Point at some other event to which the event relates.

Definition at line 291 of file incidence.cpp.

Incidence * Incidence::relatedTo (  )  const

What event does this one relate to?

Definition at line 306 of file incidence.cpp.

Incidence::List Incidence::relations (  )  const

All events that are related to this event.

Definition at line 311 of file incidence.cpp.

void Incidence::addRelation ( Incidence  ) 

Add an event which is related to this event.

Definition at line 316 of file incidence.cpp.

void Incidence::removeRelation ( Incidence  ) 

Remove event that is related to this event.

Definition at line 323 of file incidence.cpp.

Recurrence * Incidence::recurrence (  )  const

Return the recurrence rule associated with this incidence.

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

Definition at line 333 of file incidence.cpp.

void Incidence::clearRecurrence (  ) 

Removes all recurrence and exception rules and dates.

Definition at line 347 of file incidence.cpp.

bool Incidence::doesRecur (  )  const

Forward to Recurrence::doesRecur().

Definition at line 359 of file incidence.cpp.

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.

Definition at line 365 of file incidence.cpp.

bool Incidence::recursAt ( const QDateTime &  qdt  )  const

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

Definition at line 370 of file incidence.cpp.

QValueList< QDateTime > Incidence::startDateTimesForDate ( const QDate &  date  )  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 where the incidence should occur
Returns:
the start date/time of all occurences that overlap with the given date. Empty list if the incidence does not overlap with the date at all

Definition at line 383 of file incidence.cpp.

QValueList< QDateTime > Incidence::startDateTimesForDateTime ( const QDateTime &  datetime  )  const [virtual]

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

Parameters:
datetime the date/time where the incidence should occur
Returns:
the start date/time of all occurences that overlap with the given date/time. Empty list if the incidence does not happen at the given time at all.

Definition at line 430 of file incidence.cpp.

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

Return the end time of the occurrence if it starts at the given date/time.

Definition at line 470 of file incidence.cpp.

void Incidence::addAttachment ( Attachment attachment  ) 

Add attachment.

Definition at line 571 of file incidence.cpp.

void Incidence::deleteAttachment ( Attachment attachment  ) 

Remove and delete a specific attachment.

Definition at line 578 of file incidence.cpp.

void Incidence::deleteAttachments ( const QString &  mime  ) 

Remove and delete all attachments with this mime type.

Definition at line 583 of file incidence.cpp.

Attachment::List Incidence::attachments (  )  const

Return list of all associated attachments.

Definition at line 592 of file incidence.cpp.

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

Find a list of attachments with this mime type.

Definition at line 597 of file incidence.cpp.

void Incidence::clearAttachments (  ) 

Remove and delete all attachments.

Definition at line 608 of file incidence.cpp.

void Incidence::setSecrecy ( int   ) 

Sets secrecy status.

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

Definition at line 683 of file incidence.cpp.

int Incidence::secrecy (  )  const

Return the event's secrecy.

Definition at line 690 of file incidence.cpp.

QString Incidence::secrecyStr (  )  const

Return secrecy as translated string.

Definition at line 695 of file incidence.cpp.

QStringList Incidence::secrecyList (  )  [static]

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

Definition at line 714 of file incidence.cpp.

QString Incidence::secrecyName ( int   )  [static]

Return human-readable translated name of secrecy class.

Definition at line 700 of file incidence.cpp.

void Incidence::setStatus ( Status  status  ) 

Sets the incidence status to a standard status value.

See separate enum. Note that StatusX cannot be specified.

Definition at line 638 of file incidence.cpp.

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.

Definition at line 646 of file incidence.cpp.

Incidence::Status Incidence::status (  )  const

Return the event's status.

Definition at line 654 of file incidence.cpp.

QString Incidence::statusStr (  )  const

Return the event's status string.

Definition at line 659 of file incidence.cpp.

QString Incidence::statusName ( Status   )  [static]

Return human-readable translated name of status value.

Definition at line 666 of file incidence.cpp.

void Incidence::setResources ( const QStringList &  resources  ) 

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

Definition at line 613 of file incidence.cpp.

QStringList Incidence::resources (  )  const

Return list of current resources.

Definition at line 620 of file incidence.cpp.

void Incidence::setPriority ( int  priority  ) 

Set the incidences priority.

The priority has to be a value between 0 and 9, 0 is undefined, 1 the highest, 9 the lowest priority (decreasing order).

Definition at line 626 of file incidence.cpp.

int Incidence::priority (  )  const

Return priority.

The priority is a number between 1 and 9. 1 is highest priority. If the priority is undefined 0 is returned.

Definition at line 633 of file incidence.cpp.

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

All alarms that are associated with this incidence.

Definition at line 725 of file incidence.cpp.

Alarm * Incidence::newAlarm (  ) 

Create a new alarm which is associated with this incidence.

Definition at line 730 of file incidence.cpp.

void Incidence::addAlarm ( Alarm  ) 

Add an alarm which is associated with this incidence.

Definition at line 738 of file incidence.cpp.

void Incidence::removeAlarm ( Alarm  ) 

Remove an alarm that is associated with this incidence.

Definition at line 744 of file incidence.cpp.

void Incidence::clearAlarms (  ) 

Remove all alarms that are associated with this incidence.

Definition at line 750 of file incidence.cpp.

bool Incidence::isAlarmEnabled (  )  const

Return whether any alarm associated with this incidence is enabled.

Definition at line 756 of file incidence.cpp.

void Incidence::setLocation ( const QString &  location  ) 

Set the event's/todo's location.

Do _not_ use it with journal.

Definition at line 765 of file incidence.cpp.

QString Incidence::location (  )  const

Return the event's/todo's location.

Do _not_ use it with journal.

Definition at line 772 of file incidence.cpp.

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.

Definition at line 777 of file incidence.cpp.

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

Definition at line 782 of file incidence.cpp.

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

Implements KCal::Recurrence::Observer.

Definition at line 793 of file incidence.cpp.

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

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

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

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

Definition at line 450 of file incidence.h.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys