KCal::Incidence Class Reference
This class provides the base class common to all calendar components. More...
#include <incidence.h>
Inheritance diagram for KCal::Incidence:

Public Types | |
typedef ListBase< Incidence > | List |
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 Incidence * | clone ()=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) |
Incidence * | relatedTo () 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::List & | alarms () const |
Alarm * | newAlarm () |
void | addAlarm (Alarm *) |
void | removeAlarm (Alarm *) |
void | clearAlarms () |
bool | isAlarmEnabled () const |
Recurrence * | recurrence () const |
ushort | doesRecur () const |
void | setLocation (const QString &location) |
QString | location () const |
Static Public Member Functions | |
QStringList | secrecyList () |
QString | secrecyName (int) |
QString | statusName (Status) |
Detailed Description
This class provides the base class common to all calendar components.Definition at line 43 of file incidence.h.
Member Enumeration Documentation
|
Enumeration for describing an event's status. Definition at line 116 of file incidence.h. |
|
enumeration for describing an event's secrecy. Definition at line 124 of file incidence.h. |
Member Function Documentation
|
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(), KCal::Calendar::addIncidence(), and KCal::Calendar::deleteIncidence(). |
|
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::Calendar::dissociateOccurrence(), KCal::ICalFormat::fromString(), and KCal::ICalFormat::toICalString(). |
|
Set readonly state of incidence.
Reimplemented from KCal::IncidenceBase. Definition at line 167 of file incidence.cpp. References KCal::IncidenceBase::setReadOnly(). Referenced by KCal::ResourceKABC::doLoad(). |
|
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. References setCreated(), KCal::IncidenceBase::setLastModified(), KCal::IncidenceBase::setPilotId(), setRevision(), KCal::IncidenceBase::setSyncStatus(), and KCal::IncidenceBase::setUid(). Referenced by KCal::Calendar::dissociateOccurrence(), and KCal::DndFactory::pasteIncidence(). |
|
Set creation date. Definition at line 174 of file incidence.cpp. Referenced by recreate(), KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent(). |
|
Return time and date of creation. Definition at line 180 of file incidence.cpp. Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo(). |
|
Set the number of revisions this event has seen. Definition at line 185 of file incidence.cpp. References KCal::IncidenceBase::updated(). Referenced by recreate(), and KCal::VCalFormat::VEventToEvent(). |
|
Return the number of revisions this event has seen. Definition at line 193 of file incidence.cpp. Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo(). |
|
Set starting date/time.
Reimplemented from KCal::IncidenceBase.
Reimplemented in KCal::Todo. Definition at line 198 of file incidence.cpp. References KCal::IncidenceBase::setDtStart(). Referenced by KCal::Calendar::dissociateOccurrence(), KCal::ResourceKABC::doLoad(), KCal::DndFactory::pasteIncidence(), and KCal::VCalFormat::VEventToEvent(). |
|
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(). |
|
Set the long description. Definition at line 205 of file incidence.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent(). |
|
Return long description. Definition at line 212 of file incidence.cpp. Referenced by KCal::VCalFormat::eventToVEvent(), KCal::VCalFormat::eventToVTodo(), and KCal::VCalFormat::VEventToEvent(). |
|
Set short summary. Definition at line 218 of file incidence.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::ResourceKABC::doLoad(), KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent(). |
|
Return short summary. Definition at line 225 of file incidence.cpp. Referenced by KCal::CalendarLocal::appendRecurringAlarms(), KCal::Event::dtEnd(), KCal::VCalFormat::eventToVEvent(), KCal::VCalFormat::eventToVTodo(), and KCal::VCalFormat::VEventToEvent(). |
|
Set categories. Definition at line 230 of file incidence.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::ResourceKABC::doLoad(), KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent(). |
|
Set categories based on a comma delimited string. Definition at line 238 of file incidence.cpp. References KCal::IncidenceBase::updated(). |
|
Return categories as a list of strings. Definition at line 255 of file incidence.cpp. Referenced by KCal::VCalFormat::eventToVEvent(), KCal::VCalFormat::eventToVTodo(), and KCal::CalFilter::filterIncidence(). |
|
Return categories as a comma separated string. Definition at line 260 of file incidence.cpp. |
|
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 265 of file incidence.cpp. Referenced by KCal::Calendar::removeRelations(), KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent(). |
|
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 271 of file incidence.cpp. Referenced by KCal::Calendar::setupRelations(). |
|
Point at some other event to which the event relates. Definition at line 276 of file incidence.cpp. References addRelation(), and removeRelation(). Referenced by KCal::Calendar::dissociateOccurrence(), KCal::Calendar::removeRelations(), and KCal::Calendar::setupRelations(). |
|
What event does this one relate to? Definition at line 285 of file incidence.cpp. Referenced by KCal::VCalFormat::eventToVEvent(), KCal::VCalFormat::eventToVTodo(), KCal::Calendar::removeRelations(), and KCal::Calendar::setupRelations(). |
|
All events that are related to this event. Definition at line 290 of file incidence.cpp. Referenced by KCal::Calendar::removeRelations(). |
|
Add an event which is related to this event. Definition at line 295 of file incidence.cpp. References KCal::IncidenceBase::updated(). Referenced by setRelatedTo(), and KCal::Calendar::setupRelations(). |
|
Remove event that is related to this event. Definition at line 303 of file incidence.cpp. References KCal::ListBase< T >::removeRef(). Referenced by KCal::Calendar::removeRelations(), and setRelatedTo(). |
|
Returns the list of dates which are exceptions to the recurrence rule. Definition at line 347 of file incidence.cpp. Referenced by KCal::VCalFormat::eventToVEvent(). |
|
Returns the list of date/times which are exceptions to the recurrence rule. Definition at line 352 of file incidence.cpp. |
|
Sets the list of dates which are exceptions to the recurrence rule. This does not affect the date-time exception list. Definition at line 319 of file incidence.cpp. References KCal::IncidenceBase::updated(). |
|
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 326 of file incidence.cpp. References KCal::IncidenceBase::updated(). |
|
Add a date to the list of exceptions of the recurrence rule. Definition at line 333 of file incidence.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::Calendar::dissociateOccurrence(), and KCal::VCalFormat::VEventToEvent(). |
|
Add a date/time to the list of exceptions of the recurrence rule. Definition at line 340 of file incidence.cpp. References KCal::IncidenceBase::updated(). |
|
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 357 of file incidence.cpp. Referenced by KCal::CalendarLocal::appendRecurringAlarms(), recursAt(), and recursOn(). |
|
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 369 of file incidence.cpp. |
|
Add attachment. Definition at line 381 of file incidence.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::VCalFormat::VEventToEvent(). |
|
Remove and delete a specific attachment. Definition at line 388 of file incidence.cpp. References KCal::ListBase< T >::removeRef(). |
|
Remove and delete all attachments with this mime type. Definition at line 393 of file incidence.cpp. |
|
Return list of all associated attachments. Definition at line 402 of file incidence.cpp. Referenced by attachments(), and KCal::VCalFormat::eventToVEvent(). |
|
Find a list of attachments with this mime type. Definition at line 407 of file incidence.cpp. References attachments(). |
|
Remove and delete all attachments. Definition at line 418 of file incidence.cpp. |
|
Sets secrecy status. This can be Public, Private or Confidential. See separate enum. Definition at line 493 of file incidence.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::VCalFormat::VEventToEvent(). |
|
Return the event's secrecy. Definition at line 500 of file incidence.cpp. Referenced by KCal::VCalFormat::eventToVEvent(). |
|
Return secrecy as translated string. Definition at line 505 of file incidence.cpp. References secrecyName(). |
|
Return list of all available secrecy states as list of translated strings. Definition at line 524 of file incidence.cpp. References secrecyName(). |
|
Return human-readable translated name of secrecy class. Definition at line 510 of file incidence.cpp. Referenced by secrecyList(), and secrecyStr(). |
|
Sets the incidence status to a standard status value. See separate enum. Note that StatusX cannot be specified. Definition at line 448 of file incidence.cpp. References KCal::IncidenceBase::updated(). |
|
Sets the incidence status to a non-standard status value.
References KCal::IncidenceBase::updated(). |
|
Return the event's status. Definition at line 464 of file incidence.cpp. |
|
Return the event's status string. Definition at line 469 of file incidence.cpp. References statusName(). |
|
Return human-readable translated name of status value. Definition at line 476 of file incidence.cpp. Referenced by statusStr(). |
|
Returns true if the date specified is one on which the incidence will recur. Definition at line 309 of file incidence.cpp. References isException(). Referenced by KCal::CalendarLocal::rawEventsForDate(). |
|
Returns true if the date/time specified is one on which the incidence will recur. Definition at line 314 of file incidence.cpp. References isException(). |
|
Set resources used, such as Office, Car, etc. Definition at line 423 of file incidence.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::VCalFormat::VEventToEvent(). |
|
Return list of current resources. Definition at line 430 of file incidence.cpp. Referenced by KCal::VCalFormat::eventToVEvent(). |
|
Set the incidences priority, 0 is undefined, 1 highest (decreasing order). Definition at line 436 of file incidence.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent(). |
|
Return priority. The priority is a number between 1 and 5. 1 is highest priority. Definition at line 443 of file incidence.cpp. Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo(). |
|
All alarms that are associated with this incidence. Definition at line 535 of file incidence.cpp. Referenced by KCal::CalendarLocal::appendAlarms(), KCal::CalendarLocal::appendRecurringAlarms(), KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo(). |
|
Create a new alarm which is associated with this incidence. Definition at line 540 of file incidence.cpp. Referenced by KCal::ResourceKABC::doLoad(), KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent(). |
|
Add an alarm which is associated with this incidence. Definition at line 548 of file incidence.cpp. References KCal::IncidenceBase::updated(). |
|
Remove an alarm that is associated with this incidence. Definition at line 554 of file incidence.cpp. References KCal::ListBase< T >::removeRef(), and KCal::IncidenceBase::updated(). |
|
Remove all alarms that are associated with this incidence. Definition at line 560 of file incidence.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::ResourceKABC::doLoad(). |
|
Return whether any alarm associated with this incidence is enabled. Definition at line 566 of file incidence.cpp. |
|
Return the recurrence rule associated with this incidence. If there is none, returns an appropriate (non-0) object. Definition at line 575 of file incidence.cpp. References KCal::IncidenceBase::dtStart(). 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(). |
|
|
Set the event's/todo's location. Do _not_ use it with journal. Definition at line 587 of file incidence.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent(). |
|
Return the event's/todo's location. Do _not_ use it with journal. Definition at line 594 of file incidence.cpp. Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo(). |
The documentation for this class was generated from the following files: