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 | { 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 () |
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 |
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) |
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 secrecy.
Definition at line 116 of file incidence.h. |
Member Function Documentation
|
Accept IncidenceVisitor. A class taking part in the visitor mechanism has to provide this implementation:
|
|
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::fromString(), and KCal::ICalFormat::toICalString(). |
|
Set readonly state of incidence.
Reimplemented from KCal::IncidenceBase. Definition at line 151 of file incidence.cpp. References KCal::IncidenceBase::setReadOnly(). Referenced by KCal::ResourceKABC::load(). |
|
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 140 of file incidence.cpp. References setCreated(), KCal::IncidenceBase::setLastModified(), setRevision(), and KCal::IncidenceBase::setUid(). Referenced by KCal::DndFactory::pasteIncidence(). |
|
Set creation date.
Definition at line 158 of file incidence.cpp. Referenced by recreate(), KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent(). |
|
Return time and date of creation.
Definition at line 164 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 169 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 177 of file incidence.cpp. Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo(). |
|
Set starting date/time.
Reimplemented from KCal::IncidenceBase. Definition at line 182 of file incidence.cpp. References KCal::IncidenceBase::setDtStart(). Referenced by KCal::ResourceKABC::load(), KCal::DndFactory::pasteIncidence(), KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent(). |
|
Return the incidence's ending date/time as a QDateTime.
Reimplemented in KCal::Event. Definition at line 180 of file incidence.h. Referenced by KCal::CalendarLocal::appendRecurringAlarms(), and KCal::Alarm::time(). |
|
Set the long description.
Definition at line 189 of file incidence.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent(). |
|
Return long description.
Definition at line 196 of file incidence.cpp. Referenced by KCal::VCalFormat::eventToVEvent(), KCal::VCalFormat::eventToVTodo(), and KCal::VCalFormat::VEventToEvent(). |
|
Set short summary.
Definition at line 202 of file incidence.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::ResourceKABC::load(), KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent(). |
|
Return short summary.
Definition at line 209 of file incidence.cpp. Referenced by KCal::CalendarLocal::appendAlarms(), KCal::CalendarLocal::appendRecurringAlarms(), KCal::Event::dtEnd(), KCal::VCalFormat::eventToVEvent(), KCal::VCalFormat::eventToVTodo(), and KCal::VCalFormat::VEventToEvent(). |
|
Set categories.
Definition at line 214 of file incidence.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::ResourceKABC::load(), KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent(). |
|
Set categories based on a comma delimited string.
Definition at line 222 of file incidence.cpp. References KCal::IncidenceBase::updated(). |
|
Return categories as a list of strings.
Definition at line 239 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 244 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 249 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 255 of file incidence.cpp. Referenced by KCal::Calendar::setupRelations(). |
|
Point at some other event to which the event relates.
Definition at line 260 of file incidence.cpp. References addRelation(), and removeRelation(). Referenced by KCal::Calendar::removeRelations(), and KCal::Calendar::setupRelations(). |
|
What event does this one relate to?
Definition at line 269 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 274 of file incidence.cpp. Referenced by KCal::Calendar::removeRelations(). |
|
Add an event which is related to this event.
Definition at line 279 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 287 of file incidence.cpp. Referenced by KCal::Calendar::removeRelations(), and setRelatedTo(). |
|
Returns the list of dates which are exceptions to the recurrence rule.
Definition at line 331 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 336 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 303 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 310 of file incidence.cpp. References KCal::IncidenceBase::updated(). |
|
Add a date to the list of exceptions of the recurrence rule.
Definition at line 317 of file incidence.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::VCalFormat::VEventToEvent(). |
|
Add a date/time to the list of exceptions of the recurrence rule.
Definition at line 324 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 341 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 353 of file incidence.cpp. |
|
Add attachment.
Definition at line 365 of file incidence.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::VCalFormat::VEventToEvent(). |
|
Remove and delete a specific attachment.
Definition at line 372 of file incidence.cpp. |
|
Remove and delete all attachments with this mime type.
Definition at line 377 of file incidence.cpp. |
|
Return list of all associated attachments.
Definition at line 386 of file incidence.cpp. Referenced by attachments(), and KCal::VCalFormat::eventToVEvent(). |
|
Find a list of attachments with this mime type.
Definition at line 391 of file incidence.cpp. References attachments(). |
|
Remove and delete all attachments.
Definition at line 402 of file incidence.cpp. |
|
Sets secrecy status. This can be Public, Private or Confidential. See separate enum. Definition at line 432 of file incidence.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::VCalFormat::VEventToEvent(). |
|
Return the event's secrecy.
Definition at line 439 of file incidence.cpp. Referenced by KCal::VCalFormat::eventToVEvent(). |
|
Return secrecy as translated string.
Definition at line 444 of file incidence.cpp. References secrecyName(). |
|
Return list of all available secrecy states as list of translated strings.
Definition at line 467 of file incidence.cpp. References secrecyName(). |
|
Return human-readable translated name of secrecy class.
Definition at line 449 of file incidence.cpp. Referenced by secrecyList(), and secrecyStr(). |
|
Returns true if the date specified is one on which the incidence will recur.
Definition at line 293 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 298 of file incidence.cpp. References isException(). |
|
Set resources used, such as Office, Car, etc.
Definition at line 407 of file incidence.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::VCalFormat::VEventToEvent(). |
|
Return list of current resources.
Definition at line 414 of file incidence.cpp. Referenced by KCal::VCalFormat::eventToVEvent(). |
|
Set the incidences priority, 0 is undefined, 1 highest (decreasing order).
Definition at line 420 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 427 of file incidence.cpp. Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo(). |
|
All alarms that are associated with this incidence.
Definition at line 478 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 483 of file incidence.cpp. Referenced by KCal::ResourceKABC::load(), KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent(). |
|
Add an alarm which is associated with this incidence.
Definition at line 491 of file incidence.cpp. References KCal::IncidenceBase::updated(). |
|
Remove an alarm that is associated with this incidence.
Definition at line 497 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 503 of file incidence.cpp. References KCal::IncidenceBase::updated(). Referenced by KCal::ResourceKABC::load(). |
|
Return whether any alarm associated with this incidence is enabled.
Definition at line 509 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 518 of file incidence.cpp. References KCal::IncidenceBase::dtStart(). Referenced by KCal::CalendarLocal::appendRecurringAlarms(), KCal::VCalFormat::eventToVEvent(), KCal::ResourceKABC::load(), KCal::CalendarLocal::rawEvents(), and KCal::VCalFormat::VEventToEvent(). |
|
Forward to Recurrence::doesRecur().
Definition at line 542 of file incidence.cpp. Referenced by KCal::CalendarLocal::alarms(), KCal::CalFilter::filterEvent(), KCal::CalendarLocal::rawEvents(), and KCal::CalendarLocal::rawEventsForDate(). |
|
Set the event's/todo's location. Do _not_ use it with journal. Definition at line 530 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 537 of file incidence.cpp. Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo(). |
The documentation for this class was generated from the following files: