KCalCore Library
incidence.cpp
Go to the documentation of this file.
void setSummary(const QString &summary, bool isRich)
Sets the incidence summary.
Definition: incidence.cpp:449
void removeAlarm(const Alarm::Ptr &alarm)
Removes the specified alarm from the incidence.
Definition: incidence.cpp:896
Field representing the CREATED component.
Definition: incidencebase.h:187
QString nonKDECustomProperty(const QByteArray &name) const
Return the value of a non-KDE or non-standard custom calendar property.
Definition: customproperties.cpp:182
QSharedPointer< Attachment > Ptr
A shared pointer to an Attachment object.
Definition: attachment.h:65
void setCustomStatus(const QString &status)
Sets the incidence Status to a non-standard status value.
Definition: incidence.cpp:832
void setThisAndFuture(bool thisAndFuture)
Set to true if the exception also applies to all future occurrences.
Definition: incidence.cpp:1044
void deleteAttachment(const Attachment::Ptr &attachment)
Removes the specified attachment from the incidence.
Definition: incidence.cpp:708
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
void setStatus(Status status)
Sets the incidence status to a standard Status value.
Definition: incidence.cpp:819
QString altDescription() const
Returns the incidence alternative (=text/html) description.
Definition: incidence.cpp:1100
void setAltDescription(const QString &altdescription)
Sets the incidence's alternative (=text/html) description.
Definition: incidence.cpp:1089
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: recurrence.cpp:330
Field representing the longitude part of the GEO component.
Definition: incidencebase.h:181
virtual void setDtStart(const KDateTime &dtStart)
Sets the incidence's starting date/time with a KDateTime.
Definition: incidencebase.cpp:306
bool descriptionIsRich() const
Returns true if incidence description contains RichText; false otherwise.
Definition: incidence.cpp:444
void removeNonKDECustomProperty(const QByteArray &name)
Delete a non-KDE or non-standard custom calendar property.
Definition: customproperties.cpp:168
Field representing the LAST-MODIFIED component.
Definition: incidencebase.h:164
virtual bool equals(const IncidenceBase &incidence) const
Compares this with Incidence incidence for equality.
Definition: incidence.cpp:231
QString richSummary() const
Returns the incidence summary in rich text format.
Definition: incidence.cpp:471
void setUid(const QString &uid)
Sets the unique id for the incidence to uid.
Definition: incidencebase.cpp:227
bool locationIsRich() const
Returns true if incidence location contains RichText; false otherwise.
Definition: incidence.cpp:957
void setResources(const QStringList &resources)
Sets a list of incidence resources.
Definition: incidence.cpp:785
Field representing the CLASS component.
Definition: incidencebase.h:175
void setCategories(const QStringList &categories)
Sets the incidence category list.
Definition: incidence.cpp:485
Field representing the latitude part of the GEO component.
Definition: incidencebase.h:180
An abstract class that provides a common base for all calendar incidence classes. ...
Definition: incidencebase.h:109
bool summaryIsRich() const
Returns true if incidence summary contains RichText; false otherwise.
Definition: incidence.cpp:480
Recurrence * recurrence() const
Returns the recurrence rule associated with this incidence.
Definition: incidence.cpp:551
Field representing the VALARM component.
Definition: incidencebase.h:183
void update()
Call this to notify the observers after the IncidenceBase object will be changed. ...
Definition: incidencebase.cpp:593
static QStringList mimeTypes()
Returns the list of possible mime types in an Incidence object: "text/calendar" "application/x-vnd.akonadi.calendar.event" "application/x-vnd.akonadi.calendar.todo" "application/x-vnd.akonadi.calendar.journal".
Definition: incidence.cpp:1115
QString instanceIdentifier() const
Returns a unique identifier for a specific instance of an incidence.
Definition: incidence.cpp:300
Field representing the DESCRIPTION component.
Definition: incidencebase.h:165
int revision() const
Returns the number of revisions this incidence has seen.
Definition: incidence.cpp:388
void setGeoLongitude(float geolongitude)
Set the incidencesgeoLongitude.
Definition: incidence.cpp:1024
QStringList resources() const
Returns the incidence resources as a list of strings.
Definition: incidence.cpp:797
void clearTempFiles()
Deletes all temporary files used by attachments and frees any memory in use by them.
Definition: incidence.cpp:775
QString relatedTo(RelType relType=RelTypeParent) const
Returns a UID string for the incidence that is related to this one.
Definition: incidence.cpp:544
void setRecurrenceId(const KDateTime &recurrenceId)
Set the incidences recurrenceId.
Definition: incidence.cpp:1054
virtual bool equals(const IncidenceBase &incidenceBase) const
Provides polymorfic comparison for equality.
Definition: incidencebase.cpp:179
void setLastModified(const KDateTime &lm)
Definition: incidence.cpp:318
This file is part of the API for handling calendar data and defines the CalFormat abstract base class...
bool hasRecurrenceId() const
Returns true if the incidence has recurrenceId, otherwise return false.
Definition: incidence.cpp:1034
Field representing the TRANSPARENCY component.
Definition: incidencebase.h:177
void setRevision(int rev)
Sets the number of revisions this incidence has seen.
Definition: incidence.cpp:375
Field representing the DUE component.
Definition: incidencebase.h:170
QString richDescription() const
Returns the incidence description in rich text format.
Definition: incidence.cpp:435
Field representing the RELATED-TO component.
Definition: incidencebase.h:172
void deleteAttachments(const QString &mime)
Removes all attachments of the specified MIME type from the incidence.
Definition: incidence.cpp:717
ushort recurrenceType() const
Returns the event's recurrence status.
Definition: incidence.cpp:570
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
void setDescription(const QString &description, bool isRich)
Sets the incidence description.
Definition: incidence.cpp:413
Field representing the RECURRENCE-ID component.
Definition: incidencebase.h:182
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
void setCreated(const KDateTime &dt)
Sets the incidence creation date/time.
Definition: incidence.cpp:357
void updated()
Call this to notify the observers after the IncidenceBase object has changed.
Definition: incidencebase.cpp:604
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
This class represents a recurrence rule for a calendar incidence.
Definition: recurrence.h:87
Field representing the EXDATE, EXRULE, RDATE, and RRULE components.
Definition: incidencebase.h:173
bool hasAltDescription() const
Returns true if the alternative (=text/html) description is available.
Definition: incidence.cpp:1081
Field representing the ORGANIZER component.
Definition: incidencebase.h:186
bool thisAndFuture() const
Returns true if the exception also applies to all future occurrences.
Definition: incidence.cpp:1049
bool hasEnabledAlarms() const
Returns true if any of the incidence alarms are enabled; false otherwise.
Definition: incidence.cpp:915
QString richLocation() const
Returns the incidence location in rich text format.
Definition: incidence.cpp:948
virtual void setDtStart(const KDateTime &dt)
Sets the incidence starting date/time.
Definition: incidence.cpp:393
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
void setFieldDirty(IncidenceBase::Field field)
Marks Field field as dirty.
Definition: incidencebase.cpp:657
static QLatin1String journalMimeType()
Returns the Akonadi specific sub MIME type of a KCalCore::Journal.
Definition: journal.cpp:125
virtual void recurrenceUpdated(Recurrence *recurrence)
Observer interface for the recurrence class.
Definition: incidence.cpp:1067
void clearRecurrence()
Removes all recurrence and exception rules and dates.
Definition: incidence.cpp:564
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
Field representing the SUMMARY component.
Definition: incidencebase.h:166
void setGeoLatitude(float geolatitude)
Set the incidences geoLatitude.
Definition: incidence.cpp:1007
virtual KDateTime dtStart() const
Returns an incidence's starting date/time as a KDateTime.
Definition: incidencebase.cpp:321
Field representing the PRIORITY component.
Definition: incidencebase.h:179
static QLatin1String eventMimeType()
Returns the Akonadi specific sub MIME type of a KCalCore::Event.
Definition: event.cpp:348
virtual IncidenceBase & assign(const IncidenceBase &other)
Provides polymorfic assignment.
Definition: incidence.cpp:218
void setSchedulingID(const QString &sid, const QString &uid=QString())
Set the incidence scheduling ID.
Definition: incidence.cpp:962
static QLatin1String todoMimeType()
Returns the Akonadi specific sub MIME type of a KCalCore::Todo.
Definition: todo.cpp:596
virtual IncidenceBase & assign(const IncidenceBase &other)
Provides polymorfic assignment.
Definition: incidencebase.cpp:154
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
This file is part of the API for handling calendar data and defines the Incidence class...
Represents information related to an attachment for a Calendar Incidence.
Definition: attachment.h:59
virtual KDateTime dateTime(DateTimeRole role) const =0
Returns a date/time corresponding to the specified DateTimeRole.
bool hasGeo() const
Returns true if the incidence has geo data, otherwise return false.
Definition: incidence.cpp:980
void clearAttachments()
Removes all attachments and frees the memory used by them.
Definition: incidence.cpp:747
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
bool supportsGroupwareCommunication() const
Returns true if the incidence type supports groupware communication.
Definition: incidence.cpp:1109
Field representing the RESOURCES component.
Definition: incidencebase.h:178
Field representing the CATEGORIES component.
Definition: incidencebase.h:171
void setLocation(const QString &location, bool isRich)
Sets the incidence location.
Definition: incidence.cpp:925
Field representing the ATTACH component.
Definition: incidencebase.h:174
Attachment::List attachments() const
Returns a list of all incidence attachments.
Definition: incidence.cpp:731
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
QString nonKDECustomPropertyParameters(const QByteArray &name) const
Return the parameters of a non-KDE or non-standard custom calendar property.
Definition: customproperties.cpp:187
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
void setAllDay(bool allDay)
Sets whether the incidence is all-day, i.e.
Definition: incidencebase.cpp:331
QString categoriesStr() const
Returns the incidence categories as a comma separated string.
Definition: incidence.cpp:526
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 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
Provides the abstract base class common to non-FreeBusy (Events, To-dos, Journals) calendar component...
Definition: incidence.h:68
void setRelatedTo(const QString &uid, RelType relType=RelTypeParent)
Relates another incidence to this one, by UID.
Definition: incidence.cpp:531
Role for determining the start of the recurrence.
Definition: incidencebase.h:147
This file is part of the KDE documentation.
Documentation copyright © 1996-2016 The KDE developers.
Generated on Fri Oct 28 2016 11:52:06 by doxygen 1.8.12 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2016 The KDE developers.
Generated on Fri Oct 28 2016 11:52:06 by doxygen 1.8.12 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.