KCal Library
incidencebase.cpp
Go to the documentation of this file.
This file is part of the API for handling calendar data and defines the CalFormat abstract base class...
Represents information related to an attendee of an Calendar Incidence, typically a meeting or task (...
Definition: attendee.h:59
A class to manage custom calendar properties.
Definition: customproperties.h:53
CustomProperties & operator=(const CustomProperties &other)
Assignment operator.
Definition: customproperties.cpp:75
virtual void incidenceUpdated(IncidenceBase *incidenceBase)=0
The IncidenceObserver interface.
virtual bool visit(Event *event)
Reimplement this function in your concrete subclass of IncidenceBase::Visitor to perform actions on a...
Definition: incidencebase.cpp:513
An abstract class that provides a common base for all calendar incidence classes.
Definition: incidencebase.h:103
Attendee * attendeeByMail(const QString &email) const
Returns the attendee with the specified email address.
Definition: incidencebase.cpp:397
void updated()
Call this to notify the observers after the IncidenceBase object has changed.
Definition: incidencebase.cpp:475
QStringList comments() const
Returns all incidence comments as a list of strings.
Definition: incidencebase.cpp:357
bool allDay() const
Returns true or false depending on whether the incidence is all-day.
Definition: incidencebase.cpp:310
void setLastModified(const KDateTime &lm)
Sets the time the incidence was last modified to lm.
Definition: incidencebase.cpp:189
Attendee * attendeeByMails(const QStringList &emails, const QString &email=QString()) const
Returns the first incidence attendee with one of the specified email addresses.
Definition: incidencebase.cpp:409
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
Duration duration() const
Returns the length of the incidence duration.
Definition: incidencebase.cpp:448
void startUpdates()
Call this when a group of updates is going to be made.
Definition: incidencebase.cpp:488
void addComment(const QString &comment)
Adds a comment to thieincidence.
Definition: incidencebase.cpp:332
Attendee * attendeeByUid(const QString &uid) const
Returns the incidence attendee with the specified attendee UID.
Definition: incidencebase.cpp:429
virtual KDateTime dtStart() const
Returns an incidence's starting date/time as a KDateTime.
Definition: incidencebase.cpp:248
KUrl uri() const
Returns the uri for the incidence, of form urn:x-ical:<uid>
Definition: incidencebase.cpp:508
const Attendee::List & attendees() const
Returns a list of incidence attendees.
Definition: incidencebase.cpp:378
Person organizer() const
Returns the Person associated with this incidence.
Definition: incidencebase.cpp:230
IncidenceBase & operator=(const IncidenceBase &other)
Assignment operator.
Definition: incidencebase.cpp:131
virtual KCAL_DEPRECATED QString dtStartTimeStr(bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec()) const
Returns an incidence's starting time as a string formatted according to the user's locale settings.
Definition: incidencebase.cpp:253
void setOrganizer(const Person &organizer)
Sets the organizer for the incidence.
Definition: incidencebase.cpp:208
virtual void setDuration(const Duration &duration)
Sets the incidence duration.
Definition: incidencebase.cpp:441
bool operator==(const IncidenceBase &ib) const
Compares this with IncidenceBase ib for equality.
Definition: incidencebase.cpp:144
virtual KCAL_DEPRECATED QString dtStartDateStr(bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec()) const
Returns an incidence's starting date as a string formatted according to the user's locale settings.
Definition: incidencebase.cpp:269
virtual void customPropertyUpdated()
Definition: incidencebase.cpp:503
void setHasDuration(bool hasDuration)
Sets if the incidence has a duration.
Definition: incidencebase.cpp:453
void endUpdates()
Call this when a group of updates is complete, to notify observers that the instance has changed.
Definition: incidencebase.cpp:493
virtual void setDtStart(const KDateTime &dtStart)
Sets the incidence's starting date/time with a KDateTime.
Definition: incidencebase.cpp:240
KDateTime lastModified() const
Returns the time the incidence was last modified.
Definition: incidencebase.cpp:203
void unRegisterObserver(IncidenceObserver *observer)
Unregister observer.
Definition: incidencebase.cpp:470
int attendeeCount() const
Returns the number of incidence attendees.
Definition: incidencebase.cpp:383
void setUid(const QString &uid)
Returns the type of Incidence as a translated string.
Definition: incidencebase.cpp:178
void setAllDay(bool allDay)
Sets whether the incidence is all-day, i.e.
Definition: incidencebase.cpp:315
virtual KCAL_DEPRECATED QString dtStartStr(bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec()) const
Returns an incidence's starting date and time as a string formatted according to the user's locale se...
Definition: incidencebase.cpp:287
bool hasDuration() const
Returns true if the incidence has a duration; false otherwise.
Definition: incidencebase.cpp:458
bool removeComment(const QString &comment)
Removes a comment from the incidence.
Definition: incidencebase.cpp:337
void registerObserver(IncidenceObserver *observer)
Register observer.
Definition: incidencebase.cpp:463
void addAttendee(Attendee *attendee, bool doUpdate=true)
Add Attendee to this incidence.
Definition: incidencebase.cpp:362
static Person fromFullName(const QString &fullName)
Constructs a person with name and email address taken from fullName.
Definition: person.cpp:68
This file is part of the API for handling calendar data and defines the IncidenceBase class.
This file is part of the API for handling calendar data and provides static functions for formatting ...
KCAL_DEPRECATED_EXPORT QString dateToString(const KDateTime &date, bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec())
Build a QString date representation of a KDateTime object.
Definition: incidenceformatter.cpp:3737
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.