KCalendarCore::IncidenceBase Class

Member Function Documentation

[explicit] IncidenceBase::IncidenceBase(KCalendarCore::IncidenceBasePrivate *p)

Constructs an empty IncidenceBase.

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

[protected] IncidenceBase::IncidenceBase(const KCalendarCore::IncidenceBase &ib, KCalendarCore::IncidenceBasePrivate *p)

Constructs an IncidenceBase as a copy of another IncidenceBase object.

ib is the IncidenceBase to copy.

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

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

Destroys the IncidenceBase.

[virtual] bool IncidenceBase::accept(KCalendarCore::Visitor &v, const KCalendarCore::IncidenceBase::Ptr &incidence)

Accept IncidenceVisitor. A class taking part in the visitor mechanism has to provide this implementation:

bool accept(Visitor &v) { return v.visit(this); }

v is a reference to a Visitor object.

incidence is a valid IncidenceBase object for visiting.

void IncidenceBase::addAttendee(const KCalendarCore::Attendee &attendee, bool doUpdate = true)

Add Attendee to this incidence.

attendee is the attendee to add

doUpdate If true the Observers are notified, if false they are not.

void IncidenceBase::addComment(const QString &comment)

Adds a comment to the incidence. Does not add a linefeed character; simply appends the text as specified.

comment is the QString containing the comment to add.

See also removeComment().

void IncidenceBase::addContact(const QString &contact)

Adds a contact to thieincidence. Does not add a linefeed character; simply appends the text as specified.

contact is the QString containing the contact to add.

See also removeContact().

bool IncidenceBase::allDay() const

Returns true or false depending on whether the incidence is all-day. i.e. has a date but no time attached to it.

See also setAllDay().

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

Provides polymorphic assignment.

other is the IncidenceBase to assign.

KCalendarCore::Attendee IncidenceBase::attendeeByMail(const QString &email) const

Returns the attendee with the specified email address.

email is a QString containing an email address of the form "FirstName LastName <emailaddress>".

See also attendeeByMails() and attendeeByUid().

KCalendarCore::Attendee IncidenceBase::attendeeByMails(const QStringList &emails, const QString &email = QString()) const

Returns the first incidence attendee with one of the specified email addresses.

emails is a list of QStrings containing email addresses of the form "FirstName LastName <emailaddress>".

email is a QString containing a single email address to search in addition to the list specified in emails.

See also attendeeByMail() and attendeeByUid().

KCalendarCore::Attendee IncidenceBase::attendeeByUid(const QString &uid) const

Returns the incidence attendee with the specified attendee UID.

uid is a QString containing an attendee UID.

See also attendeeByMail() and attendeeByMails().

int IncidenceBase::attendeeCount() const

Returns the number of incidence attendees.

KCalendarCore::Attendee::List IncidenceBase::attendees() const

Returns a list of incidence attendees. All pointers in the list are valid.

See also setAttendees().

void IncidenceBase::clearAttendees()

Removes all attendees from the incidence.

void IncidenceBase::clearComments()

Deletes all incidence comments.

void IncidenceBase::clearContacts()

Deletes all incidence contacts.

QStringList IncidenceBase::comments() const

Returns all incidence comments as a list of strings.

QStringList IncidenceBase::contacts() const

Returns all incidence contacts as a list of strings.

[override virtual protected] void IncidenceBase::customPropertyUpdate()

Reimplements: CustomProperties::customPropertyUpdate().

[override virtual protected] void IncidenceBase::customPropertyUpdated()

Reimplements: CustomProperties::customPropertyUpdated().

[pure virtual] QDateTime IncidenceBase::dateTime(KCalendarCore::IncidenceBase::DateTimeRole role) const

Returns a date/time corresponding to the specified DateTimeRole.

role is a DateTimeRole.

See also setDateTime().

[virtual protected] void IncidenceBase::deserialize(QDataStream &in)

Sub-type specific deserialization.

in is the input data stream

QSet<KCalendarCore::IncidenceBase::Field> IncidenceBase::dirtyFields() const

Returns a QSet with all Fields that were changed since the incidence was created or resetDirtyFields() was called.

See also resetDirtyFields().

[virtual] QDateTime IncidenceBase::dtStart() const

Returns an incidence's starting date/time as a QDateTime.

See also setDtStart().

