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 | |
enum | Status { StatusNone, StatusTentative, StatusConfirmed, StatusCompleted, StatusNeedsAction, StatusCanceled, StatusInProcess, StatusDraft, StatusFinal, StatusX } |
enum | { SecrecyPublic = 0, SecrecyPrivate = 1, SecrecyConfidential = 2 } |
typedef ListBase< Incidence > | List |
Public Member Functions | |
Incidence () | |
Incidence (const Incidence &) | |
~Incidence () | |
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
anonymous enum |
Member Function Documentation
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.
void Incidence::setReadOnly | ( | bool | readonly | ) | [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 168 of file incidence.cpp.
void Incidence::setFloats | ( | bool | f | ) |
Set whether the incidence floats, i.e.
has a date but no time attached to it.
Reimplemented from KCal::IncidenceBase.
Definition at line 175 of file incidence.cpp.
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 154 of file incidence.cpp.
void Incidence::setCreated | ( | const QDateTime & | ) |
QDateTime Incidence::created | ( | ) | const |
void Incidence::setRevision | ( | int | rev | ) |
int Incidence::revision | ( | ) | const |
void Incidence::setDtStart | ( | const QDateTime & | dtStart | ) | [virtual] |
Set starting date/time.
Reimplemented from KCal::IncidenceBase.
Reimplemented in KCal::Todo.
Definition at line 210 of file incidence.cpp.
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 149 of file incidence.h.
void Incidence::setDescription | ( | const QString & | description | ) |
QString Incidence::description | ( | ) | const |
void Incidence::setSummary | ( | const QString & | summary | ) |
QString Incidence::summary | ( | ) | const |
void Incidence::setCategories | ( | const QStringList & | categories | ) |
void Incidence::setCategories | ( | const QString & | catStr | ) |
QStringList Incidence::categories | ( | ) | const |
QString Incidence::categoriesStr | ( | ) | const |
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 279 of file incidence.cpp.
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 286 of file incidence.cpp.
void Incidence::setRelatedTo | ( | Incidence * | relatedTo | ) |
Incidence * Incidence::relatedTo | ( | ) | const |
Incidence::List Incidence::relations | ( | ) | const |
void Incidence::addRelation | ( | Incidence * | ) |
void Incidence::removeRelation | ( | Incidence * | ) |
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 333 of file incidence.cpp.
void Incidence::clearRecurrence | ( | ) |
bool Incidence::doesRecur | ( | ) | const |
bool Incidence::recursOn | ( | const QDate & | qd | ) | const [virtual] |
Returns true if the date specified is one on which the incidence will recur.
Reimplemented in KCal::Todo.
Definition at line 365 of file incidence.cpp.
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 370 of file incidence.cpp.
QValueList< QDateTime > Incidence::startDateTimesForDate | ( | const QDate & | date | ) | const [virtual] |
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).
- Parameters:
-
date the date where the incidence should occur
- Returns:
- the start date/time of all occurences that overlap with the given date. Empty list if the incidence does not overlap with the date at all
Definition at line 383 of file incidence.cpp.
QValueList< QDateTime > Incidence::startDateTimesForDateTime | ( | const QDateTime & | datetime | ) | const [virtual] |
Calculates the start date/time for all recurrences that happen at the given time.
- Parameters:
-
datetime the date/time where the incidence should occur
- Returns:
- the start date/time of all occurences that overlap with the given date/time. Empty list if the incidence does not happen at the given time at all.
Definition at line 430 of file incidence.cpp.
QDateTime Incidence::endDateForStart | ( | const QDateTime & | startDt | ) | const [virtual] |
Return the end time of the occurrence if it starts at the given date/time.
Definition at line 470 of file incidence.cpp.
void Incidence::addAttachment | ( | Attachment * | attachment | ) |
void Incidence::deleteAttachment | ( | Attachment * | attachment | ) |
void Incidence::deleteAttachments | ( | const QString & | mime | ) |
Remove and delete all attachments with this mime type.
Definition at line 583 of file incidence.cpp.
Attachment::List Incidence::attachments | ( | ) | const |
Attachment::List Incidence::attachments | ( | const QString & | mime | ) | const |
void Incidence::clearAttachments | ( | ) |
void Incidence::setSecrecy | ( | int | ) |
Sets secrecy status.
This can be Public, Private or Confidential. See separate enum.
Definition at line 683 of file incidence.cpp.
int Incidence::secrecy | ( | ) | const |
QString Incidence::secrecyStr | ( | ) | const |
QStringList Incidence::secrecyList | ( | ) | [static] |
Return list of all available secrecy states as list of translated strings.
Definition at line 714 of file incidence.cpp.
QString Incidence::secrecyName | ( | int | ) | [static] |
Return human-readable translated name of secrecy class.
Definition at line 700 of file incidence.cpp.
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 638 of file incidence.cpp.
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 646 of file incidence.cpp.
Incidence::Status Incidence::status | ( | ) | const |
QString Incidence::statusStr | ( | ) | const |
QString Incidence::statusName | ( | Status | ) | [static] |
Return human-readable translated name of status value.
Definition at line 666 of file incidence.cpp.
void Incidence::setResources | ( | const QStringList & | resources | ) |
QStringList Incidence::resources | ( | ) | const |
void Incidence::setPriority | ( | int | priority | ) |
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 626 of file incidence.cpp.
int Incidence::priority | ( | ) | const |
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 633 of file incidence.cpp.
const Alarm::List & Incidence::alarms | ( | ) | const |
Alarm * Incidence::newAlarm | ( | ) |
Create a new alarm which is associated with this incidence.
Definition at line 730 of file incidence.cpp.
void Incidence::addAlarm | ( | Alarm * | ) |
void Incidence::removeAlarm | ( | Alarm * | ) |
Remove an alarm that is associated with this incidence.
Definition at line 744 of file incidence.cpp.
void Incidence::clearAlarms | ( | ) |
Remove all alarms that are associated with this incidence.
Definition at line 750 of file incidence.cpp.
bool Incidence::isAlarmEnabled | ( | ) | const |
Return whether any alarm associated with this incidence is enabled.
Definition at line 756 of file incidence.cpp.
void Incidence::setLocation | ( | const QString & | location | ) |
Set the event's/todo's location.
Do _not_ use it with journal.
Definition at line 765 of file incidence.cpp.
QString Incidence::location | ( | ) | const |
Return the event's/todo's location.
Do _not_ use it with journal.
Definition at line 772 of file incidence.cpp.
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 777 of file incidence.cpp.
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 782 of file incidence.cpp.
void Incidence::recurrenceUpdated | ( | Recurrence * | ) | [virtual] |
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 793 of file incidence.cpp.
virtual QDateTime KCal::Incidence::endDateRecurrenceBase | ( | ) | const [inline, protected, virtual] |
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 450 of file incidence.h.
The documentation for this class was generated from the following files: