libkcal Library API Documentation

KCal::IncidenceBase Class Reference

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

#include <incidencebase.h>

Inheritance diagram for KCal::IncidenceBase:

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

Public Types

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

Public Member Functions

 IncidenceBase (const IncidenceBase &)
bool operator== (const IncidenceBase &) const
virtual QCString type () const=0
void setUid (const QString &)
QString uid () const
void setLastModified (const QDateTime &lm)
QDateTime lastModified () const
void setOrganizer (const QString &o)
QString organizer () const
virtual void setReadOnly (bool)
bool isReadOnly () const
virtual void setDtStart (const QDateTime &dtStart)
QDateTime dtStart () const
QString dtStartTimeStr () const
QString dtStartDateStr (bool shortfmt=true) const
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 addAttendee (Attendee *a, bool doUpdate=true)
void clearAttendees ()
const Attendee::List & attendees () const
int attendeeCount () const
AttendeeattendeeByMail (const QString &)
AttendeeattendeeByMails (const QStringList &, const QString &email=QString::null)
void setSyncStatus (int status)
int syncStatus () const
void setPilotId (int id)
int pilotId () const
void registerObserver (Observer *)
void unRegisterObserver (Observer *)
void updated ()

Protected Attributes

bool mReadOnly

Detailed Description

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

Definition at line 40 of file incidencebase.h.


Member Enumeration Documentation

anonymous enum
 

Pilot synchronization states.

Definition at line 131 of file incidencebase.h.


Member Function Documentation

void IncidenceBase::setUid const QString &   ) 
 

Set the unique id for the event.

Definition at line 104 of file incidencebase.cpp.

References updated().

Referenced by KCal::Incidence::recreate(), KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent().

QString IncidenceBase::uid  )  const
 

Return the unique id for the event.

Definition at line 110 of file incidencebase.cpp.

Referenced by KCal::ResourceIMAP::addEvent(), KCal::ResourceIMAP::addJournal(), KCal::ResourceIMAP::addTodo(), KCal::ResourceIMAP::deleteEvent(), KCal::CalendarLocal::deleteEvent(), KCal::ResourceIMAP::deleteJournal(), KCal::ResourceIMAP::deleteTodo(), KCal::VCalFormat::eventToVEvent(), KCal::VCalFormat::eventToVTodo(), KCal::CalendarLocal::insertEvent(), KCal::ICalFormat::parseScheduleMessage(), KCal::Calendar::removeRelations(), KCal::Calendar::setupRelations(), and KCal::ResourceIMAP::update().

void IncidenceBase::setLastModified const QDateTime &  lm  ) 
 

Sets the time the incidence was last modified.

Definition at line 115 of file incidencebase.cpp.

Referenced by KCal::Incidence::recreate(), KCal::ResourceIMAP::update(), KCal::CalendarLocal::update(), KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent().

QDateTime IncidenceBase::lastModified  )  const
 

Return the time the incidence was last modified.

Definition at line 129 of file incidencebase.cpp.

Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo().

void IncidenceBase::setOrganizer const QString &  o  ) 
 

sets the organizer for the event

Definition at line 134 of file incidencebase.cpp.

References updated().

Referenced by KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent().

void IncidenceBase::setReadOnly bool   )  [virtual]
 

Set readonly status.

Reimplemented in KCal::Incidence.

Definition at line 151 of file incidencebase.cpp.

Referenced by KCal::Incidence::setReadOnly().

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

Return if the object is read-only.

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

Definition at line 156 of file incidencebase.cpp.

References updated().

Referenced by KCal::Incidence::setDtStart().

QDateTime IncidenceBase::dtStart  )  const
 

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

Definition at line 163 of file incidencebase.cpp.

Referenced by KCal::ResourceCached::addJournal(), KCal::CalendarResources::addJournal(), KCal::CalendarLocal::addJournal(), KCal::CalendarLocal::appendRecurringAlarms(), KCal::Event::dtEnd(), dtStartDateStr(), dtStartStr(), dtStartTimeStr(), KCal::VCalFormat::eventToVEvent(), KCal::VCalFormat::eventToVTodo(), KCal::Event::isMultiDay(), KCal::DndFactory::pasteIncidence(), KCal::VCalFormat::populate(), KCal::CalendarLocal::rawEvents(), KCal::CalendarLocal::rawEventsForDate(), KCal::Incidence::recurrence(), KCal::Alarm::time(), and KCal::VCalFormat::VEventToEvent().

QString IncidenceBase::dtStartTimeStr  )  const
 

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

Definition at line 168 of file incidencebase.cpp.

References dtStart().

QString IncidenceBase::dtStartDateStr bool  shortfmt = true  )  const
 

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

Definition at line 173 of file incidencebase.cpp.

References dtStart().

QString IncidenceBase::dtStartStr  )  const
 

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

Definition at line 178 of file incidencebase.cpp.

