KCalCore Library
incidence.cpp
Go to the documentation of this file.
This file is part of the API for handling calendar data and defines the CalFormat abstract base class...
Represents information related to an attachment for a Calendar Incidence.
Definition: attachment.h:60
QSharedPointer< Attachment > Ptr
A shared pointer to an Attachment object.
Definition: attachment.h:65
void setNonKDECustomProperty(const QByteArray &name, const QString &value, const QString ¶meters=QString())
Create or modify a non-KDE or non-standard custom calendar property.
Definition: customproperties.cpp:157
QString nonKDECustomPropertyParameters(const QByteArray &name) const
Return the parameters of a non-KDE or non-standard custom calendar property.
Definition: customproperties.cpp:187
void removeNonKDECustomProperty(const QByteArray &name)
Delete a non-KDE or non-standard custom calendar property.
Definition: customproperties.cpp:168
QString nonKDECustomProperty(const QByteArray &name) const
Return the value of a non-KDE or non-standard custom calendar property.
Definition: customproperties.cpp:182
static QLatin1String eventMimeType()
Returns the Akonadi specific sub MIME type of a KCalCore::Event.
Definition: event.cpp:348
An abstract class that provides a common base for all calendar incidence classes.
Definition: incidencebase.h:110
void updated()
Call this to notify the observers after the IncidenceBase object has changed.
Definition: incidencebase.cpp:604
bool allDay() const
Returns true or false depending on whether the incidence is all-day.
Definition: incidencebase.cpp:326
virtual void setLastModified(const KDateTime &lm)
Sets the time the incidence was last modified to lm.
Definition: incidencebase.cpp:240
@ FieldRecurrenceId
Field representing the longitude part of the GEO component.
Definition: incidencebase.h:181
@ FieldAttachment
Field representing the EXDATE, EXRULE, RDATE, and RRULE components.
Definition: incidencebase.h:173
@ FieldGeoLongitude
Field representing the latitude part of the GEO component.
Definition: incidencebase.h:180
virtual void shiftTimes(const KDateTime::Spec &oldSpec, const KDateTime::Spec &newSpec)
Shift the times of the incidence so that they appear at the same clock time as before but in a new ti...
Definition: incidencebase.cpp:344
virtual KDateTime dtStart() const
Returns an incidence's starting date/time as a KDateTime.
Definition: incidencebase.cpp:321
void update()
Call this to notify the observers after the IncidenceBase object will be changed.
Definition: incidencebase.cpp:593
virtual IncidenceBase & assign(const IncidenceBase &other)
Provides polymorfic assignment.
Definition: incidencebase.cpp:154
virtual void setDtStart(const KDateTime &dtStart)
Sets the incidence's starting date/time with a KDateTime.
Definition: incidencebase.cpp:306
void setFieldDirty(IncidenceBase::Field field)
Marks Field field as dirty.
Definition: incidencebase.cpp:657
virtual KDateTime dateTime(DateTimeRole role) const =0
Returns a date/time corresponding to the specified DateTimeRole.
void setUid(const QString &uid)
Sets the unique id for the incidence to uid.
Definition: incidencebase.cpp:227
void setAllDay(bool allDay)
Sets whether the incidence is all-day, i.e.
Definition: incidencebase.cpp:331
@ RoleRecurrenceStart
Role for determining the start of the recurrence.
Definition: incidencebase.h:147
virtual bool equals(const IncidenceBase &incidenceBase) const
Provides polymorfic comparison for equality.
Definition: incidencebase.cpp:179
Provides the abstract base class common to non-FreeBusy (Events, To-dos, Journals) calendar component...
Definition: incidence.h:70
QString relatedTo(RelType relType=RelTypeParent) const
Returns a UID string for the incidence that is related to this one.
Definition: incidence.cpp:544
virtual QList< KDateTime > startDateTimesForDateTime(const KDateTime &datetime) const
Calculates the start date/time for all recurrences that happen at the given time.
Definition: incidence.cpp:640
void setSchedulingID(const QString &sid, const QString &uid=QString())
Set the incidence scheduling ID.
Definition: incidence.cpp:962
void setAltDescription(const QString &altdescription)
Sets the incidence's alternative (=text/html) description.
Definition: incidence.cpp:1089
QString categoriesStr() const
Returns the incidence categories as a comma separated string.
Definition: incidence.cpp:526
bool locationIsRich() const
Returns true if incidence location contains RichText; false otherwise.
Definition: incidence.cpp:957
void setCustomStatus(const QString &status)
Sets the incidence Status to a non-standard status value.
Definition: incidence.cpp:832
void removeAlarm(const Alarm::Ptr &alarm)
Removes the specified alarm from the incidence.
Definition: incidence.cpp:896
void clearAttachments()
Removes all attachments and frees the memory used by them.
Definition: incidence.cpp:747
bool hasAltDescription() const
Returns true if the alternative (=text/html) description is available.
Definition: incidence.cpp:1081
QStringList categories() const
Returns the incidence categories as a list of strings.
Definition: incidence.cpp:521
void addAttachment(const Attachment::Ptr &attachment)
Adds an attachment to the incidence.
Definition: incidence.cpp:694
int revision() const
Returns the number of revisions this incidence has seen.
Definition: incidence.cpp:388
void setCreated(const KDateTime &dt)
Sets the incidence creation date/time.
Definition: incidence.cpp:357
void setLocation(const QString &location, bool isRich)
Sets the incidence location.
Definition: incidence.cpp:925
QString richLocation() const
Returns the incidence location in rich text format.
Definition: incidence.cpp:948
bool recursAt(const KDateTime &dt) const
Returns true if the date/time specified is one at which the event will recur.
Definition: incidence.cpp:594
bool hasRecurrenceId() const
Returns true if the incidence has recurrenceId, otherwise return false.
Definition: incidence.cpp:1034
void setGeoLongitude(float geolongitude)
Set the incidencesgeoLongitude.
Definition: incidence.cpp:1024
static QStringList mimeTypes()
Returns the list of possible mime types in an Incidence object: "text/calendar" "application/x-vnd....
Definition: incidence.cpp:1115
bool hasEnabledAlarms() const
Returns true if any of the incidence alarms are enabled; false otherwise.
Definition: incidence.cpp:915
void setLastModified(const KDateTime &lm)
Sets the time the incidence was last modified to lm.
Definition: incidence.cpp:318
void setSummary(const QString &summary, bool isRich)
Sets the incidence summary.
Definition: incidence.cpp:449
bool supportsGroupwareCommunication() const
Returns true if the incidence type supports groupware communication.
Definition: incidence.cpp:1109
void clearTempFiles()
Deletes all temporary files used by attachments and frees any memory in use by them.
Definition: incidence.cpp:775
void setRecurrenceId(const KDateTime &recurrenceId)
Set the incidences recurrenceId.
Definition: incidence.cpp:1054
void setStatus(Status status)
Sets the incidence status to a standard Status value.
Definition: incidence.cpp:819
virtual IncidenceBase & assign(const IncidenceBase &other)
Provides polymorfic assignment.
Definition: incidence.cpp:218
QStringList resources() const
Returns the incidence resources as a list of strings.
Definition: incidence.cpp:797
void setThisAndFuture(bool thisAndFuture)
Set to true if the exception also applies to all future occurrences.
Definition: incidence.cpp:1044
virtual QList< KDateTime > startDateTimesForDate(const QDate &date, const KDateTime::Spec &timeSpec=KDateTime::LocalZone) const
Calculates the start date/time for all recurrences that happen at some time on the given date (might ...
Definition: incidence.cpp:599
virtual void shiftTimes(const KDateTime::Spec &oldSpec, const KDateTime::Spec &newSpec)
Shift the times of the incidence so that they appear at the same clock time as before but in a new ti...
Definition: incidence.cpp:401
bool descriptionIsRich() const
Returns true if incidence description contains RichText; false otherwise.
Definition: incidence.cpp:444
void setResources(const QStringList &resources)
Sets a list of incidence resources.
Definition: incidence.cpp:785
QString altDescription() const
Returns the incidence alternative (=text/html) description.
Definition: incidence.cpp:1100
bool hasGeo() const
Returns true if the incidence has geo data, otherwise return false.
Definition: incidence.cpp:980
void deleteAttachments(const QString &mime)
Removes all attachments of the specified MIME type from the incidence.
Definition: incidence.cpp:717
QString richSummary() const
Returns the incidence summary in rich text format.
Definition: incidence.cpp:471
QString richDescription() const
Returns the incidence description in rich text format.
Definition: incidence.cpp:435
void deleteAttachment(const Attachment::Ptr &attachment)
Removes the specified attachment from the incidence.
Definition: incidence.cpp:708
void clearRecurrence()
Removes all recurrence and exception rules and dates.
Definition: incidence.cpp:564
Attachment::List attachments() const
Returns a list of all incidence attachments.
Definition: incidence.cpp:731
virtual void recurrenceUpdated(Recurrence *recurrence)
Observer interface for the recurrence class.
Definition: incidence.cpp:1067
Recurrence * recurrence() const
Returns the recurrence rule associated with this incidence.
Definition: incidence.cpp:551
QString instanceIdentifier() const
Returns a unique identifier for a specific instance of an incidence.
Definition: incidence.cpp:300
void setDescription(const QString &description, bool isRich)
Sets the incidence description.
Definition: incidence.cpp:413
void setRevision(int rev)
Sets the number of revisions this incidence has seen.
Definition: incidence.cpp:375
bool summaryIsRich() const
Returns true if incidence summary contains RichText; false otherwise.
Definition: incidence.cpp:480
void setCategories(const QStringList &categories)
Sets the incidence category list.
Definition: incidence.cpp:485
QString writeAttachmentToTempFile(const Attachment::Ptr &attachment) const
Writes the data in the attachment attachment to a temporary file and returns the local name of the te...
Definition: incidence.cpp:753
bool thisAndFuture() const
Returns true if the exception also applies to all future occurrences.
Definition: incidence.cpp:1049
virtual bool recursOn(const QDate &date, const KDateTime::Spec &timeSpec) const
Returns true if the date specified is one on which the event will recur.
Definition: incidence.cpp:588
void setRelatedTo(const QString &uid, RelType relType=RelTypeParent)
Relates another incidence to this one, by UID.
Definition: incidence.cpp:531
virtual bool equals(const IncidenceBase &incidence) const
Compares this with Incidence incidence for equality.
Definition: incidence.cpp:231
virtual KDateTime endDateForStart(const KDateTime &startDt) const
Returns the end date/time of the incidence occurrence if it starts at specified date/time.
Definition: incidence.cpp:680
virtual void setDtStart(const KDateTime &dt)
Sets the incidence starting date/time.
Definition: incidence.cpp:393
static QLatin1String journalMimeType()
Returns the Akonadi specific sub MIME type of a KCalCore::Journal.
Definition: journal.cpp:125
This class represents a recurrence rule for a calendar incidence.
Definition: recurrence.h:88
TimeList recurTimesOn(const QDate &date, const KDateTime::Spec &timeSpec) const
Returns a list of the times on the specified date at which the recurrence will occur.
Definition: recurrence.cpp:881
static QLatin1String todoMimeType()
Returns the Akonadi specific sub MIME type of a KCalCore::Todo.
Definition: todo.cpp:596
This file is part of the API for handling calendar data and defines the Incidence class.
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.