KCalendarCore::Incidence Class

Member Function Documentation

Incidence::Incidence(KCalendarCore::IncidencePrivate *p)

Constructs an empty incidence.

p (non-null) a Private data object provided by the instantiated class (Event, Todo, Journal, FreeBusy). It passes ownership of the object to IncidenceBase.

[protected] Incidence::Incidence(const KCalendarCore::Incidence &other, KCalendarCore::IncidencePrivate *p)

other is the incidence to copy.

p (non-null) is a Private data object provided by the instantiated class (Event, Todo, Journal, FreeBusy). It passes ownership of the object to IncidenceBase.

[override virtual noexcept] Incidence::~Incidence()

Destroys an incidence.

void Incidence::addAlarm(const KCalendarCore::Alarm::Ptr &alarm)

Adds an alarm to the incidence.

alarm is a pointer to a valid Alarm object.

See also removeAlarm().

void Incidence::addAttachment(const KCalendarCore::Attachment &attachment)

Adds an attachment to the incidence.

attachment a valid Attachment object.

[since 5.77] void Incidence::addConference(const KCalendarCore::Conference &conference)

Adds a conference to the incidence.

conference A conference to add.

This function was introduced in 5.77.

KCalendarCore::Alarm::List Incidence::alarms() const

Returns a list of all incidence alarms.

QString Incidence::altDescription() const

Returns the incidence alternative (=text/html) description.

See also setAltDescription().

[override virtual protected] KCalendarCore::IncidenceBase &Incidence::assign(const KCalendarCore::IncidenceBase &other)

Reimplements: IncidenceBase::assign(const KCalendarCore::IncidenceBase &other).

KCalendarCore::Attachment::List Incidence::attachments() const

Returns a list of all incidence attachments.

See also attachments( const QString &).

KCalendarCore::Attachment::List Incidence::attachments(const QString &mime) const

Returns a list of all incidence attachments with the specified MIME type.

mime is a QString containing the MIME type.

See also attachments().

QStringList Incidence::categories() const

Returns the incidence categories as a list of strings.

See also setCategories( const QStringList &) and setCategories( const QString &).

QString Incidence::categoriesStr() const

Returns the incidence categories as a comma separated string.

See also categories().

void Incidence::clearAlarms()

Removes all alarms.

See also removeAlarm().

void Incidence::clearAttachments()

Removes all attachments and frees the memory used by them.

See also deleteAttachments( const QString &).

[since 5.77] void Incidence::clearConferences()

Removes all conferences from the incidence.

This function was introduced in 5.77.

void Incidence::clearRecurrence()

Removes all recurrence and exception rules and dates.

[pure virtual] KCalendarCore::Incidence *Incidence::clone() const

Returns an exact copy of this incidence. The returned object is owned by the caller.

Dirty fields are cleared.

[since : 5.76] QString Incidence::color() const

Returns the color, if any is defined, for this incidence.

This function was introduced in : 5.76.

See also setColor().

[since 5.77] KCalendarCore::Conference::List Incidence::conferences() const

Returns list of all incidence conferencing methods.

This function was introduced in 5.77.

See also setConferences().

QDateTime Incidence::created() const

Returns the incidence creation date/time.

See also setCreated().

QString Incidence::customStatus() const

Returns the non-standard status value.

See also setCustomStatus().

void Incidence::deleteAttachments(const QString &mime)

Removes all attachments of the specified MIME type from the incidence. The memory used by all the removed attachments is freed.

mime is a QString containing the MIME type.

See also clearAttachments().

QString Incidence::description() const

Returns the incidence description.

See also setDescription() and richDescription().

bool Incidence::descriptionIsRich() const

Returns true if incidence description contains RichText; false otherwise.

See also setDescription() and description().

[virtual] QDateTime Incidence::endDateForStart(const QDateTime &startDt) const

Returns the end date/time of the incidence occurrence if it starts at specified date/time.

startDt is the specified starting date/time.

Returns the corresponding end date/time for the occurrence; or the start date/time if the end date/time is invalid; or the end date/time if the start date/time is invalid.

[override virtual protected] bool Incidence::equals(const KCalendarCore::IncidenceBase &incidence) const

Reimplements: IncidenceBase::equals(const KCalendarCore::IncidenceBase &incidenceBase) const.

Compares this with Incidence incidence for equality.

incidence is the Incidence to compare against.

Returns true if the incidences are equal; false otherwise.

float Incidence::geoLatitude() const

Returns the incidence's geoLatitude as a value between -90.0 and 90.0 or INVALID_LATLON. If either of geoLatitude() and geoLongitude() are INVALID_LATLON, then both are, and hasGeo() is false. Returns incidences geolatitude value

See also setGeoLatitude().

float Incidence::geoLongitude() const

Returns the incidence's geoLongitude as a value between -180.0 and 180.0 or INVALID_LATLON. If either of geoLatitude() and geoLongitude() are INVALID_LATLON, then both are, and hasGeo() is false. Returns incidences geolongitude value

See also setGeoLongitude().

bool Incidence::hasAltDescription() const

Returns true if the alternative (=text/html) description is available.

See also setAltDescription() and altDescription().

bool Incidence::hasEnabledAlarms() const

Returns true if any of the incidence alarms are enabled; false otherwise.

bool Incidence::hasGeo() const

Returns true if the incidence has geo data, otherwise return false.

See also setGeoLatitude(float) and setGeoLongitude(float).

bool Incidence::hasRecurrenceId() const

Returns true if the incidence has recurrenceId, otherwise return false.

See also setRecurrenceId().

[pure virtual] QLatin1String Incidence::iconName(const QDateTime &recurrenceId = {}) const

Returns the name of the icon that best represents this incidence.

recurrenceId Some recurring incidences might use a different icon, for example, completed to-do occurrences. Use this parameter to identify the specific occurrence in a recurring series.

[since 4.11] QString Incidence::instanceIdentifier() const

Returns a unique identifier for a specific instance of an incidence.

Due to the recurrence-id, the uid is not unique for a KCalendarCore::Incidence.

This function was introduced in 4.11.

bool Incidence::localOnly() const

Get the localOnly status. Returns true if Local only, false otherwise.

See also setLocalOnly().

QString Incidence::location() const

Returns the incidence location. Do _not_ use with journals.

See also setLocation() and richLocation().

bool Incidence::locationIsRich() const

Returns true if incidence location contains RichText; false otherwise.

See also setLocation() and location().

[static, since 4.12] QStringList Incidence::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"

This function was introduced in 4.12.

KCalendarCore::Alarm::Ptr Incidence::newAlarm()

Create a new incidence alarm.

int Incidence::priority() const

Returns the incidence priority.

See also setPriority().

void Incidence::recreate()

Recreate incidence. The incidence is made a new unique incidence, but already stored information is preserved. Sets unique id, creation date, last modification date and revision number.

KCalendarCore::Recurrence *Incidence::recurrence() const

Returns the recurrence rule associated with this incidence. If there is none, returns an appropriate (non-0) object.

[override virtual] QDateTime Incidence::recurrenceId() const

Reimplements: IncidenceBase::recurrenceId() const.

Returns the incidence recurrenceId. Returns incidences recurrenceId value

See also setRecurrenceId().

ushort Incidence::recurrenceType() const

Returns the event's recurrence status. See Recurrence::anonymous for possible values.

[override virtual] void Incidence::recurrenceUpdated(KCalendarCore::Recurrence *recurrence)

Observer interface for the recurrence class. If the recurrence is changed, this method will be called for the incidence the recurrence object belongs to.

recurrence is a pointer to a valid Recurrence object.

bool Incidence::recurs() const

Returns whether the event recurs at all.

bool Incidence::recursAt(const QDateTime &dt) const

Returns true if the date/time specified is one at which the event will recur. Times are rounded down to the nearest minute to determine the result.

dt is the date/time to check.

[virtual] bool Incidence::recursOn(const QDate &date, const QTimeZone &timeZone) const

Returns true if the date specified is one on which the event will recur.

date is the date to check.

timeZone is the time zone for the date.

QString Incidence::relatedTo(KCalendarCore::Incidence::RelType relType = RelTypeParent) const

Returns a UID string for the incidence that is related to this one. This function should only be used when constructing a calendar before the related incidence exists.

relType specifies the relation type.

See also setRelatedTo().

void Incidence::removeAlarm(const KCalendarCore::Alarm::Ptr &alarm)

Removes the specified alarm from the incidence.

alarm is a pointer to a valid Alarm object.

See also addAlarm().

QStringList Incidence::resources() const

Returns the incidence resources as a list of strings.

See also setResources().

int Incidence::revision() const

Returns the number of revisions this incidence has seen.

See also setRevision().

QString Incidence::richDescription() const

Returns the incidence description in rich text format.

