KCalendarCore::IncidenceBase

#include <incidencebase.h>

Inheritance diagram for KCalendarCore::IncidenceBase:

Classes

class  IncidenceObserver
 

Public Types

enum  DateTimeRole {
  RoleAlarmStartOffset = 0, RoleAlarmEndOffset, RoleSort, RoleCalendarHashing,
  RoleStartTimeZone, RoleEndTimeZone, RoleEndRecurrenceBase, RoleEnd,
  RoleDisplayEnd, RoleAlarm, RoleRecurrenceStart, RoleDisplayStart,
  RoleDnD
}
 
enum  Field {
  FieldDtStart, FieldDtEnd, FieldLastModified, FieldDescription,
  FieldSummary, FieldLocation, FieldCompleted, FieldPercentComplete,
  FieldDtDue, FieldCategories, FieldRelatedTo, FieldRecurrence,
  FieldAttachment, FieldSecrecy, FieldStatus, FieldTransparency,
  FieldResources, FieldPriority, FieldGeoLatitude, FieldGeoLongitude,
  FieldRecurrenceId, FieldAlarms, FieldSchedulingId, FieldAttendees,
  FieldOrganizer, FieldCreated, FieldRevision, FieldDuration,
  FieldContact, FieldComment, FieldUid, FieldUnknown,
  FieldUrl
}
 
enum  IncidenceType {
  TypeEvent = 0, TypeTodo, TypeJournal, TypeFreeBusy,
  TypeUnknown
}
 
typedef QSharedPointer< IncidenceBasePtr
 

Properties

bool allDay
 
QVariantList attendees
 
QDateTime dtStart
 
QDateTime lastModified
 
KCalendarCore::Person organizer
 
QString uid
 

Public Member Functions

 IncidenceBase ()
 
 ~IncidenceBase () override
 
virtual bool accept (Visitor &v, const IncidenceBase::Ptr &incidence)
 
void addAttendee (const Attendee &attendee, bool doUpdate=true)
 
void addComment (const QString &comment)
 
void addContact (const QString &contact)
 
bool allDay () const
 
Attendee attendeeByMail (const QString &email) const
 
Attendee attendeeByMails (const QStringList &emails, const QString &email=QString()) const
 
Attendee attendeeByUid (const QString &uid) const
 
int attendeeCount () const
 
Attendee::List attendees () const
 
void clearAttendees ()
 
void clearComments ()
 
void clearContacts ()
 
QStringList comments () const
 
QStringList contacts () const
 
virtual QDateTime dateTime (DateTimeRole role) const =0
 
QSet< IncidenceBase::FielddirtyFields () const
 
virtual QDateTime dtStart () const
 
Duration duration () const
 
void endUpdates ()
 
bool hasDuration () const
 
bool isReadOnly () const
 
QDateTime lastModified () const
 
virtual QLatin1String mimeType () const =0
 
bool operator!= (const IncidenceBase &ib) const
 
IncidenceBaseoperator= (const IncidenceBase &other)
 
bool operator== (const IncidenceBase &ib) const
 
Person organizer () const
 
virtual QDateTime recurrenceId () const
 
void registerObserver (IncidenceObserver *observer)
 
bool removeComment (const QString &comment)
 
bool removeContact (const QString &contact)
 
void resetDirtyFields ()
 
virtual void setAllDay (bool allDay)
 
void setAttendees (const Attendee::List &attendees, bool doUpdate=true)
 
virtual void setDateTime (const QDateTime &dateTime, DateTimeRole role)=0
 
void setDirtyFields (const QSet< IncidenceBase::Field > &)
 
virtual void setDtStart (const QDateTime &dtStart)
 
virtual void setDuration (const Duration &duration)
 
void setHasDuration (bool hasDuration)
 
virtual void setLastModified (const QDateTime &lm)
 
void setOrganizer (const Person &organizer)
 
void setOrganizer (const QString &organizer)
 
virtual void setReadOnly (bool readOnly)
 
void setUid (const QString &uid)
 
void setUrl (const QUrl &url)
 
virtual void shiftTimes (const QTimeZone &oldZone, const QTimeZone &newZone)
 
void startUpdates ()
 
virtual IncidenceType type () const =0
 
virtual QByteArray typeStr () const =0
 
QString uid () const
 
void unRegisterObserver (IncidenceObserver *observer)
 
void update ()
 
void updated ()
 
QUrl uri () const
 
QUrl url () const
 
- Public Member Functions inherited from KCalendarCore::CustomProperties
 CustomProperties ()
 
 CustomProperties (const CustomProperties &other)
 
virtual ~CustomProperties ()
 
QMap< QByteArray, QStringcustomProperties () const
 
QString customProperty (const QByteArray &app, const QByteArray &key) const
 
QString nonKDECustomProperty (const QByteArray &name) const
 
QString nonKDECustomPropertyParameters (const QByteArray &name) const
 
CustomPropertiesoperator= (const CustomProperties &other)
 
bool operator== (const CustomProperties &properties) const
 
void removeCustomProperty (const QByteArray &app, const QByteArray &key)
 
void removeNonKDECustomProperty (const QByteArray &name)
 
void setCustomProperties (const QMap< QByteArray, QString > &properties)
 
void setCustomProperty (const QByteArray &app, const QByteArray &key, const QString &value)
 
void setNonKDECustomProperty (const QByteArray &name, const QString &value, const QString &parameters=QString())
 

Static Public Member Functions

static quint32 magicSerializationIdentifier ()
 
- Static Public Member Functions inherited from KCalendarCore::CustomProperties
static QByteArray customPropertyName (const QByteArray &app, const QByteArray &key)
 

Protected Types

enum  VirtualHook
 

Protected Member Functions

 IncidenceBase (const IncidenceBase &ib)
 
virtual IncidenceBaseassign (const IncidenceBase &other)
 
void customPropertyUpdate () override
 
void customPropertyUpdated () override
 
virtual void deserialize (QDataStream &in)
 
virtual bool equals (const IncidenceBase &incidenceBase) const
 
virtual void serialize (QDataStream &out) const
 
void setFieldDirty (IncidenceBase::Field field)
 
virtual void virtual_hook (VirtualHook id, void *data)=0
 

Protected Attributes

bool mReadOnly
 

Friends

KCALENDARCORE_EXPORT QDataStreamoperator<< (QDataStream &stream, const KCalendarCore::IncidenceBase::Ptr &)
 
KCALENDARCORE_EXPORT QDataStreamoperator>> (QDataStream &stream, KCalendarCore::IncidenceBase::Ptr &)
 

Detailed Description

An abstract class that provides a common base for all calendar incidence classes.

define: organizer (person) define: uid (same as the attendee uid?)

Several properties are not allowed for VFREEBUSY objects (see rfc:2445), so they are not in IncidenceBase. The hierarchy is:

IncidenceBase

So IncidenceBase contains all properties that are common to all classes, and Incidence contains all additional properties that are common to Events, Todos and Journals, but are not allowed for FreeBusy entries.

Definition at line 96 of file incidencebase.h.

Member Typedef Documentation

A shared pointer to an IncidenceBase.

Definition at line 110 of file incidencebase.h.

Member Enumeration Documentation

The different types of incidence date/times roles.

See also
dateTime()
Enumerator
RoleAlarmStartOffset 

Role for an incidence alarm's starting offset date/time.

RoleAlarmEndOffset 

Role for an incidence alarm's ending offset date/time.

RoleSort 

Role for an incidence's date/time used when sorting.

RoleCalendarHashing 

Role for looking up an incidence in a Calendar.

RoleStartTimeZone 

Role for determining an incidence's starting timezone.

RoleEndTimeZone 

Role for determining an incidence's ending timezone.

RoleEnd 

Role for determining an incidence's dtEnd, will return an invalid QDateTime if the incidence does not support dtEnd.

RoleDisplayEnd 

Role used for display purposes, represents the end boundary if an incidence supports dtEnd.

RoleAlarm 

Role for determining the date/time of the first alarm.

Returns invalid time if the incidence doesn't have any alarm

RoleRecurrenceStart 

Role for determining the start of the recurrence.

Currently that's DTSTART for an event and DTDUE for a to-do. (NOTE: If the incidence is a to-do, recurrence should be calculated having DTSTART for a reference, not DT-DUE. This is one place KCalendarCore isn't compliant with RFC2445)

RoleDisplayStart 

Role for display purposes, represents the start boundary of an incidence.

To-dos return dtDue here, for historical reasons

RoleDnD 

Role for determining new start and end dates after a DnD.

Definition at line 128 of file incidencebase.h.

The different types of incidence fields.

Enumerator
FieldDtEnd 

Field representing the DTSTART component.

FieldLastModified 

Field representing the DTEND component.

FieldDescription 

