libkcal
KCal::Incidence Class Reference
#include <incidence.h>
Inheritance diagram for KCal::Incidence:

Detailed Description
This class provides the base class common to all calendar components.
Definition at line 43 of file incidence.h.
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 () | |
Incidence (const Incidence &) | |
~Incidence () | |
Incidence & | operator= (const Incidence &i) |
bool | operator== (const Incidence &) const |
virtual Incidence * | clone ()=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) |
Incidence * | relatedTo () const |
Incidence::List | relations () const |
void | addRelation (Incidence *) |
void | removeRelation (Incidence *) |
Recurrence * | recurrence () 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::List & | alarms () const |
Alarm * | newAlarm () |
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 secrecy.
Reimplemented from KCal::IncidenceBase. Definition at line 91 of file incidence.h. |
|
Enumeration for describing an event's status.
Definition at line 83 of file incidence.h. |
Member Function Documentation
|
Add an alarm which is associated with this incidence.
Definition at line 785 of file incidence.cpp. |
|
Add attachment.
Definition at line 618 of file incidence.cpp. |
|
Add an event which is related to this event.
Definition at line 360 of file incidence.cpp. |
|
All alarms that are associated with this incidence.
Definition at line 772 of file incidence.cpp. |
|
Find a list of attachments with this mime type.
Definition at line 644 of file incidence.cpp. |
|
Return list of all associated attachments.
Definition at line 639 of file incidence.cpp. |
|
Return categories as a list of strings.
Definition at line 313 of file incidence.cpp. |
|
Return categories as a comma separated string.
Definition at line 318 of file incidence.cpp. |
|
Remove all alarms that are associated with this incidence.
Definition at line 797 of file incidence.cpp. |
|
Remove and delete all attachments.
Definition at line 655 of file incidence.cpp. |
|
Removes all recurrence and exception rules and dates.
Definition at line 394 of file incidence.cpp. |
|
Return copy of this object. The returned object is owned by the caller. Implemented in KCal::Event, KCal::Journal, and KCal::Todo. |
|
Return time and date of creation.
Definition at line 236 of file incidence.cpp. |
|
Remove and delete a specific attachment.
Definition at line 625 of file incidence.cpp. |
|
Remove and delete all attachments with this mime type.
Definition at line 630 of file incidence.cpp. |
|
Return long description.
Definition at line 270 of file incidence.cpp. |
|
Forward to Recurrence::doesRecur().
Definition at line 406 of file incidence.cpp. |
|
Return the incidence's ending date/time as a QDateTime.
Reimplemented in KCal::Event. Definition at line 150 of file incidence.h. |
|
Return the end time of the occurrence if it starts at the given date/time.
Definition at line 517 of file incidence.cpp. |
|
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 451 of file incidence.h. |
|
Return whether any alarm associated with this incidence is enabled.
Definition at line 803 of file incidence.cpp. |
|
Return the event's/todo's location. Do _not_ use it with journal. Definition at line 819 of file incidence.cpp. |
|
Create a new alarm which is associated with this incidence.
Definition at line 777 of file incidence.cpp. |
|
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 680 of file incidence.cpp. |
|
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 198 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 380 of file incidence.cpp. |
|
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 840 of file incidence.cpp. |
|
Returns true if the date/time specified is one on which the incidence will recur.
Definition at line 417 of file incidence.cpp. |
|
Returns true if the date specified is one on which the incidence will recur.
Reimplemented in KCal::Todo. Definition at line 412 of file incidence.cpp. |
|
What event does this one relate to?
Definition at line 350 of file incidence.cpp. |
|
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 330 of file incidence.cpp. |
|
All events that are related to this event.
Definition at line 355 of file incidence.cpp. |
|
Remove an alarm that is associated with this incidence.
Definition at line 791 of file incidence.cpp. |
|
Remove event that is related to this event.
Definition at line 367 of file incidence.cpp. |
|
Return list of current resources.
Definition at line 667 of file incidence.cpp. |
|
Return the number of revisions this event has seen.
Definition at line 249 of file incidence.cpp. |
|
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 829 of file incidence.cpp. |
|
Return the event's secrecy.
Definition at line 737 of file incidence.cpp. |
|
Return list of all available secrecy states as list of translated strings.
Definition at line 761 of file incidence.cpp. |
|
Return human-readable translated name of secrecy class.
Definition at line 747 of file incidence.cpp. |
|
Return secrecy as translated string.
Definition at line 742 of file incidence.cpp. |
|
Set categories based on a comma delimited string.
Definition at line 296 of file incidence.cpp. |
|
Set categories.
Definition at line 288 of file incidence.cpp. |
|
Set creation date.
Definition at line 227 of file incidence.cpp. |
|
Sets the incidence status to a non-standard status value.
Definition at line 693 of file incidence.cpp. |
|
Set the long description.
Definition at line 263 of file incidence.cpp. |
|
Set starting date/time.
Reimplemented from KCal::IncidenceBase. Reimplemented in KCal::Todo. Definition at line 254 of file incidence.cpp. |
|
Set whether the incidence floats, i.e. has a date but no time attached to it. Reimplemented from KCal::IncidenceBase. Definition at line 219 of file incidence.cpp. |
|
Set the event's/todo's location. Do _not_ use it with journal. Definition at line 812 of file incidence.cpp. |
|
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 673 of file incidence.cpp. |
|
Set readonly state of incidence.
Reimplemented from KCal::IncidenceBase. Definition at line 212 of file incidence.cpp. |
|
Point at some other event to which the event relates.
Definition at line 335 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 323 of file incidence.cpp. |
|
Set resources used, such as Office, Car, etc.
Definition at line 660 of file incidence.cpp. |
|
Set the number of revisions this event has seen.
Definition at line 241 of file incidence.cpp. |
|
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 824 of file incidence.cpp. |
|
Sets secrecy status. This can be Public, Private or Confidential. See separate enum. Definition at line 730 of file incidence.cpp. |
|
Sets the incidence status to a standard status value. See separate enum. Note that StatusX cannot be specified. Definition at line 685 of file incidence.cpp. |
|
Set short summary.
Definition at line 276 of file incidence.cpp. |
|
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).
Definition at line 430 of file incidence.cpp. |
|
Calculates the start date/time for all recurrences that happen at the given time.
Definition at line 477 of file incidence.cpp. |
|
Return the event's status.
Definition at line 701 of file incidence.cpp. |
|
Return human-readable translated name of status value.
Definition at line 713 of file incidence.cpp. |
|
Return the event's status string.
Definition at line 706 of file incidence.cpp. |
|
Return short summary.
Definition at line 283 of file incidence.cpp. |
The documentation for this class was generated from the following files: