KCal Library
incidence.cpp
Go to the documentation of this file.
void setResources(const QStringList &resources)
Sets a list of incidence resources.
Definition: incidence.cpp:770
void setLastModified(const KDateTime &lm)
Sets the time the incidence was last modified to lm.
Definition: incidencebase.cpp:189
void removeAlarm(Alarm *alarm)
Removes the specified alarm from the incidence.
Definition: incidence.cpp:924
QString richLocation() const
Returns the incidence location in rich text format.
Definition: incidence.cpp:967
virtual KDateTime endDateRecurrenceBase() const
Returns the end date/time of the base incidence (e.g.
Definition: incidence.h:880
void setLocation(const QString &location, bool isRich)
Sets the incidence location.
Definition: incidence.cpp:946
const Alarm::List & alarms() const
Returns a list of all incidence alarms.
Definition: incidence.cpp:906
void deleteAttachment(Attachment *attachment)
Removes the specified attachment from the incidence.
Definition: incidence.cpp:698
virtual void shiftTimes(const KDateTime::Spec &oldSpec, const KDateTime::Spec &newSpec)
Definition: incidence.cpp:363
void setCreated(const KDateTime &dt)
Sets the incidence creation date/time.
Definition: incidence.cpp:316
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:334
int revision() const
Returns the number of revisions this incidence has seen.
Definition: incidence.cpp:344
void setGeoLongitude(float geolongitude)
Set the incidencesgeoLongitude.
Definition: incidence.cpp:1030
QStringList resources() const
Returns the incidence resources as a list of strings.
Definition: incidence.cpp:780
virtual void recurrenceUpdated(Recurrence *recurrence)
Observer interface for the recurrence class.
Definition: incidence.cpp:1043
static QString secrecyName(Secrecy secrecy)
Returns the translated string form of a specified Secrecy.
Definition: incidence.cpp:882
An abstract class that provides a common base for all calendar incidence classes.
Definition: incidencebase.h:102
void updated()
Call this to notify the observers after the IncidenceBase object has changed.
Definition: incidencebase.cpp:475
void setAllDay(bool allDay)
Sets whether the dtstart is a all-day (i.e.
Definition: recurrence.cpp:186
void clearRecurrence()
Removes all recurrence and exception rules and dates.
Definition: incidence.cpp:558
QString statusStr() const
Returns the incidence Status as translated string.
Definition: incidence.cpp:827
static QStringList secrecyList()
Returns a list of all available Secrecy types as a list of translated strings.
Definition: incidence.cpp:896
void clearAttachments()
Removes all attachments and frees the memory used by them.
Definition: incidence.cpp:732
bool isAlarmEnabled() const
Returns true if any of the incidence alarms are enabled; false otherwise.
Definition: incidence.cpp:936
static QString statusName(Status status)
Returns the translated string form of a specified Status.
Definition: incidence.cpp:836
QString relatedToUid() const
Returns a UID string for the incidence that is related to this one.
Definition: incidence.cpp:492
Status
Template for a class that implements a visitor for adding an Incidence to a resource supporting addEv...
Definition: incidence.h:146
void addRelation(Incidence *incidence)
Adds an incidence that is related to this one.
Definition: incidence.cpp:526
This file is part of the API for handling calendar data and defines the CalFormat abstract base class...
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:324
QString writeAttachmentToTempFile(Attachment *attachment) const
Writes the data in the attachment attachment to a temporary file and returns the local name of the te...
Definition: incidence.cpp:737
void setDescription(const QString &description, bool isRich)
Sets the incidence description.
Definition: incidence.cpp:375
bool enabled() const
Returns the alarm enabled status: true (enabled) or false (disabled).
Definition: alarm.cpp:586
virtual void setDtStart(const KDateTime &dtStart)
Sets the incidence's starting date/time with a KDateTime.
Definition: incidencebase.cpp:240
void setCustomStatus(const QString &status)
Sets the incidence Status to a non-standard status value.
Definition: incidence.cpp:811
Recurrence * recurrence() const
Returns the recurrence rule associated with this incidence.
Definition: incidence.cpp:545
void setRelatedToUid(const QString &uid)
Relates another incidence to this one, by UID.
Definition: incidence.cpp:483
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:674
bool hasGeo() const
Returns true if the incidence has geo data, otherwise return false.
Definition: incidence.cpp:995
void setStatus(Status status)
Sets the incidence status to a standard Status value.
Definition: incidence.cpp:800
Provides the abstract base class common to non-FreeBusy (Events, To-dos, Journals) calendar component...
Definition: incidence.h:68
QStringList categories() const
Returns the incidence categories as a list of strings.
Definition: incidence.cpp:473
Represents information related to an attachment for a Calendar Incidence.
Definition: attachment.h:57
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:593
void setUid(const QString &uid)
Returns the type of Incidence as a translated string.
Definition: incidencebase.cpp:178
void setRelatedTo(Incidence *incidence)
Relates another incidence to this one.
Definition: incidence.cpp:497
QString categoriesStr() const
Returns the incidence categories as a comma separated string.
Definition: incidence.cpp:478
bool summaryIsRich() const
Returns true if incidence summary contains RichText; false otherwise.
Definition: incidence.cpp:438
virtual bool recursOn(const QDate &date, const KDateTime::Spec &timeSpec) const
Definition: incidence.cpp:582
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
QString richSummary() const
Returns the incidence summary in rich text format.
Definition: incidence.cpp:429
void addAttachment(Attachment *attachment)
Adds an attachment to the incidence.
Definition: incidence.cpp:688
This file is part of the API for handling calendar data and defines the Incidence class.
void setRevision(int rev)
Sets the number of revisions this incidence has seen.
Definition: incidence.cpp:333
IncidenceBase & operator=(const IncidenceBase &other)
Assignment operator.
Definition: incidencebase.cpp:131
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:634
bool allDay() const
Returns true or false depending on whether the incidence is all-day.
Definition: incidencebase.cpp:310
QString richDescription() const
Returns the incidence description in rich text format.
Definition: incidence.cpp:395
bool operator==(const Incidence &incidence) const
Compares this with Incidence ib for equality.
Definition: incidence.cpp:235
void setSchedulingID(const QString &sid)
Set the incidence scheduling ID.
Definition: incidence.cpp:981
Attachment::List attachments() const
Returns a list of all incidence attachments.
Definition: incidence.cpp:715
bool descriptionIsRich() const
Returns true if incidence description contains RichText; false otherwise.
Definition: incidence.cpp:404
void setSummary(const QString &summary, bool isRich)
Sets the incidence summary.
Definition: incidence.cpp:409
void removeRelation(Incidence *incidence)
Removes an incidence that is related to this one.
Definition: incidence.cpp:533
Incidence::List relations() const
Returns a list of all incidences related to this one.
Definition: incidence.cpp:521
Incidence * relatedTo() const
Returns a pointer for the incidence that is related to this one.
Definition: incidence.cpp:516
bool locationIsRich() const
Returns true if incidence location contains RichText; false otherwise.
Definition: incidence.cpp:976
char * data() const
Returns a pointer to a character string containing the base64 encoded binary data of the attachment.
Definition: attachment.cpp:128
void setAllDay(bool allDay)
Sets whether the incidence is all-day, i.e.
Definition: incidencebase.cpp:315
virtual KDateTime dtStart() const
Returns an incidence's starting date/time as a KDateTime.
Definition: incidencebase.cpp:248
void setCategories(const QStringList &categories)
Sets the incidence category list.
Definition: incidence.cpp:443
This class represents a recurrence rule for a calendar incidence.
Definition: recurrence.h:91
QString secrecyStr() const
Returns the incidence Secrecy as translated string.
Definition: incidence.cpp:877
virtual void setDtStart(const KDateTime &dt)
Sets the incidence starting date/time.
Definition: incidence.cpp:349
void deleteAttachments(const QString &mime)
Removes all attachments of the specified MIME type from the incidence.
Definition: incidence.cpp:703
This file is part of the KDE documentation.
Documentation copyright © 1996-2019 The KDE developers.
Generated on Thu Jul 25 2019 00:00:00 by doxygen 1.8.15 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2019 The KDE developers.
Generated on Thu Jul 25 2019 00:00:00 by doxygen 1.8.15 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.