See also setDescription() and description().

QString Incidence::richLocation() const

Returns the incidence location in rich text format.

See also setLocation() and location().

QString Incidence::richSummary() const

Returns the incidence summary in rich text format.

See also setSummary() and summary().

QString Incidence::schedulingID() const

Returns the incidence scheduling ID. Do _not_ use with journals. If a scheduling ID is not set, then return the incidence UID.

See also setSchedulingID().

KCalendarCore::Incidence::Secrecy Incidence::secrecy() const

Returns the incidence Secrecy.

See also setSecrecy().

[override virtual] void Incidence::setAllDay(bool allDay)

Reimplements: IncidenceBase::setAllDay(bool allDay).

void Incidence::setAltDescription(const QString &altdescription)

Sets the incidence's alternative (=text/html) description. If the text is empty, the property is removed.

altdescription is the incidence altdescription string.

See also altDescription().

void Incidence::setCategories(const QString &catStr)

Sets the incidence category list based on a comma delimited string.

catStr is a QString containing a list of categories which are delimited by a comma character.

See also setCategories( const QStringList &) and categories().

void Incidence::setCategories(const QStringList &categories)

Sets the incidence category list.

categories is a list of category strings.

See also setCategories( const QString &) and categories().

[since : 5.76] void Incidence::setColor(const QString &colorName)

Set the incidence color, as added in RFC7986.

colorName is a named color as defined in CSS3 color name, see https://www.w3.org/TR/css-color-3/#svg-color.

This function was introduced in : 5.76.

See also color().

[since 5.77] void Incidence::setConferences(const KCalendarCore::Conference::List &conferences)

Replaces all conferences in the incidence with given conferences

conferences New conferences to store in the incidence.

This function was introduced in 5.77.

See also conferences().

void Incidence::setCreated(const QDateTime &dt)

Sets the incidence creation date/time. It is stored as a UTC date/time.

dt is the creation date/time.

See also created().

void Incidence::setCustomStatus(const QString &status)

Sets the incidence Status to a non-standard status value.

status is a non-standard status string. If empty, the incidence Status will be set to StatusNone.

See also setStatus(), status(), and customStatus().

void Incidence::setDescription(const QString &description)

Sets the incidence description and tries to guess if the description is rich text.

description is the incidence description string.

See also description().

void Incidence::setDescription(const QString &description, bool isRich)

Sets the incidence description.

description is the incidence description string.

isRich if true indicates the description string contains richtext.

See also description().

[override virtual] void Incidence::setDtStart(const QDateTime &dt)

Reimplements: IncidenceBase::setDtStart(const QDateTime &dtStart).

Sets the incidence starting date/time.

dt is the starting date/time.

See also IncidenceBase::dtStart().

void Incidence::setGeoLatitude(float geolatitude)

Set the incidence's geoLatitude. geolatitude is the incidence geolatitude to set; a value between -90.0 and 90.0, or INVALID_LATLON (or NaN, which is treated as INVALID_LATLON).

See also geoLatitude().

void Incidence::setGeoLongitude(float geolongitude)

Set the incidence's geoLongitude. geolongitude is the incidence geolongitude to set; a value between -180.0 and 180.0, or INVALID_LATLON (or NaN, which is treated as INVALID_LATLON).

See also geoLongitude().

[override virtual] void Incidence::setLastModified(const QDateTime &lm)

Reimplements: IncidenceBase::setLastModified(const QDateTime &lm).

void Incidence::setLocalOnly(bool localonly)

Set localOnly state of incidence. A local only incidence can be updated but it will not increase the revision number neither the modified date.

localonly If true, the incidence is set to localonly, if false the incidence is set to normal stat.

See also localOnly().

void Incidence::setLocation(const QString &location)

Sets the incidence location and tries to guess if the location is richtext. Do _not_ use with journals.

location is the incidence location string.

See also location().

void Incidence::setLocation(const QString &location, bool isRich)

Sets the incidence location. Do _not_ use with journals.

location is the incidence location string.

isRich if true indicates the location string contains richtext.

See also location().

void Incidence::setPriority(int priority)

Sets the incidences priority. The priority must be an integer value between 0 and 9, where 0 is undefined, 1 is the highest, and 9 is the lowest priority (decreasing order).

priority is the incidence priority to set.

See also priority().

[override virtual] void Incidence::setReadOnly(bool readonly)

Reimplements: IncidenceBase::setReadOnly(bool readOnly).

Set readonly state of incidence.

readonly If true, the incidence is set to readonly, if false the incidence is set to readwrite.

void Incidence::setRecurrenceId(const QDateTime &recurrenceId)

Set the incidences recurrenceId. This field indicates that this is an exception to a recurring incidence. The uid of this incidence MUST be the same as the one of the recurring main incidence.

recurrenceId is the incidence recurrenceId to set

See also recurrenceId().

void Incidence::setRelatedTo(const QString &uid, KCalendarCore::Incidence::RelType relType = RelTypeParent)

Relates another incidence to this one, by UID. This function should only be used when constructing a calendar before the related incidence exists.

uid is a QString containing a UID for another incidence.

relType specifies the relation type.

See also relatedTo().

void Incidence::setResources(const QStringList &resources)

Sets a list of incidence resources. (

resources is a list of resource strings.

See also resources().

void Incidence::setRevision(int rev)

Sets the number of revisions this incidence has seen.

rev is the incidence revision number.

See also revision().

void Incidence::setSchedulingID(const QString &sid, const QString &uid = QString())

Set the incidence scheduling ID. Do _not_ use with 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.

While constructing an incidence, when setting the scheduling ID, you will always want to set the incidence UID too. Instead of calling setUID() separately, you can pass the UID through uid so both members are changed in one atomic operation ( don't forget that setUID() emits incidenceUpdated() and whoever catches that signal will have an half-initialized incidence, therefore, always set the schedulingID and UID at the same time, and never with two separate calls).

sid is a QString containing the scheduling ID.

uid is a QString containing the incidence UID to set, if not specified, the current UID isn't changed, and this parameter is ignored.

See also schedulingID().

void Incidence::setSecrecy(KCalendarCore::Incidence::Secrecy secrecy)

Sets the incidence Secrecy.

secrecy is the incidence Secrecy to set.

See also secrecy().

void Incidence::setStatus(KCalendarCore::Incidence::Status status)

Sets the incidence status to a standard Status value. Events, Todos, and Journals each have a different set of valid statuses. Note that StatusX cannot be specified. Invalid statuses are logged and ignored.

status is the incidence Status to set.

See also status() and setCustomStatus().

void Incidence::setSummary(const QString &summary)

Sets the incidence summary and tries to guess if the summary is richtext.

summary is the incidence summary string.

See also summary().

void Incidence::setSummary(const QString &summary, bool isRich)

Sets the incidence summary.

summary is the incidence summary string.

isRich if true indicates the summary string contains richtext.

See also summary().

[since 4.11] void Incidence::setThisAndFuture(bool thisAndFuture)

Set to true if the exception also applies to all future occurrences. This option is only relevant if the incidence has a recurrenceId set.

thisAndFuture value

This function was introduced in 4.11.

See also thisAndFuture() and setRecurrenceId().

[override virtual] void Incidence::shiftTimes(const QTimeZone &oldZone, const QTimeZone &newZone)

Reimplements: IncidenceBase::shiftTimes(const QTimeZone &oldZone, const QTimeZone &newZone).

[virtual] QList<QDateTime> Incidence::startDateTimesForDate(const QDate &date, const QTimeZone &timeZone) const

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).

date is the date when the incidence should occur

timeZone is the time specification for date.

Returns the start date/time of all occurrences that overlap with the given date; an empty list if the incidence does not overlap with the date at all.

[virtual] QList<QDateTime> Incidence::startDateTimesForDateTime(const QDateTime &datetime) const

Calculates the start date/time for all recurrences that happen at the given time.

datetime the date/time when the incidence should occur.

Returns the start date/time of all occurrences that overlap with the given date/time; an empty list if the incidence does not happen at the given time at all.

KCalendarCore::Incidence::Status Incidence::status() const

Returns the incidence Status.

See also setStatus() and setCustomStatus().

QString Incidence::summary() const

Returns the incidence summary.

See also setSummary() and richSummary().

bool Incidence::summaryIsRich() const

Returns true if incidence summary contains RichText; false otherwise.

See also setSummary() and summary().

[pure virtual, since 4.10] bool Incidence::supportsGroupwareCommunication() const

Returns true if the incidence type supports groupware communication.

This function was introduced in 4.10.

[since 4.11] bool Incidence::thisAndFuture() const

Returns true if the exception also applies to all future occurrences. Returns incidences thisAndFuture value

This function was introduced in 4.11.

See also setThisAndFuture().