libkcal Library API Documentation

KCal::Incidence Class Reference

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

#include <incidence.h>

Inheritance diagram for KCal::Incidence:

Inheritance graph
[legend]
Collaboration diagram for KCal::Incidence:

Collaboration graph
[legend]
List of all members.

Public Types

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

Public Member Functions

 Incidence (const Incidence &)
bool operator== (const Incidence &) const
virtual bool accept (Visitor &)
virtual Incidenceclone ()=0
void setReadOnly (bool)
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 *)
DateList exDates () const
DateTimeList exDateTimes () const
void setExDates (const DateList &exDates)
void setExDateTimes (const DateTimeList &exDateTimes)
void addExDate (const QDate &date)
void addExDateTime (const QDateTime &dateTime)
bool isException (const QDate &qd) const
bool isException (const QDateTime &qdt) 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
bool recursOn (const QDate &qd) const
bool recursAt (const QDateTime &qdt) 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
Recurrencerecurrence () const
ushort doesRecur () const
void setLocation (const QString &location)
QString location () const
void setSchedulingID (const QString &sid)
QString schedulingID () const

Static Public Member Functions

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

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...
class  Visitor
 This class provides the interface for a visitor of calendar components. More...

Detailed Description

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

Definition at line 43 of file incidence.h.


Member Enumeration Documentation

enum KCal::Incidence::Status
 

Enumeration for describing an event's status.

Definition at line 116 of file incidence.h.

anonymous enum
 

enumeration for describing an event's secrecy.

Definition at line 124 of file incidence.h.


Member Function Documentation

virtual bool KCal::Incidence::accept Visitor  )  [inline, virtual]
 

Accept IncidenceVisitor.

A class taking part in the visitor mechanism has to provide this implementation:

        bool accept(Visitor &v) { return v.visit(this); }
      

Reimplemented in KCal::Journal.

Definition at line 141 of file incidence.h.

Referenced by KCal::ResourceCalendar::addIncidence().

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.

Referenced by KCal::DndFactory::createDrag(), KCal::ICalFormat::createScheduleMessage(), KCal::ICalFormat::fromString(), and KCal::ICalFormat::toICalString().

void Incidence::setReadOnly bool   )  [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 172 of file incidence.cpp.

References KCal::IncidenceBase::setReadOnly(), and KCal::Recurrence::setRecurReadOnly().

Referenced by KCal::ResourceKABC::doLoad().

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 158 of file incidence.cpp.

References KCal::CalFormat::createUniqueId(), setCreated(), KCal::IncidenceBase::setLastModified(), KCal::IncidenceBase::setPilotId(), setRevision(), setSchedulingID(), KCal::IncidenceBase::setSyncStatus(), and KCal::IncidenceBase::setUid().

Referenced by KCal::Calendar::dissociateOccurrence(), and KCal::DndFactory::pasteIncidence().

void Incidence::setCreated const QDateTime  ) 
 

Set creation date.

Definition at line 179 of file incidence.cpp.

Referenced by recreate(), KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent().

QDateTime Incidence::created  )  const
 

Return time and date of creation.

Definition at line 185 of file incidence.cpp.

Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo().

void Incidence::setRevision int  rev  ) 
 

Set the number of revisions this event has seen.

Definition at line 190 of file incidence.cpp.

References KCal::IncidenceBase::updated().

Referenced by recreate(), and KCal::VCalFormat::VEventToEvent().

int Incidence::revision  )  const
 

Return the number of revisions this event has seen.

Definition at line 198 of file incidence.cpp.

Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo().

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

Set starting date/time.

Reimplemented from KCal::IncidenceBase.

Reimplemented in KCal::Todo.

Definition at line 203 of file incidence.cpp.

References KCal::IncidenceBase::setDtStart(), and KCal::Recurrence::setRecurStart().

Referenced by KCal::Calendar::dissociateOccurrence(), KCal::ResourceKABC::doLoad(), KCal::DndFactory::pasteIncidence(), and KCal::VCalFormat::VEventToEvent().

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 188 of file incidence.h.

Referenced by KCal::CalendarLocal::appendRecurringAlarms(), and KCal::Alarm::time().

void Incidence::setDescription const QString description  ) 
 

Set the long description.

Definition at line 210 of file incidence.cpp.

References KCal::IncidenceBase::updated().

Referenced by KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent().

QString Incidence::description  )  const
 

Return long description.

Definition at line 217 of file incidence.cpp.

Referenced by KCal::VCalFormat::eventToVEvent(), KCal::VCalFormat::eventToVTodo(), and KCal::VCalFormat::VEventToEvent().

void Incidence::setSummary const QString summary  ) 
 

Set short summary.

Definition at line 223 of file incidence.cpp.

References KCal::IncidenceBase::updated().

Referenced by KCal::ResourceKABC::doLoad(), KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent().

QString Incidence::summary  )  const
 

Return short summary.

Definition at line 230 of file incidence.cpp.