References dtStart().

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

Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo().

void IncidenceBase::setFloats bool  f  ) 
 

Set whether the incidence floats, i.e.

has a date but no time attached to it.

Definition at line 189 of file incidencebase.cpp.

References updated().

Referenced by KCal::ResourceKABC::load(), and KCal::VCalFormat::VEventToEvent().

void IncidenceBase::addAttendee Attendee a,
bool  doUpdate = true
 

Add Attendee to this incidence.

IncidenceBase takes ownership of the Attendee object.

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

Definition at line 197 of file incidencebase.cpp.

References KCal::Person::name(), KCal::Person::setName(), and updated().

Referenced by KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent().

void IncidenceBase::clearAttendees  ) 
 

Remove all Attendees.

Definition at line 230 of file incidencebase.cpp.

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

Return list of attendees.

Definition at line 113 of file incidencebase.h.

Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo().

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

Return number of attendees.

Definition at line 117 of file incidencebase.h.

Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo().

Attendee * IncidenceBase::attendeeByMail const QString &   ) 
 

Return the Attendee with this email address.

Definition at line 236 of file incidencebase.cpp.

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

Return first Attendee with one of the given email addresses.

Definition at line 246 of file incidencebase.cpp.

void IncidenceBase::setSyncStatus int  status  ) 
 

Set synchronisation satus.

Definition at line 283 of file incidencebase.cpp.

Referenced by KCal::ResourceIMAP::update(), KCal::CalendarLocal::update(), KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent().

int IncidenceBase::syncStatus  )  const
 

Return synchronisation status.

Definition at line 289 of file incidencebase.cpp.

Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo().

void IncidenceBase::setPilotId int  id  ) 
 

Set Pilot Id.

Definition at line 294 of file incidencebase.cpp.

Referenced by KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent().

int IncidenceBase::pilotId  )  const
 

Return Pilot Id.

Definition at line 301 of file incidencebase.cpp.

Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo().

void IncidenceBase::registerObserver Observer *   ) 
 

Register observer.

The observer is notified when the observed object changes.

Definition at line 306 of file incidencebase.cpp.

Referenced by KCal::ResourceIMAP::addEvent(), KCal::CalendarLocal::addEvent(), KCal::ResourceIMAP::addJournal(), KCal::CalendarLocal::addJournal(), KCal::ResourceIMAP::addTodo(), and KCal::CalendarLocal::addTodo().

void IncidenceBase::unRegisterObserver Observer *   ) 
 

Unregister observer.

It isn't notified anymore about changes.

Definition at line 311 of file incidencebase.cpp.

void IncidenceBase::updated  ) 
 

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

Definition at line 316 of file incidencebase.cpp.

Referenced by KCal::Incidence::addAlarm(), KCal::Incidence::addAttachment(), addAttendee(), KCal::Incidence::addExDate(), KCal::Incidence::addExDateTime(), KCal::Alarm::addMailAddress(), KCal::Alarm::addMailAttachment(), KCal::Incidence::addRelation(), KCal::Incidence::clearAlarms(), KCal::Incidence::removeAlarm(), KCal::Alarm::setAudioAlarm(), KCal::Alarm::setAudioFile(), KCal::Incidence::setCategories(), KCal::Todo::setCompleted(), KCal::Incidence::setDescription(), KCal::Alarm::setDisplayAlarm(), KCal::Todo::setDtDue(), KCal::Event::setDtEnd(), setDtStart(), KCal::Alarm::setEmailAlarm(), KCal::Alarm::setEnabled(), KCal::Alarm::setEndOffset(), KCal::Incidence::setExDates(), KCal::Incidence::setExDateTimes(), setFloats(), KCal::Todo::setHasDueDate(), KCal::Todo::setHasStartDate(), KCal::Incidence::setLocation(), KCal::Alarm::setMailAddress(), KCal::Alarm::setMailAddresses(), KCal::Alarm::setMailAttachment(), KCal::Alarm::setMailAttachments(), KCal::Alarm::setMailSubject(), KCal::Alarm::setMailText(), setOrganizer(), KCal::Todo::setPercentComplete(), KCal::Incidence::setPriority(), KCal::Alarm::setProcedureAlarm(), KCal::Alarm::setProgramArguments(), KCal::Alarm::setProgramFile(), KCal::Alarm::setRepeatCount(), KCal::Incidence::setResources(), KCal::Incidence::setRevision(), KCal::Incidence::setSecrecy(), KCal::Alarm::setSnoozeTime(), KCal::Alarm::setStartOffset(), KCal::Incidence::setSummary(), KCal::Alarm::setText(), KCal::Alarm::setTime(), KCal::Event::setTransparency(), KCal::Alarm::setType(), setUid(), and KCal::Alarm::toggleAlarm().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for libkcal Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Mon Apr 26 23:23:08 2004 by doxygen 1.3.6-20040222 written by Dimitri van Heesch, © 1997-2003