KCalendarCore::Duration IncidenceBase::duration() const

Returns the length of the incidence duration.

See also setDuration().

void IncidenceBase::endUpdates()

Call this when a group of updates is complete, to notify observers that the instance has changed. This should be called in conjunction with startUpdates().

[virtual protected] bool IncidenceBase::equals(const KCalendarCore::IncidenceBase &incidenceBase) const

Provides polymorfic comparison for equality. Only called by IncidenceBase::operator==() which guarantees that

incidenceBase is of the right type.

incidenceBase is the IncidenceBase to compare against.

Returns true if the incidences are equal; false otherwise.

bool IncidenceBase::hasDuration() const

Returns true if the incidence has a duration; false otherwise.

See also setHasDuration().

bool IncidenceBase::isReadOnly() const

Returns true the object is read-only; false otherwise.

See also setReadOnly().

QDateTime IncidenceBase::lastModified() const

Returns the time the incidence was last modified.

See also setLastModified().

[static, since 4.12] quint32 IncidenceBase::magicSerializationIdentifier()

Constant that identifies KCalendarCore data in a binary stream.

This function was introduced in 4.12.

[pure virtual] QLatin1String IncidenceBase::mimeType() const

Returns the Akonadi specific sub MIME type of a KCalendarCore::IncidenceBase item, e.g. getting "application/x-vnd.akonadi.calendar.event" for a KCalendarCore::Event.

KCalendarCore::Person IncidenceBase::organizer() const

Returns the Person associated with this incidence. If no Person was set through setOrganizer(), a default Person() is returned.

See also setOrganizer().

[virtual] QDateTime IncidenceBase::recurrenceId() const

Returns the incidence recurrenceId.

void IncidenceBase::registerObserver(KCalendarCore::IncidenceBase::IncidenceObserver *observer)

Register observer. The observer is notified when the observed object changes.

observer is a pointer to an IncidenceObserver object that will be watching this incidence.

See also unRegisterObserver().

bool IncidenceBase::removeComment(const QString &comment)

Removes a comment from the incidence. Removes the first comment whose string is an exact match for the specified string in comment.

comment is the QString containing the comment to remove.

Returns true if match found, false otherwise.

See also addComment().

bool IncidenceBase::removeContact(const QString &contact)

Removes a contact from the incidence. Removes the first contact whose string is an exact match for the specified string in contact.

contact is the QString containing the contact to remove.

Returns true if match found, false otherwise.

See also addContact().

void IncidenceBase::resetDirtyFields()

Resets dirty fields.

See also dirtyFields().

[virtual protected] void IncidenceBase::serialize(QDataStream &out) const

Sub-type specific serialization.

out is the output data stream

[virtual] void IncidenceBase::setAllDay(bool allDay)

Sets whether the incidence is all-day, i.e. has a date but no time attached to it.

allDay sets whether the incidence is all-day.

See also allDay().

void IncidenceBase::setAttendees(const KCalendarCore::Attendee::List &attendees, bool doUpdate = true)

Set the attendees of this incidence. This replaces all previously set attendees, unlike addAttendee.

attendees is a list of attendees.

doUpdate If true the Observers are notified, if false they are not.

See also attendees().

[pure virtual] void IncidenceBase::setDateTime(const QDateTime &dateTime, KCalendarCore::IncidenceBase::DateTimeRole role)

Sets the date/time corresponding to the specified DateTimeRole.

dateTime is QDateTime value to set.

role is a DateTimeRole.

See also dateTime().

[since 4.8] void IncidenceBase::setDirtyFields(const QSet<KCalendarCore::IncidenceBase::Field> &)

Sets which fields are dirty.

This function was introduced in 4.8.

See also dirtyFields().

[virtual] void IncidenceBase::setDtStart(const QDateTime &dtStart)

Sets the incidence's starting date/time with a QDateTime.

dtStart is the incidence start date/time.

See also dtStart().

[virtual] void IncidenceBase::setDuration(const KCalendarCore::Duration &duration)

Sets the incidence duration.

duration the incidence duration

See also duration().

[protected] void IncidenceBase::setFieldDirty(KCalendarCore::IncidenceBase::Field field)

Marks Field field as dirty.

field is the Field type to mark as dirty.

See also dirtyFields().

