• Skip to content
  • Skip to link menu
KDE 4.7 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

KCalCore Library

  • KCalCore
  • IncidenceBase
Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
KCalCore::IncidenceBase Class Reference

#include <incidencebase.h>

Inheritance diagram for KCalCore::IncidenceBase:
Inheritance graph
[legend]

List of all members.

Classes

class  IncidenceObserver
 The IncidenceObserver class. More...

Public Types

enum  DateTimeRole {
  RoleAlarmStartOffset = 0, RoleAlarmEndOffset, RoleSort, RoleCalendarHashing,
  RoleStartTimeZone, RoleEndTimeZone, RoleEndRecurrenceBase, RoleEnd,
  RoleDisplayEnd, RoleAlarm, RoleRecurrenceStart, RoleDisplayStart
}
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
}
enum  IncidenceType {
  TypeEvent = 0, TypeTodo, TypeJournal, TypeFreeBusy,
  TypeUnknown
}
typedef QSharedPointer
< IncidenceBase > 
Ptr

Public Member Functions

 IncidenceBase ()
virtual ~IncidenceBase ()
virtual bool accept (Visitor &v, IncidenceBase::Ptr incidence)
void addAttendee (const Attendee::Ptr &attendee, bool doUpdate=true)
void addComment (const QString &comment)
void addContact (const QString &contact)
bool allDay () const
Attendee::Ptr attendeeByMail (const QString &email) const
Attendee::Ptr attendeeByMails (const QStringList &emails, const QString &email=QString()) const
Attendee::Ptr 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 KDateTime dateTime (DateTimeRole role) const =0
void deleteAttendee (const Attendee::Ptr &attendee, bool doUpdate=true)
QSet< IncidenceBase::Field > dirtyFields () const
virtual KDateTime dtStart () const
Duration duration () const
void endUpdates ()
bool hasDuration () const
bool isReadOnly () const
KDateTime lastModified () const
virtual QLatin1String mimeType () const =0
bool operator!= (const IncidenceBase &ib) const
IncidenceBase & operator= (const IncidenceBase &other)
bool operator== (const IncidenceBase &ib) const
Person::Ptr organizer () const
virtual KDateTime recurrenceId () const
void registerObserver (IncidenceObserver *observer)
bool removeComment (const QString &comment)
bool removeContact (const QString &contact)
void resetDirtyFields ()
void setAllDay (bool allDay)
virtual void setDateTime (const KDateTime &dateTime, DateTimeRole role)=0
virtual void setDtStart (const KDateTime &dtStart)
virtual void setDuration (const Duration &duration)
void setHasDuration (bool hasDuration)
virtual void setLastModified (const KDateTime &lm)
void setOrganizer (const Person::Ptr &organizer)
void setOrganizer (const QString &organizer)
virtual void setReadOnly (bool readOnly)
void setUid (const QString &uid)
virtual void shiftTimes (const KDateTime::Spec &oldSpec, const KDateTime::Spec &newSpec)
void startUpdates ()
virtual IncidenceType type () const =0
virtual QByteArray typeStr () const =0
QString uid () const
void unRegisterObserver (IncidenceObserver *observer)
void update ()
void updated ()
KUrl uri () const

Protected Member Functions

 IncidenceBase (const IncidenceBase &ib)
virtual IncidenceBase & assign (const IncidenceBase &other)
virtual void customPropertyUpdate ()
virtual void customPropertyUpdated ()
virtual bool equals (const IncidenceBase &incidenceBase) const
void setFieldDirty (IncidenceBase::Field field)
virtual void virtual_hook (int id, void *data)=0

Protected Attributes

bool mReadOnly

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 + FreeBusy + Incidence + Event + Todo + Journal

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.


Member Typedef Documentation

typedef QSharedPointer<IncidenceBase> KCalCore::IncidenceBase::Ptr

A shared pointer to an IncidenceBase.

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

Definition at line 113 of file incidencebase.h.


Member Enumeration Documentation

enum KCalCore::IncidenceBase::DateTimeRole

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 KDateTime 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 KCalCore isn't compliant with RFC2445)

RoleDisplayStart 

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

To-dos return dtDue here, for historical reasons

Definition at line 131 of file incidencebase.h.

enum KCalCore::IncidenceBase::Field
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.

> Something changed. This is set when you use the assignment operator.

Definition at line 154 of file incidencebase.h.

enum KCalCore::IncidenceBase::IncidenceType

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 119 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 118 of file incidencebase.cpp.

IncidenceBase::~IncidenceBase ( ) [virtual]

Destroys the IncidenceBase.

Definition at line 132 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 125 of file incidencebase.cpp.


Member Function Documentation

bool IncidenceBase::accept ( Visitor &  v,
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 209 of file incidencebase.cpp.

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

Add Attendee to this incidence.

IncidenceBase takes ownership of the Attendee object.

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

Definition at line 407 of file incidencebase.cpp.

void IncidenceBase::addComment ( const QString &  comment)

Adds a comment to thieincidence.

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 334 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 369 of file incidencebase.cpp.

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

Definition at line 305 of file incidencebase.cpp.

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

Provides polymorfic assignment.

Parameters:
otheris the IncidenceBase to assign.

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

Definition at line 149 of file incidencebase.cpp.

Attendee::Ptr 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 481 of file incidencebase.cpp.

Attendee::Ptr 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 493 of file incidencebase.cpp.

Attendee::Ptr 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 513 of file incidencebase.cpp.

int IncidenceBase::attendeeCount ( ) const

Returns the number of incidence attendees.

Definition at line 467 of file incidencebase.cpp.

Attendee::List IncidenceBase::attendees ( ) const

Returns a list of incidence attendees.

All pointers in the list are valid.

Definition at line 462 of file incidencebase.cpp.

void IncidenceBase::clearAttendees ( )

Removes all attendees from the incidence.

Definition at line 472 of file incidencebase.cpp.

void IncidenceBase::clearComments ( )

Deletes all incidence comments.

Definition at line 358 of file incidencebase.cpp.

void IncidenceBase::clearContacts ( )

Deletes all incidence contacts.

Definition at line 396 of file incidencebase.cpp.

QStringList IncidenceBase::comments ( ) const

Returns all incidence comments as a list of strings.

Definition at line 364 of file incidencebase.cpp.

QStringList IncidenceBase::contacts ( ) const

Returns all incidence contacts as a list of strings.

Definition at line 402 of file incidencebase.cpp.

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

Called before a custom property will be changed.

The default implementation does nothing: override in derived classes to perform change processing.

Reimplemented from KCalCore::CustomProperties.

Definition at line 600 of file incidencebase.cpp.

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

Called when a custom property has been changed.

The default implementation does nothing: override in derived classes to perform change processing.

Reimplemented from KCalCore::CustomProperties.

Definition at line 605 of file incidencebase.cpp.

virtual KDateTime KCalCore::IncidenceBase::dateTime ( DateTimeRole  role) const [pure virtual]

Returns a date/time corresponding to the specified DateTimeRole.

Parameters:
roleis a DateTimeRole.

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

void IncidenceBase::deleteAttendee ( const Attendee::Ptr &  attendee,
bool  doUpdate = true 
)

Delete single attendee from the incidence.

The given attendee will be delete()d at the end of this call.

Parameters:
attendeeThe attendee to be removeComment
doUpdateIf true the Observers are notified, if false they are not.

Definition at line 441 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.

KDateTime IncidenceBase::dtStart ( ) const [virtual]

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

See also:
setDtStart().

Reimplemented in KCalCore::Todo.

Definition at line 300 of file incidencebase.cpp.

Duration IncidenceBase::duration ( ) const

Returns the length of the incidence duration.

See also:
setDuration()

Definition at line 534 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 [protected, virtual]

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 KCalCore::Incidence, KCalCore::Todo, KCalCore::FreeBusy, KCalCore::Event, and KCalCore::Journal.

Definition at line 174 of file incidencebase.cpp.

bool IncidenceBase::hasDuration ( ) const

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

See also:
setHasDuration()

Definition at line 544 of file incidencebase.cpp.

bool IncidenceBase::isReadOnly ( ) const

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

See also:
setReadOnly()

Definition at line 285 of file incidencebase.cpp.

KDateTime IncidenceBase::lastModified ( ) const

Returns the time the incidence was last modified.

See also:
setLastModified()

Definition at line 245 of file incidencebase.cpp.

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

Returns the Akonadi specific sub MIME type of a KCalCore::IncidenceBase item, e.g.

getting "application/x-vnd.akonadi.calendar.event" for a KCalCore::Event.

Implemented in KCalCore::Todo, KCalCore::FreeBusy, KCalCore::Event, and KCalCore::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 169 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 {
        kDebug() << "Invalid assignment!";
      }

Dirty field FieldUnknown will be set.

Parameters:
otheris the IncidenceBase to assign.

Definition at line 137 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 159 of file incidencebase.cpp.

Person::Ptr IncidenceBase::organizer ( ) const

Returns the Person associated with this incidence.

See also:
setOrganizer(const QString &), setOrganizer(const Person &)

Definition at line 275 of file incidencebase.cpp.

KDateTime IncidenceBase::recurrenceId ( ) const [virtual]

Returns the incidence recurrenceId.

Returns:
incidences recurrenceId value
See also:
setRecurrenceId().

Reimplemented in KCalCore::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 339 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 377 of file incidencebase.cpp.

void IncidenceBase::resetDirtyFields ( )

Resets dirty fields.

See also:
dirtyFields()

Definition at line 615 of file incidencebase.cpp.

void IncidenceBase::setAllDay ( bool  allDay)

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 KCalCore::Todo, KCalCore::Event, and KCalCore::Incidence.

Definition at line 310 of file incidencebase.cpp.

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

Sets the date/time corresponding to the specified DateTimeRole.

Parameters:
dateTimeis KDateTime value to set.
roleis a DateTimeRole.

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

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

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

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 KCalCore::Incidence, KCalCore::Todo, KCalCore::FreeBusy, and KCalCore::Event.

Definition at line 290 of file incidencebase.cpp.

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

Sets the incidence duration.

Parameters:
durationthe incidence duration
See also:
duration()

Reimplemented in KCalCore::Event.

Definition at line 525 of file incidencebase.cpp.

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

Marks Field field 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 539 of file incidencebase.cpp.

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

Sets the time the incidence was last modified to lm.

It is stored as a UTC date/time.

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

Reimplemented in KCalCore::Incidence.

Definition at line 229 of file incidencebase.cpp.

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

Sets the organizer for the incidence.

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

Definition at line 250 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 263 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 KCalCore::Incidence.

Definition at line 280 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 216 of file incidencebase.cpp.

void IncidenceBase::shiftTimes ( const KDateTime::Spec &  oldSpec,
const KDateTime::Spec &  newSpec 
) [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:
oldSpecthe time specification which provides the clock times
newSpecthe new time specification

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

Definition at line 323 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 KCalCore::IncidenceBase::type ( ) const [pure virtual]

Returns the incidence type.

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

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

Prints the type of incidence as a string.

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

QString IncidenceBase::uid ( ) const

Returns the unique id (uid) for the incidence.

See also:
setUid()

Definition at line 224 of file incidencebase.cpp.

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.

KUrl IncidenceBase::uri ( ) const

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

Definition at line 630 of file incidencebase.cpp.

virtual void KCalCore::IncidenceBase::virtual_hook ( int  id,
void *  data 
) [protected, pure 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.

Reimplemented from KCalCore::CustomProperties.

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


Member Data Documentation

bool KCalCore::IncidenceBase::mReadOnly [protected]

Identifies a read-only incidence.

Definition at line 697 of file incidencebase.h.


The documentation for this class was generated from the following files:
  • incidencebase.h
  • incidencebase.cpp

KCalCore Library

Skip menu "KCalCore Library"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.5
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal