KCal::Incidence Class Reference
This class provides the base class common to all calendar components. More...
#include <incidence.h>
Inherits KCal::IncidenceBase.
Inherited by KCal::Event, KCal::Journal, and KCal::Todo.
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 Incidence * clone ()=0
- void setReadOnly (bool readonly)
- 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
- virtual 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
- 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
- class DeleteVisitor
Detailed Description
This class provides the base class common to all calendar components.
Member Enumeration Documentation
|
Enumeration for describing an event's status.
|
|
enumeration for describing an event's secrecy.
|
Member Function Documentation
|
Return copy of this object. The returned object is owned by the caller. Implemented in KCal::Event, KCal::Journal, and KCal::Todo. |
|
Set readonly state of incidence.
Reimplemented from KCal::IncidenceBase. |
|
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. |
|
Set creation date.
|
|
Return time and date of creation.
|
|
Set the number of revisions this event has seen.
|
|
Return the number of revisions this event has seen.
|
|
Set starting date/time.
Reimplemented from KCal::IncidenceBase. Reimplemented in KCal::Todo. |
|
Return the incidence's ending date/time as a QDateTime.
Reimplemented in KCal::Event. |
|
Set the long description.
|
|
Return long description.
|
|
Set short summary.
|
|
Return short summary.
|
|
Set categories.
|
|
Set categories based on a comma delimited string.
|
|
Return categories as a list of strings.
|
|
Return categories as a comma separated string.
|
|
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. |
|
What event does this one relate to? This function should only be used when constructing a calendar before the related Incidence exists.
|
|
Point at some other event to which the event relates.
|
|
What event does this one relate to?
|
|
All events that are related to this event.
|
|
Add an event which is related to this event.
|
|
Remove event that is related to this event.
|
|
Returns the list of dates which are exceptions to the recurrence rule.
|
|
Returns the list of date/times which are exceptions to the recurrence rule.
|
|
Sets the list of dates which are exceptions to the recurrence rule. This does not affect the date-time exception list. |
|
Sets the list of date/times which are exceptions to the recurrence rule. This does not affect the date-only exception list. |
|
Add a date to the list of exceptions of the recurrence rule.
|
|
Add a date/time to the list of exceptions of the recurrence rule.
|
|
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. |
|
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. |
|
Add attachment.
|
|
Remove and delete a specific attachment.
|
|
Remove and delete all attachments with this mime type.
|
|
Return list of all associated attachments.
|
|
Find a list of attachments with this mime type.
|
|
Remove and delete all attachments.
|
|
Sets secrecy status. This can be Public, Private or Confidential. See separate enum. |
|
Return the event's secrecy.
|
|
Return secrecy as translated string.
|
|
Return list of all available secrecy states as list of translated strings.
|
|
Return human-readable translated name of secrecy class.
|
|
Sets the incidence status to a standard status value. See separate enum. Note that StatusX cannot be specified. |
|
Sets the incidence status to a non-standard status value.
|
|
Return the event's status.
|
|
Return the event's status string.
|
|
Return human-readable translated name of status value.
|
|
Returns true if the date specified is one on which the incidence will recur.
Reimplemented in KCal::Todo. |
|
Returns true if the date/time specified is one on which the incidence will recur.
|
|
Set resources used, such as Office, Car, etc.
|
|
Return list of current resources.
|
|
Set the incidences priority, 0 is undefined, 1 highest (decreasing order).
|
|
Return priority. The priority is a number between 1 and 5. 1 is highest priority. |
|
All alarms that are associated with this incidence.
|
|
Create a new alarm which is associated with this incidence.
|
|
Add an alarm which is associated with this incidence.
|
|
Remove an alarm that is associated with this incidence.
|
|
Remove all alarms that are associated with this incidence.
|
|
Return whether any alarm associated with this incidence is enabled.
|
|
Return the recurrence rule associated with this incidence. If there is none, returns an appropriate (non-0) object. |
|
Forward to Recurrence::doesRecur().
|
|
Set the event's/todo's location. Do _not_ use it with journal. |
|
Return the event's/todo's location. Do _not_ use it with journal. |
|
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. |
|
Return the event's/todo's scheduling ID. Does not make sense for journals If this is not set, it will return uid(). |
The documentation for this class was generated from the following files:
- incidence.h
- incidence.cpp