Referenced by KCal::CalendarLocal::appendRecurringAlarms(), KCal::Event::dtEnd(), KCal::VCalFormat::eventToVEvent(), KCal::VCalFormat::eventToVTodo(), KCal::SelectDialog::SelectDialog(), and KCal::VCalFormat::VEventToEvent().

void Incidence::setCategories const QStringList categories  ) 
 

Set categories.

Definition at line 235 of file incidence.cpp.

References KCal::IncidenceBase::updated().

Referenced by KCal::ResourceKABC::doLoad(), KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent().

void Incidence::setCategories const QString catStr  ) 
 

Set categories based on a comma delimited string.

Definition at line 243 of file incidence.cpp.

References KCal::IncidenceBase::updated().

QStringList Incidence::categories  )  const
 

Return categories as a list of strings.

Definition at line 260 of file incidence.cpp.

Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo().

QString Incidence::categoriesStr  )  const
 

Return categories as a comma separated string.

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

References KCal::IncidenceBase::updated().

Referenced by KCal::Calendar::removeRelations(), setRelatedTo(), KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent().

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 277 of file incidence.cpp.

void Incidence::setRelatedTo Incidence relatedTo  ) 
 

Point at some other event to which the event relates.

Definition at line 282 of file incidence.cpp.

References removeRelation(), and setRelatedToUid().

Referenced by KCal::Calendar::dissociateOccurrence(), KCal::Calendar::removeRelations(), and KCal::Calendar::setupRelations().

Incidence * Incidence::relatedTo  )  const
 

What event does this one relate to?

Definition at line 295 of file incidence.cpp.

Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo().

Incidence::List Incidence::relations  )  const
 

All events that are related to this event.

Definition at line 300 of file incidence.cpp.

void Incidence::addRelation Incidence  ) 
 

Add an event which is related to this event.

Definition at line 305 of file incidence.cpp.

void Incidence::removeRelation Incidence  ) 
 

Remove event that is related to this event.

Definition at line 312 of file incidence.cpp.

References KCal::ListBase< T >::removeRef().

Referenced by setRelatedTo().

DateList Incidence::exDates  )  const
 

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

Definition at line 356 of file incidence.cpp.

Referenced by KCal::VCalFormat::eventToVEvent().

DateTimeList Incidence::exDateTimes  )  const
 

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

Definition at line 361 of file incidence.cpp.

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.

Definition at line 328 of file incidence.cpp.

References KCal::IncidenceBase::updated().

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.

Definition at line 335 of file incidence.cpp.

References KCal::IncidenceBase::updated().

void Incidence::addExDate const QDate date  ) 
 

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

Definition at line 342 of file incidence.cpp.

References KCal::IncidenceBase::updated().

Referenced by KCal::VCalFormat::VEventToEvent().

void Incidence::addExDateTime const QDateTime dateTime  ) 
 

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

Definition at line 349 of file incidence.cpp.

References KCal::IncidenceBase::updated().

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.

Definition at line 366 of file incidence.cpp.

Referenced by KCal::CalendarLocal::appendRecurringAlarms(), recursAt(), and recursOn().

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.

Definition at line 378 of file incidence.cpp.

void Incidence::addAttachment Attachment attachment  ) 
 

Add attachment.

Definition at line 390 of file incidence.cpp.

References KCal::IncidenceBase::updated().

Referenced by KCal::VCalFormat::VEventToEvent().

void Incidence::deleteAttachment Attachment attachment  ) 
 

Remove and delete a specific attachment.

Definition at line 397 of file incidence.cpp.

References KCal::ListBase< T >::removeRef().

void Incidence::deleteAttachments const QString mime  ) 
 

Remove and delete all attachments with this mime type.

Definition at line 402 of file incidence.cpp.

Attachment::List Incidence::attachments  )  const
 

Return list of all associated attachments.

Definition at line 411 of file incidence.cpp.

Referenced by attachments(), and KCal::VCalFormat::eventToVEvent().

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

Find a list of attachments with this mime type.

Definition at line 416 of file incidence.cpp.

References attachments().

void Incidence::clearAttachments  ) 
 

Remove and delete all attachments.

Definition at line 427 of file incidence.cpp.

void Incidence::setSecrecy int   ) 
 

Sets secrecy status.

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

Definition at line 502 of file incidence.cpp.

References KCal::IncidenceBase::updated().

Referenced by KCal::VCalFormat::VEventToEvent().

int Incidence::secrecy  )  const
 

Return the event's secrecy.

Definition at line 509 of file incidence.cpp.

Referenced by KCal::VCalFormat::eventToVEvent().

QString Incidence::secrecyStr  )  const
 

Return secrecy as translated string.

Definition at line 514 of file incidence.cpp.

References secrecyName().

QStringList Incidence::secrecyList  )  [static]
 

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

Definition at line 533 of file incidence.cpp.

References secrecyName().

QString Incidence::secrecyName int   )  [static]
 

Return human-readable translated name of secrecy class.

Definition at line 519 of file incidence.cpp.

Referenced by secrecyList(), and secrecyStr().

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 457 of file incidence.cpp.

References KCal::IncidenceBase::updated().

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 465 of file incidence.cpp.

References KCal::IncidenceBase::updated().

Incidence::Status Incidence::status  )  const
 

Return the event's status.

Definition at line 473 of file incidence.cpp.

QString Incidence::statusStr  )  const
 

Return the event's status string.

Definition at line 478 of file incidence.cpp.

References statusName().

QString Incidence::statusName Status   )  [static]
 

Return human-readable translated name of status value.

Definition at line 485 of file incidence.cpp.

Referenced by statusStr().

bool Incidence::recursOn const QDate qd  )  const
 

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

Definition at line 318 of file incidence.cpp.

References isException(), and KCal::Recurrence::recursOnPure().

Referenced by KCal::CalendarLocal::rawEventsForDate().

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 323 of file incidence.cpp.

References isException(), and KCal::Recurrence::recursAtPure().

void Incidence::setResources const QStringList resources  ) 
 

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

Definition at line 432 of file incidence.cpp.

References KCal::IncidenceBase::updated().

Referenced by KCal::VCalFormat::VEventToEvent().

QStringList Incidence::resources  )  const
 

Return list of current resources.

Definition at line 439 of file incidence.cpp.

Referenced by KCal::VCalFormat::eventToVEvent().

void Incidence::setPriority int  priority  ) 
 

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

Definition at line 445 of file incidence.cpp.

References KCal::IncidenceBase::updated().

Referenced by KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent().

int Incidence::priority  )  const
 

Return priority.

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

Definition at line 452 of file incidence.cpp.

Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo().

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

All alarms that are associated with this incidence.

Definition at line 544 of file incidence.cpp.

Referenced by KCal::CalendarLocal::appendAlarms(), KCal::CalendarLocal::appendRecurringAlarms(), KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo().

Alarm * Incidence::newAlarm  ) 
 

Create a new alarm which is associated with this incidence.

Definition at line 549 of file incidence.cpp.

Referenced by KCal::ResourceKABC::doLoad(), KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent().

void Incidence::addAlarm Alarm  ) 
 

Add an alarm which is associated with this incidence.

Definition at line 557 of file incidence.cpp.

References KCal::IncidenceBase::updated().

void Incidence::removeAlarm Alarm  ) 
 

Remove an alarm that is associated with this incidence.

Definition at line 563 of file incidence.cpp.

References KCal::ListBase< T >::removeRef(), and KCal::IncidenceBase::updated().

void Incidence::clearAlarms  ) 
 

Remove all alarms that are associated with this incidence.

Definition at line 569 of file incidence.cpp.

References KCal::IncidenceBase::updated().

Referenced by KCal::ResourceKABC::doLoad().

bool Incidence::isAlarmEnabled  )  const
 

Return whether any alarm associated with this incidence is enabled.

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

References KCal::IncidenceBase::dtStart(), KCal::Recurrence::setRecurReadOnly(), and KCal::Recurrence::setRecurStart().

Referenced by KCal::CalendarLocal::appendRecurringAlarms(), KCal::Calendar::dissociateOccurrence(), KCal::ResourceKABC::doLoad(), KCal::VCalFormat::eventToVEvent(), KCal::CalendarLocal::rawEvents(), KCal::Todo::setDtDue(), KCal::Todo::setDtStart(), and KCal::VCalFormat::VEventToEvent().

ushort Incidence::doesRecur  )  const
 

Forward to Recurrence::doesRecur().

Definition at line 608 of file incidence.cpp.

References KCal::Recurrence::doesRecur().

Referenced by KCal::CalendarLocal::alarms(), KCal::Todo::dtDue(), KCal::Todo::dtDueDateStr(), KCal::Todo::dtDueStr(), KCal::Todo::dtDueTimeStr(), KCal::Todo::dtStart(), KCal::CalendarLocal::rawEvents(), KCal::CalendarLocal::rawEventsForDate(), KCal::Todo::setDtDue(), KCal::Todo::setDtStart(), and KCal::Todo::setHasStartDate().

void Incidence::setLocation const QString location  ) 
 

Set the event's/todo's location.

Do _not_ use it with journal.

Definition at line 596 of file incidence.cpp.

References KCal::IncidenceBase::updated().

Referenced by KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent().

QString Incidence::location  )  const
 

Return the event's/todo's location.

Do _not_ use it with journal.

Definition at line 603 of file incidence.cpp.

Referenced by KCal::VCalFormat::eventToVEvent(), KCal::VCalFormat::eventToVTodo(), and KCal::SelectDialog::SelectDialog().

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 614 of file incidence.cpp.

Referenced by KCal::ICalFormat::createScheduleMessage(), and recreate().

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 619 of file incidence.cpp.

References KCal::IncidenceBase::uid().

Referenced by KCal::ICalFormat::createScheduleMessage().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for libkcal Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Aug 23 18:18:52 2007 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003