void IncidenceBase::setHasDuration(bool hasDuration)

Sets if the incidence has a duration.

hasDuration true if the incidence has a duration; false otherwise.

See also hasDuration().

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

Sets the time the incidence was last modified to lm. It is stored as a UTC date/time.

lm is the QDateTime when the incidence was last modified.

See also lastModified().

void IncidenceBase::setOrganizer(const KCalendarCore::Person &organizer)

Sets the organizer for the incidence.

organizer is a non-null Person to use as the incidence organizer.

See also organizer() and setOrganizer(const QString &).

void IncidenceBase::setOrganizer(const QString &organizer)

Sets the incidence organizer to any string organizer.

organizer is a string to use as the incidence organizer.

See also organizer().

[virtual] void IncidenceBase::setReadOnly(bool readOnly)

Sets readonly status.

readOnly if set, the incidence is read-only; else the incidence can be modified.

See also isReadOnly().

void IncidenceBase::setUid(const QString &uid)

Sets the unique id for the incidence to uid.

uid is the string containing the incidence uid.

See also uid().

[since 4.12] void IncidenceBase::setUrl(const QUrl &url)

Sets the incidences url.

This property can be used to point to a more dynamic rendition of the incidence. I.e. a website related to the incidence.

url is the URL of the incidence.

This function was introduced in 4.12.

See also url().

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

Shift the times of the incidence so that they appear at the same clock time as before but in a new time zone. The shift is done from a viewing time zone rather than from the actual incidence time zone.

For example, shifting an incidence whose start time is 09:00 America/New York, using an old viewing time zone (oldZone) of Europe/London, to a new time zone (newZone) of Europe/Paris, will result in the time being shifted from 14:00 (which is the London time of the incidence start) to 14:00 Paris time.

oldZone the time zone which provides the clock times

newZone the new time zone

void IncidenceBase::startUpdates()

Call this when a group of updates is going to be made. This suppresses change notifications until endUpdates() is called, at which point updated() will automatically be called.

[pure virtual] KCalendarCore::IncidenceBase::IncidenceType IncidenceBase::type() const

Returns the incidence type.

[pure virtual] QByteArray IncidenceBase::typeStr() const

Prints the type of incidence as a string.

QString IncidenceBase::uid() const

Returns the unique id (uid) for the incidence.

See also setUid().

void IncidenceBase::unRegisterObserver(KCalendarCore::IncidenceBase::IncidenceObserver *observer)

Unregister observer. It isn't notified anymore about changes.

observer is a pointer to an IncidenceObserver object that will be watching this incidence.

See also registerObserver().

void IncidenceBase::update()

Call this to notify the observers after the IncidenceBase object will be changed.

void IncidenceBase::updated()

Call this to notify the observers after the IncidenceBase object has changed.

QUrl IncidenceBase::uri() const

Returns the uri for the incidence, of form urn:x-ical:<uid>

[since 4.12] QUrl IncidenceBase::url() const

Returns the url. Returns incidences url value

This function was introduced in 4.12.

See also setUrl().

[pure virtual protected] void IncidenceBase::virtual_hook(KCalendarCore::IncidenceBase::VirtualHook id, void *data)

Standard trick to add virtuals later.

id is any integer unique to this class which we will use to identify the method to be called.

data is a pointer to some glob of data, typically a struct.

bool IncidenceBase::operator!=(const KCalendarCore::IncidenceBase &ib) const

Compares this with IncidenceBase ib for inequality.

ib is the IncidenceBase to compare against.

Returns true if the incidences are /not/ equal; false otherwise.

KCalendarCore::IncidenceBase &IncidenceBase::operator=(const KCalendarCore::IncidenceBase &other)

Assignment operator. All data belonging to derived classes are also copied.

The caller guarantees that both types match.

if ( i1.type() == i2.type() ) {
  i1 = i2;
} else {
  qCDebug(KCALCORE_LOG) << "Invalid assignment!";
}

Dirty field FieldUnknown will be set.

other is the IncidenceBase to assign.

See also assign().

bool IncidenceBase::operator==(const KCalendarCore::IncidenceBase &ib) const

Compares this with IncidenceBase ib for equality. All data belonging to derived classes are also compared.

ib is the IncidenceBase to compare against.

Returns true if the incidences are equal; false otherwise.

See also equals().