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:448
virtual bool equals(const IncidenceBase &incidence) const
Compares this with Incidence incidence for equality.
Definition: incidence.cpp:230
void removeAlarm(const Alarm::Ptr &alarm)
Removes the specified alarm from the incidence.
Definition: incidence.cpp:895
Field representing the CREATED component.
Definition: incidencebase.h:185
QSharedPointer< Attachment > Ptr
A shared pointer to an Attachment object.
Definition: attachment.h:64
void setCustomStatus(const QString &status)
Sets the incidence Status to a non-standard status value.
Definition: incidence.cpp:831
void setThisAndFuture(bool thisAndFuture)
Set to true if the exception also applies to all future occurrences.
Definition: incidence.cpp:1043
void deleteAttachment(const Attachment::Ptr &attachment)
Removes the specified attachment from the incidence.
Definition: incidence.cpp:707
void setStatus(Status status)
Sets the incidence status to a standard Status value.
Definition: incidence.cpp:818
void setAltDescription(const QString &altdescription)
Sets the incidence's alternative (=text/html) description.
Definition: incidence.cpp:1087
QString altDescription() const
Returns the incidence alternative (=text/html) description.
Definition: incidence.cpp:1098
Field representing the longitude part of the GEO component.
Definition: incidencebase.h:179
virtual void setDtStart(const KDateTime &dtStart)
Sets the incidence's starting date/time with a KDateTime.
Definition: incidencebase.cpp:304
QString uid() const
Returns the unique id (uid) for the incidence.
Definition: incidencebase.cpp:233
void removeNonKDECustomProperty(const QByteArray &name)
Delete a non-KDE or non-standard custom calendar property.
Definition: customproperties.cpp:166
Field representing the LAST-MODIFIED component.
Definition: incidencebase.h:162
QStringList categories() const
Returns the incidence categories as a list of strings.
Definition: incidence.cpp:520
void setUid(const QString &uid)
Sets the unique id for the incidence to uid.
Definition: incidencebase.cpp:225
void setResources(const QStringList &resources)
Sets a list of incidence resources.
Definition: incidence.cpp:784
Field representing the CLASS component.
Definition: incidencebase.h:173
void setCategories(const QStringList &categories)
Sets the incidence category list.
Definition: incidence.cpp:484
Field representing the latitude part of the GEO component.
Definition: incidencebase.h:178
An abstract class that provides a common base for all calendar incidence classes. ...
Definition: incidencebase.h:107
QString instanceIdentifier() const
Returns a unique identifier for a specific instance of an incidence.
Definition: incidence.cpp:299
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:752
Field representing the VALARM component.
Definition: incidencebase.h:181
Recurrence * recurrence() const
Returns the recurrence rule associated with this incidence.
Definition: incidence.cpp:550
QString richDescription() const
Returns the incidence description in rich text format.
Definition: incidence.cpp:434
void update()
Call this to notify the observers after the IncidenceBase object will be changed. ...
Definition: incidencebase.cpp:580
bool hasRecurrenceId() const
Returns true if the incidence has recurrenceId, otherwise return false.
Definition: incidence.cpp:1033
Field representing the DESCRIPTION component.
Definition: incidencebase.h:163
void setGeoLongitude(float geolongitude)
Set the incidencesgeoLongitude.
Definition: incidence.cpp:1023
void clearTempFiles()
Deletes all temporary files used by attachments and frees any memory in use by them.
Definition: incidence.cpp:774
virtual bool equals(const IncidenceBase &incidenceBase) const
Provides polymorfic comparison for equality.
Definition: incidencebase.cpp:183
void setRecurrenceId(const KDateTime &recurrenceId)
Set the incidences recurrenceId.
Definition: incidence.cpp:1053
QString nonKDECustomProperty(const QByteArray &name) const
Return the value of a non-KDE or non-standard custom calendar property.
Definition: customproperties.cpp:180
QString categoriesStr() const
Returns the incidence categories as a comma separated string.
Definition: incidence.cpp:525
bool thisAndFuture() const
Returns true if the exception also applies to all future occurrences.
Definition: incidence.cpp:1048
void setLastModified(const KDateTime &lm)
Definition: incidence.cpp:317
This file is part of the API for handling calendar data and defines the CalFormat abstract base class...
Field representing the TRANSPARENCY component.
Definition: incidencebase.h:175
void setRevision(int rev)
Sets the number of revisions this incidence has seen.
Definition: incidence.cpp:374
Field representing the DUE component.
Definition: incidencebase.h:168
void deleteAttachments(const QString &mime)
Removes all attachments of the specified MIME type from the incidence.
Definition: incidence.cpp:716
void setDescription(const QString &description, bool isRich)
Sets the incidence description.
Definition: incidence.cpp:412
Field representing the RECURRENCE-ID component.
Definition: incidencebase.h:180
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:155
void setCreated(const KDateTime &dt)
Sets the incidence creation date/time.
Definition: incidence.cpp:356
void updated()
Call this to notify the observers after the IncidenceBase object has changed.
Definition: incidencebase.cpp:591
ushort recurrenceType() const
Returns the event's recurrence status.
Definition: incidence.cpp:569
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:679
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:171
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:331
Field representing the ORGANIZER component.
Definition: incidencebase.h:184
QStringList resources() const
Returns the incidence resources as a list of strings.
Definition: incidence.cpp:796
virtual void setDtStart(const KDateTime &dt)
Sets the incidence starting date/time.
Definition: incidence.cpp:392
bool allDay() const
Returns true or false depending on whether the incidence is all-day.
Definition: incidencebase.cpp:324
bool summaryIsRich() const
Returns true if incidence summary contains RichText; false otherwise.
Definition: incidence.cpp:479
bool descriptionIsRich() const
Returns true if incidence description contains RichText; false otherwise.
Definition: incidence.cpp:443
void setFieldDirty(IncidenceBase::Field field)
Marks Field field as dirty.
Definition: incidencebase.cpp:644
virtual void recurrenceUpdated(Recurrence *recurrence)
Observer interface for the recurrence class.
Definition: incidence.cpp:1066
bool hasGeo() const
Returns true if the incidence has geo data, otherwise return false.
Definition: incidence.cpp:979
void clearRecurrence()
Removes all recurrence and exception rules and dates.
Definition: incidence.cpp:563
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:400
Field representing the SUMMARY component.
Definition: incidencebase.h:164
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:639
void setGeoLatitude(float geolatitude)
Set the incidences geoLatitude.
Definition: incidence.cpp:1006
QString richLocation() const
Returns the incidence location in rich text format.
Definition: incidence.cpp:947
Field representing the PRIORITY component.
Definition: incidencebase.h:177
bool supportsGroupwareCommunication() const
Returns true if the incidence type supports groupware communication.
Definition: incidence.cpp:1107
virtual IncidenceBase & assign(const IncidenceBase &other)
Provides polymorfic assignment.
Definition: incidence.cpp:217
int revision() const
Returns the number of revisions this incidence has seen.
Definition: incidence.cpp:387
QString relatedTo(RelType relType=RelTypeParent) const
Returns a UID string for the incidence that is related to this one.
Definition: incidence.cpp:543
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:587
void setSchedulingID(const QString &sid, const QString &uid=QString())
Set the incidence scheduling ID.
Definition: incidence.cpp:961
bool locationIsRich() const
Returns true if incidence location contains RichText; false otherwise.
Definition: incidence.cpp:956
bool hasAltDescription() const
Returns true if the alternative (=text/html) description is available.
Definition: incidence.cpp:1079
virtual IncidenceBase & assign(const IncidenceBase &other)
Provides polymorfic assignment.
Definition: incidencebase.cpp:149
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:58
virtual KDateTime dateTime(DateTimeRole role) const =0
Returns a date/time corresponding to the specified DateTimeRole.
Attachment::List attachments() const
Returns a list of all incidence attachments.
Definition: incidence.cpp:730
void clearAttachments()
Removes all attachments and frees the memory used by them.
Definition: incidence.cpp:746
virtual void setLastModified(const KDateTime &lm)
Sets the time the incidence was last modified to lm.
Definition: incidencebase.cpp:238
Field representing the RESOURCES component.
Definition: incidencebase.h:176
Field representing the CATEGORIES component.
Definition: incidencebase.h:169
void setLocation(const QString &location, bool isRich)
Sets the incidence location.
Definition: incidence.cpp:924
Field representing the ATTACH component.
Definition: incidencebase.h:172
QString nonKDECustomPropertyParameters(const QByteArray &name) const
Return the parameters of a non-KDE or non-standard custom calendar property.
Definition: customproperties.cpp:185
bool hasEnabledAlarms() const
Returns true if any of the incidence alarms are enabled; false otherwise.
Definition: incidence.cpp:914
void addAttachment(const Attachment::Ptr &attachment)
Adds an attachment to the incidence.
Definition: incidence.cpp:693
void setAllDay(bool allDay)
Sets whether the incidence is all-day, i.e.
Definition: incidencebase.cpp:329
bool recursAt(const KDateTime &dt) const
Returns true if the date/time specified is one at which the event will recur.
Definition: incidence.cpp:593
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:342
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:882
Provides the abstract base class common to non-FreeBusy (Events, To-dos, Journals) calendar component...
Definition: incidence.h:68
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:598
virtual KDateTime dtStart() const
Returns an incidence's starting date/time as a KDateTime.
Definition: incidencebase.cpp:319
void setRelatedTo(const QString &uid, RelType relType=RelTypeParent)
Relates another incidence to this one, by UID.
Definition: incidence.cpp:530
QString richSummary() const
Returns the incidence summary in rich text format.
Definition: incidence.cpp:470
Role for determining the start of the recurrence.
Definition: incidencebase.h:145
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Tue Nov 26 2013 09:02:04 by doxygen 1.8.5 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2013 The KDE developers.
Generated on Tue Nov 26 2013 09:02:04 by doxygen 1.8.5 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.