Field representing the LAST-MODIFIED component.

FieldSummary 

Field representing the DESCRIPTION component.

FieldLocation 

Field representing the SUMMARY component.

FieldCompleted 

Field representing the LOCATION component.

FieldPercentComplete 

Field representing the COMPLETED component.

FieldDtDue 

Field representing the PERCENT-COMPLETE component.

FieldCategories 

Field representing the DUE component.

FieldRelatedTo 

Field representing the CATEGORIES component.

FieldRecurrence 

Field representing the RELATED-TO component.

FieldAttachment 

Field representing the EXDATE, EXRULE, RDATE, and RRULE components.

FieldSecrecy 

Field representing the ATTACH component.

FieldStatus 

Field representing the CLASS component.

FieldTransparency 

Field representing the STATUS component.

FieldResources 

Field representing the TRANSPARENCY component.

FieldPriority 

Field representing the RESOURCES component.

FieldGeoLatitude 

Field representing the PRIORITY component.

FieldGeoLongitude 

Field representing the latitude part of the GEO component.

FieldRecurrenceId 

Field representing the longitude part of the GEO component.

FieldAlarms 

Field representing the RECURRENCE-ID component.

FieldSchedulingId 

Field representing the VALARM component.

FieldAttendees 

Field representing the X-KDE-LIBKCAL-ID component.

FieldOrganizer 

Field representing the ATTENDEE component.

FieldCreated 

Field representing the ORGANIZER component.

FieldRevision 

Field representing the CREATED component.

FieldDuration 

Field representing the SEQUENCE component.

FieldContact 

Field representing the DURATION component.

FieldComment 

Field representing the CONTACT component.

FieldUid 

Field representing the COMMENT component.

FieldUnknown 

Field representing the UID component.

FieldUrl 

Something changed. Always set when you use the assignment operator.

Field representing the URL component.

Definition at line 155 of file incidencebase.h.

The different types of incidences, per RFC2445.

See also
type(), typeStr()
Enumerator
TypeEvent 

Type is an event.

TypeTodo 

Type is a to-do.

TypeJournal 

Type is a journal.

TypeFreeBusy 

Type is a free/busy.

TypeUnknown 

Type unknown.

Definition at line 116 of file incidencebase.h.

Constructor & Destructor Documentation

IncidenceBase::IncidenceBase ( )

Constructs an empty IncidenceBase.

Private class that helps to provide binary compatibility between releases.

Definition at line 109 of file incidencebase.cpp.

IncidenceBase::~IncidenceBase ( )
override

Destroys the IncidenceBase.

Definition at line 123 of file incidencebase.cpp.

IncidenceBase::IncidenceBase ( const IncidenceBase ib)
protected

Constructs an IncidenceBase as a copy of another IncidenceBase object.

Parameters
ibis the IncidenceBase to copy.

Definition at line 116 of file incidencebase.cpp.

Member Function Documentation

bool IncidenceBase::accept ( Visitor v,
const IncidenceBase::Ptr incidence 
)
virtual

Accept IncidenceVisitor.

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

  bool accept(Visitor &v) { return v.visit(this); }
Parameters
vis a reference to a Visitor object.
incidenceis a valid IncidenceBase object for visting.

Definition at line 206 of file incidencebase.cpp.

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

Add Attendee to this incidence.

Parameters
attendeethe attendee to add
doUpdateIf true the Observers are notified, if false they are not.

Definition at line 411 of file incidencebase.cpp.

void IncidenceBase::addComment ( const QString comment)

Adds a comment to the incidence.

Does not add a linefeed character; simply appends the text as specified.

Parameters
commentis the QString containing the comment to add.
See also
removeComment().

Definition at line 338 of file incidencebase.cpp.

void IncidenceBase::addContact ( const QString contact)

Adds a contact to thieincidence.

Does not add a linefeed character; simply appends the text as specified.

Parameters
contactis the QString containing the contact to add.
See also
removeContact().

Definition at line 373 of file incidencebase.cpp.

bool KCalendarCore::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()
IncidenceBase & IncidenceBase::assign ( const IncidenceBase other)
protectedvirtual

Provides polymorfic assignment.

Parameters
otheris the IncidenceBase to assign.

Reimplemented in KCalendarCore::Incidence, KCalendarCore::Todo, KCalendarCore::FreeBusy, KCalendarCore::Event, and KCalendarCore::Journal.

Definition at line 140 of file incidencebase.cpp.

Attendee IncidenceBase::attendeeByMail ( const QString email) const

Returns the attendee with the specified email address.

Parameters
emailis a QString containing an email address of the form "FirstName LastName <emailaddress>".
See also
attendeeByMails(), attendeesByUid().

Definition at line 471 of file incidencebase.cpp.

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

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

Parameters
emailsis a list of QStrings containing email addresses of the form "FirstName LastName <emailaddress>".
emailis a QString containing a single email address to search in addition to the list specified in emails.
See also
attendeeByMail(), attendeesByUid().

Definition at line 483 of file incidencebase.cpp.

Attendee IncidenceBase::attendeeByUid ( const QString uid) const

Returns the incidence attendee with the specified attendee UID.

Parameters
uidis a QString containing an attendee UID.
See also
attendeeByMail(), attendeeByMails().

Definition at line 502 of file incidencebase.cpp.

int IncidenceBase::attendeeCount ( ) const

Returns the number of incidence attendees.

Definition at line 434 of file incidencebase.cpp.

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

Returns a list of incidence attendees.

All pointers in the list are valid.

void IncidenceBase::clearAttendees ( )

Removes all attendees from the incidence.

Definition at line 462 of file incidencebase.cpp.

void IncidenceBase::clearComments ( )

Deletes all incidence comments.

Definition at line 362 of file incidencebase.cpp.

void IncidenceBase::clearContacts ( )

Deletes all incidence contacts.

Definition at line 400 of file incidencebase.cpp.

QStringList IncidenceBase::comments ( ) const

Returns all incidence comments as a list of strings.

Definition at line 368 of file incidencebase.cpp.

QStringList IncidenceBase::contacts ( ) const

Returns all incidence contacts as a list of strings.

Definition at line 406 of file incidencebase.cpp.

void IncidenceBase::customPropertyUpdate ( )
overrideprotectedvirtual
void IncidenceBase::customPropertyUpdated ( )
overrideprotectedvirtual
virtual QDateTime KCalendarCore::IncidenceBase::dateTime ( DateTimeRole  role) const
pure virtual

Returns a date/time corresponding to the specified DateTimeRole.

Parameters
roleis a DateTimeRole.

Implemented in KCalendarCore::Todo, KCalendarCore::FreeBusy, KCalendarCore::Event, and KCalendarCore::Journal.

void IncidenceBase::deserialize ( QDataStream in)
protectedvirtual

Sub-type specific deserialization.

Reimplemented in KCalendarCore::Incidence.

Definition at line 645 of file incidencebase.cpp.

QSet< 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()

Definition at line 620 of file incidencebase.cpp.

virtual QDateTime KCalendarCore::IncidenceBase::dtStart ( ) const
virtual

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

See also
setDtStart().

Reimplemented in KCalendarCore::Todo.

Duration IncidenceBase::duration ( ) const

Returns the length of the incidence duration.

See also
setDuration()

Definition at line 523 of file incidencebase.cpp.

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

Definition at line 590 of file incidencebase.cpp.

bool IncidenceBase::equals ( const IncidenceBase incidenceBase) const
protectedvirtual

Provides polymorfic comparison for equality.

Only called by IncidenceBase::operator==() which guarantees that incidenceBase is of the right type.

Parameters
incidenceBaseis the IncidenceBase to compare against.
Returns
true if the incidences are equal; false otherwise.

Reimplemented in KCalendarCore::Incidence, KCalendarCore::Todo, KCalendarCore::FreeBusy, KCalendarCore::Event, and KCalendarCore::Journal.

Definition at line 165 of file incidencebase.cpp.

bool IncidenceBase::hasDuration ( ) const

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

See also
setHasDuration()

Definition at line 533 of file incidencebase.cpp.

bool IncidenceBase::isReadOnly ( ) const

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

See also
setReadOnly()

Definition at line 284 of file incidencebase.cpp.

QDateTime KCalendarCore::IncidenceBase::lastModified ( ) const

Returns the time the incidence was last modified.

See also
setLastModified()
quint32 IncidenceBase::magicSerializationIdentifier ( )
static

Constant that identifies KCalendarCore data in a binary stream.

static

Since
4.12

Definition at line 651 of file incidencebase.cpp.

virtual QLatin1String KCalendarCore::IncidenceBase::mimeType ( ) const
pure virtual

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.

Implemented in KCalendarCore::Todo, KCalendarCore::FreeBusy, KCalendarCore::Event, and KCalendarCore::Journal.

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

Compares this with IncidenceBase ib for inequality.

Parameters
ibis the IncidenceBase to compare against.
Returns
true if the incidences are /not/ equal; false otherwise.

Definition at line 160 of file incidencebase.cpp.

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

Assignment operator.

All data belonging to derived classes are also copied.

See also
assign(). 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.

Parameters
otheris the IncidenceBase to assign.

Definition at line 128 of file incidencebase.cpp.

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

Compares this with IncidenceBase ib for equality.

All data belonging to derived classes are also compared.

See also
equals().
Parameters
ibis the IncidenceBase to compare against.
Returns
true if the incidences are equal; false otherwise.

Definition at line 150 of file incidencebase.cpp.

Person KCalendarCore::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(const QString &), setOrganizer(const Person &)
QDateTime IncidenceBase::recurrenceId ( ) const
virtual

Returns the incidence recurrenceId.

Returns
incidences recurrenceId value
See also
setRecurrenceId().

Reimplemented in KCalendarCore::Incidence.

Definition at line 610 of file incidencebase.cpp.

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

Register observer.

The observer is notified when the observed object changes.

Parameters
observeris a pointer to an IncidenceObserver object that will be watching this incidence.
See also
unRegisterObserver()

Definition at line 549 of file incidencebase.cpp.

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.

Parameters
commentis the QString containing the comment to remove.
Returns
true if match found, false otherwise.
See also
addComment().

Definition at line 343 of file incidencebase.cpp.

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.

Parameters
contactis the QString containing the contact to remove.
Returns
true if match found, false otherwise.
See also
addContact().

Definition at line 381 of file incidencebase.cpp.

void IncidenceBase::resetDirtyFields ( )

Resets dirty fields.

See also
dirtyFields()

Definition at line 615 of file incidencebase.cpp.

void IncidenceBase::serialize ( QDataStream out) const
protectedvirtual

Sub-type specific serialization.

Reimplemented in KCalendarCore::Incidence.

Definition at line 640 of file incidencebase.cpp.

void IncidenceBase::setAllDay ( bool  allDay)
virtual

Sets whether the incidence is all-day, i.e.

has a date but no time attached to it.

Parameters
allDaysets whether the incidence is all-day.
See also
allDay()

Reimplemented in KCalendarCore::Todo, KCalendarCore::Incidence, and KCalendarCore::Event.

Definition at line 315 of file incidencebase.cpp.

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

Set the attendees of this incidence.

This replaces all previously set attendees, unlike addAttendee.

Parameters
attendeesA list of attendees.
doUpdateIf true the Observers are notified, if false they are not.

Definition at line 439 of file incidencebase.cpp.

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

Sets the date/time corresponding to the specified DateTimeRole.

Parameters
dateTimeis QDateTime value to set.
roleis a DateTimeRole.

Implemented in KCalendarCore::Todo, KCalendarCore::FreeBusy, KCalendarCore::Event, and KCalendarCore::Journal.

void IncidenceBase::setDirtyFields ( const QSet< IncidenceBase::Field > &  dirtyFields)

Sets which fields are dirty.

See also
dirtyFields()
Since
4.8

Definition at line 635 of file incidencebase.cpp.

void IncidenceBase::setDtStart ( const QDateTime dtStart)
virtual

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

The incidence's all-day status is set according to whether dtStart is a date/time (not all-day) or date-only (all-day).

Parameters
dtStartis the incidence start date/time.
See also
dtStart().

Reimplemented in KCalendarCore::Incidence, KCalendarCore::FreeBusy, and KCalendarCore::Event.

Definition at line 289 of file incidencebase.cpp.

void IncidenceBase::setDuration ( const Duration duration)
virtual

Sets the incidence duration.

Parameters
durationthe incidence duration
See also
duration()

Reimplemented in KCalendarCore::Event.

Definition at line 514 of file incidencebase.cpp.

void IncidenceBase::setFieldDirty ( IncidenceBase::Field  field)
protected

Marks Field field as dirty.

Parameters
fieldis the Field type to mark as dirty.
See also
dirtyFields()

Definition at line 625 of file incidencebase.cpp.

void IncidenceBase::setHasDuration ( bool  hasDuration)

Sets if the incidence has a duration.

Parameters
hasDurationtrue if the incidence has a duration; false otherwise.
See also
hasDuration()

Definition at line 528 of file incidencebase.cpp.

void IncidenceBase::setLastModified ( const QDateTime lm)
virtual

Sets the time the incidence was last modified to lm.

It is stored as a UTC date/time.

Parameters
lmis the QDateTime when the incidence was last modified.
See also
lastModified()

Reimplemented in KCalendarCore::Incidence.

Definition at line 228 of file incidencebase.cpp.

void IncidenceBase::setOrganizer ( const Person organizer)

Sets the organizer for the incidence.

Parameters
organizeris a non-null Person to use as the incidence organizer.
See also
organizer(), setOrganizer(const QString &)

Definition at line 249 of file incidencebase.cpp.

void IncidenceBase::setOrganizer ( const QString organizer)

Sets the incidence organizer to any string organizer.

Parameters
organizeris a string to use as the incidence organizer.
See also
organizer(), setOrganizer(const Person &)

Definition at line 262 of file incidencebase.cpp.

void IncidenceBase::setReadOnly ( bool  readOnly)
virtual

Sets readonly status.

Parameters
readOnlyif set, the incidence is read-only; else the incidence can be modified.
See also
isReadOnly().

Reimplemented in KCalendarCore::Incidence.

Definition at line 279 of file incidencebase.cpp.

void IncidenceBase::setUid ( const QString uid)

Sets the unique id for the incidence to uid.

Parameters
uidis the string containing the incidence uid.
See also
uid()

Definition at line 213 of file incidencebase.cpp.

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.

Parameters
urlof the incience.
See also
url()
Since
4.12

Definition at line 538 of file incidencebase.cpp.

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

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 (oldSpec) of Europe/London, to a new time zone (newSpec) 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.

Parameters
oldZonethe time zone which provides the clock times
newZonethe new time zone

Reimplemented in KCalendarCore::Todo, KCalendarCore::Incidence, KCalendarCore::Event, and KCalendarCore::FreeBusy.

Definition at line 328 of file incidencebase.cpp.

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.

Definition at line 584 of file incidencebase.cpp.

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

Returns the incidence type.

Implemented in KCalendarCore::FreeBusy, KCalendarCore::Event, KCalendarCore::Todo, and KCalendarCore::Journal.

virtual QByteArray KCalendarCore::IncidenceBase::typeStr ( ) const
pure virtual

Prints the type of incidence as a string.

Implemented in KCalendarCore::FreeBusy, KCalendarCore::Event, KCalendarCore::Todo, and KCalendarCore::Journal.

QString KCalendarCore::IncidenceBase::uid ( ) const

Returns the unique id (uid) for the incidence.

See also
setUid()
void IncidenceBase::unRegisterObserver ( IncidenceBase::IncidenceObserver observer)

Unregister observer.

It isn't notified anymore about changes.

Parameters
observeris a pointer to an IncidenceObserver object that will be watching this incidence.
See also
registerObserver().

Definition at line 556 of file incidencebase.cpp.

void IncidenceBase::update ( )

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

Definition at line 561 of file incidencebase.cpp.

void IncidenceBase::updated ( )

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

Definition at line 572 of file incidencebase.cpp.

QUrl IncidenceBase::uri ( ) const

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

Definition at line 630 of file incidencebase.cpp.

QUrl IncidenceBase::url ( ) const

Returns the url.

Returns
incidences url value
See also
setUrl()
Since
4.12

Definition at line 544 of file incidencebase.cpp.

virtual void KCalendarCore::IncidenceBase::virtual_hook ( VirtualHook  id,
void *  data 
)
protectedpure virtual

Standard trick to add virtuals later.

Parameters
idis any integer unique to this class which we will use to identify the method to be called.
datais a pointer to some glob of data, typically a struct.

Implemented in KCalendarCore::Todo, KCalendarCore::FreeBusy, KCalendarCore::Event, and KCalendarCore::Journal.

Friends And Related Function Documentation

KCALENDARCORE_EXPORT QDataStream& operator<< ( QDataStream stream,
const KCalendarCore::IncidenceBase::Ptr  
)
friend

Incidence serializer.

Since
4.12
KCALENDARCORE_EXPORT QDataStream& operator>> ( QDataStream stream,
KCalendarCore::IncidenceBase::Ptr  
)
friend

Incidence deserializer.

Since
4.12

Member Data Documentation

bool KCalendarCore::IncidenceBase::mReadOnly
protected

Identifies a read-only incidence.

Definition at line 740 of file incidencebase.h.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed May 27 2020 23:07:13 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.