libkcal

KCal::IncidenceBase Class Reference

#include <incidencebase.h>

Inheritance diagram for KCal::IncidenceBase:

KCal::CustomProperties KCal::FreeBusy KCal::Incidence KCal::Event KCal::Journal KCal::Todo List of all members.

Detailed Description

This class provides the base class common to all calendar components.

Definition at line 45 of file incidencebase.h.


Public Types

enum  { SYNCNONE = 0, SYNCMOD = 1, SYNCDEL = 3 }

Public Member Functions

 IncidenceBase ()
 IncidenceBase (const IncidenceBase &)
virtual ~IncidenceBase ()
bool operator== (const IncidenceBase &) const
virtual bool accept (Visitor &)
virtual QCString type () const=0
void setUid (const QString &)
QString uid () const
void setLastModified (const QDateTime &lm)
QDateTime lastModified () const
void setOrganizer (const Person &o)
void setOrganizer (const QString &o)
Person organizer () const
virtual void setReadOnly (bool)
bool isReadOnly () const
virtual void setDtStart (const QDateTime &dtStart)
virtual QDateTime dtStart () const
virtual QString dtStartTimeStr () const
virtual QString dtStartDateStr (bool shortfmt=true) const
virtual QString dtStartStr () const
virtual void setDuration (int seconds)
int duration () const
void setHasDuration (bool)
bool hasDuration () const
bool doesFloat () const
void setFloats (bool f)
void addComment (const QString &comment)
bool removeComment (const QString &comment)
void clearComments ()
QStringList comments () const
void addAttendee (Attendee *attendee, bool doUpdate=true)
void clearAttendees ()
const Attendee::Listattendees () const
int attendeeCount () const
AttendeeattendeeByMail (const QString &) const
AttendeeattendeeByMails (const QStringList &, const QString &email=QString::null) const
AttendeeattendeeByUid (const QString &uid) const
void setSyncStatus (int status)
int syncStatus () const
void setPilotId (unsigned long id)
unsigned long pilotId () const
void registerObserver (Observer *)
void unRegisterObserver (Observer *)
void updated ()

Protected Member Functions

virtual void customPropertyUpdated ()

Protected Attributes

bool mReadOnly

Classes

class  Observer
class  Visitor
 This class provides the interface for a visitor of calendar components. More...

Member Enumeration Documentation

anonymous enum

Pilot synchronization states.

Definition at line 220 of file incidencebase.h.


Member Function Documentation

virtual bool KCal::IncidenceBase::accept ( Visitor  )  [inline, virtual]

Accept IncidenceVisitor.

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

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

Definition at line 105 of file incidencebase.h.

void IncidenceBase::setUid ( const QString &   ) 

Set the unique id for the event.

Definition at line 110 of file incidencebase.cpp.

QString IncidenceBase::uid (  )  const

Return the unique id for the event.

Definition at line 116 of file incidencebase.cpp.

void IncidenceBase::setLastModified ( const QDateTime &  lm  ) 

Sets the time the incidence was last modified.

Definition at line 121 of file incidencebase.cpp.

QDateTime IncidenceBase::lastModified (  )  const

Return the time the incidence was last modified.

Definition at line 135 of file incidencebase.cpp.

void IncidenceBase::setOrganizer ( const Person o  ) 

sets the organizer for the event

Definition at line 140 of file incidencebase.cpp.

void IncidenceBase::setReadOnly ( bool   )  [virtual]

Set readonly status.

Reimplemented in KCal::Incidence.

Definition at line 165 of file incidencebase.cpp.

bool KCal::IncidenceBase::isReadOnly (  )  const [inline]

Return if the object is read-only.

Definition at line 127 of file incidencebase.h.

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

for setting the event's starting date/time with a QDateTime.

Reimplemented in KCal::Incidence, and KCal::Todo.

Definition at line 170 of file incidencebase.cpp.

QDateTime IncidenceBase::dtStart (  )  const [virtual]

returns an event's starting date/time as a QDateTime.

Definition at line 177 of file incidencebase.cpp.

QString IncidenceBase::dtStartTimeStr (  )  const [virtual]

returns an event's starting time as a string formatted according to the users locale settings

Definition at line 182 of file incidencebase.cpp.

QString IncidenceBase::dtStartDateStr ( bool  shortfmt = true  )  const [virtual]

returns an event's starting date as a string formatted according to the users locale settings

Definition at line 187 of file incidencebase.cpp.

QString IncidenceBase::dtStartStr (  )  const [virtual]

returns an event's starting date and time as a string formatted according to the users locale settings

Definition at line 192 of file incidencebase.cpp.

bool IncidenceBase::doesFloat (  )  const

Return true or false depending on whether the incidence "floats," i.e.

has a date but no time attached to it.

Definition at line 198 of file incidencebase.cpp.

void IncidenceBase::setFloats ( bool  f  ) 

Set whether the incidence floats, i.e.

has a date but no time attached to it.

Reimplemented in KCal::Incidence.

Definition at line 203 of file incidencebase.cpp.

void IncidenceBase::addComment ( const QString &  comment  ) 

Add a comment to this incidence.

Does not add a linefeed character. Just appends the text as passed in.

Parameters:
comment The comment to add.

Definition at line 211 of file incidencebase.cpp.

bool IncidenceBase::removeComment ( const QString &  comment  ) 

Remove a comment from the event.

Removes first comment whose string is an exact match for the string passed in.

Returns:
true if match found, false otherwise.

Definition at line 216 of file incidencebase.cpp.

void IncidenceBase::clearComments (  ) 

Delete all comments associated with this incidence.

Definition at line 231 of file incidencebase.cpp.

QStringList IncidenceBase::comments (  )  const

Return all comments associated with this incidence.

Definition at line 236 of file incidencebase.cpp.

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

Add Attendee to this incidence.

IncidenceBase takes ownership of the Attendee object.

Parameters:
attendee a pointer to the attendee to add
doUpdate If true the Observers are notified, if false they are not.

Definition at line 242 of file incidencebase.cpp.

void IncidenceBase::clearAttendees (  ) 

Remove all Attendees.

Definition at line 275 of file incidencebase.cpp.

const Attendee::List& KCal::IncidenceBase::attendees (  )  const [inline]

Return list of attendees.

Definition at line 198 of file incidencebase.h.

int KCal::IncidenceBase::attendeeCount (  )  const [inline]

Return number of attendees.

Definition at line 202 of file incidencebase.h.

Attendee * IncidenceBase::attendeeByMail ( const QString &   )  const

Return the Attendee with this email address.

Definition at line 281 of file incidencebase.cpp.

Attendee * IncidenceBase::attendeeByMails ( const QStringList &  ,
const QString &  email = QString::null 
) const

Return first Attendee with one of the given email addresses.

Definition at line 291 of file incidencebase.cpp.

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

Return attendee with given uid.

Definition at line 307 of file incidencebase.cpp.

void IncidenceBase::setSyncStatus ( int  status  ) 

Set synchronisation satus.

Definition at line 340 of file incidencebase.cpp.

int IncidenceBase::syncStatus (  )  const

Return synchronisation status.

Definition at line 346 of file incidencebase.cpp.

void IncidenceBase::setPilotId ( unsigned long  id  ) 

Set Pilot Id.

Definition at line 351 of file incidencebase.cpp.

unsigned long IncidenceBase::pilotId (  )  const

Return Pilot Id.

Definition at line 358 of file incidencebase.cpp.

void IncidenceBase::registerObserver ( Observer  ) 

Register observer.

The observer is notified when the observed object changes.

Definition at line 363 of file incidencebase.cpp.

void IncidenceBase::unRegisterObserver ( Observer  ) 

Unregister observer.

It isn't notified anymore about changes.

Definition at line 368 of file incidencebase.cpp.

void IncidenceBase::updated (  ) 

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

Definition at line 373 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 KCal::CustomProperties.

Definition at line 383 of file incidencebase.cpp.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys