Classes | Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
KCal::IncidenceBase Class Referenceabstract

#include <incidencebase.h>

Inheritance diagram for KCal::IncidenceBase:
KCal::CustomProperties KCal::FreeBusy KCal::Incidence KCal::Event KCal::Journal KCal::Todo

Classes

class  Visitor
 

Public Types

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

Public Member Functions

 IncidenceBase (const IncidenceBase &)
 
IncidenceBase & operator= (const IncidenceBase &i)
 
bool operator== (const IncidenceBase &) const
 
virtual bool accept (Visitor &)
 
virtual TQCString type () const =0
 
void setUid (const TQString &)
 
TQString uid () const
 
void setLastModified (const TQDateTime &lm)
 
TQDateTime lastModified () const
 
void setOrganizer (const Person &o)
 
void setOrganizer (const TQString &o)
 
Person organizer () const
 
virtual void setReadOnly (bool)
 
bool isReadOnly () const
 
virtual void setDtStart (const TQDateTime &dtStart)
 
virtual TQDateTime dtStart () const
 
virtual TDE_DEPRECATED TQString dtStartTimeStr () const
 
virtual TDE_DEPRECATED TQString dtStartDateStr (bool shortfmt=true) const
 
virtual TDE_DEPRECATED TQString 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 TQString &comment)
 
bool removeComment (const TQString &comment)
 
void clearComments ()
 
TQStringList comments () const
 
void addAttendee (Attendee *attendee, bool doUpdate=true)
 
void clearAttendees ()
 
const Attendee::List & attendees () const
 
int attendeeCount () const
 
Attendee * attendeeByMail (const TQString &) const
 
Attendee * attendeeByMails (const TQStringList &, const TQString &email=TQString()) const
 
Attendee * attendeeByUid (const TQString &uid) const
 
void setSyncStatus (int status)
 
void setSyncStatusSilent (int status)
 
int syncStatus () const
 
void setPilotId (unsigned long id)
 
unsigned long pilotId () const
 
void registerObserver (Observer *)
 
void unRegisterObserver (Observer *)
 
void updated ()
 
void updatedSilent ()
 
- Public Member Functions inherited from KCal::CustomProperties
 CustomProperties ()
 
 CustomProperties (const CustomProperties &)
 
bool operator== (const CustomProperties &) const
 
void setCustomProperty (const TQCString &app, const TQCString &key, const TQString &value)
 
void removeCustomProperty (const TQCString &app, const TQCString &key)
 
TQString customProperty (const TQCString &app, const TQCString &key) const
 
void setNonKDECustomProperty (const TQCString &name, const TQString &value)
 
void removeNonKDECustomProperty (const TQCString &name)
 
TQString nonKDECustomProperty (const TQCString &name) const
 
void setCustomProperties (const TQMap< TQCString, TQString > &properties)
 
TQMap< TQCString, TQString > customProperties () const
 

Protected Member Functions

virtual void customPropertyUpdated ()
 

Protected Attributes

bool mReadOnly
 

Detailed Description

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

Definition at line 45 of file incidencebase.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Pilot synchronization states.

Definition at line 234 of file incidencebase.h.

Member Function Documentation

◆ accept()

virtual bool KCal::IncidenceBase::accept ( Visitor &  )
inlinevirtual

Accept IncidenceVisitor.

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

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

Reimplemented in KCal::Journal.

Definition at line 107 of file incidencebase.h.

◆ addAttendee()

void IncidenceBase::addAttendee ( Attendee *  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 266 of file incidencebase.cpp.

◆ addComment()

void IncidenceBase::addComment ( const TQString &  comment)

Add a comment to this incidence.

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

Parameters
commentThe comment to add.

Definition at line 235 of file incidencebase.cpp.

◆ attendeeByMail()

Attendee * IncidenceBase::attendeeByMail ( const TQString &  email) const

Return the Attendee with this email address.

Definition at line 305 of file incidencebase.cpp.

◆ attendeeByMails()

Attendee * IncidenceBase::attendeeByMails ( const TQStringList &  emails,
const TQString &  email = TQString() 
) const

Return first Attendee with one of the given email addresses.

Definition at line 315 of file incidencebase.cpp.

◆ attendeeByUid()

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

Return attendee with given uid.

Definition at line 331 of file incidencebase.cpp.

◆ attendeeCount()

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

Return number of attendees.

Definition at line 216 of file incidencebase.h.

◆ attendees()

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

Return list of attendees.

Definition at line 212 of file incidencebase.h.

◆ clearAttendees()

void IncidenceBase::clearAttendees ( )

Remove all Attendees.

Definition at line 299 of file incidencebase.cpp.

◆ clearComments()

void IncidenceBase::clearComments ( )

Delete all comments associated with this incidence.

Definition at line 255 of file incidencebase.cpp.

◆ comments()

TQStringList IncidenceBase::comments ( ) const

Return all comments associated with this incidence.


Definition at line 260 of file incidencebase.cpp.

◆ customPropertyUpdated()

void IncidenceBase::customPropertyUpdated ( )
protectedvirtual

CustomProperties::customPropertyUpdated()

Reimplemented from KCal::CustomProperties.

Definition at line 417 of file incidencebase.cpp.

◆ doesFloat()

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

◆ dtStart()

TQDateTime IncidenceBase::dtStart ( ) const
virtual

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

Definition at line 201 of file incidencebase.cpp.

◆ dtStartDateStr()

TQString IncidenceBase::dtStartDateStr ( bool  shortfmt = true) const
virtual

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

Deprecated:
use IncidenceFormatter::dateToString()

Definition at line 211 of file incidencebase.cpp.

◆ dtStartStr()

TQString IncidenceBase::dtStartStr ( ) const
virtual

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

Deprecated:
use IncidenceFormatter::dateTimeToString()

Definition at line 216 of file incidencebase.cpp.

◆ dtStartTimeStr()

TQString IncidenceBase::dtStartTimeStr ( ) const
virtual

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

Deprecated:
use IncidenceFormatter::timeToString()

Definition at line 206 of file incidencebase.cpp.

◆ isReadOnly()

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

Return if the object is read-only.

Definition at line 129 of file incidencebase.h.

◆ lastModified()

TQDateTime IncidenceBase::lastModified ( ) const

Return the time the incidence was last modified.

Definition at line 159 of file incidencebase.cpp.

◆ pilotId()

unsigned long IncidenceBase::pilotId ( ) const

Return Pilot Id.

Definition at line 390 of file incidencebase.cpp.

◆ registerObserver()

void IncidenceBase::registerObserver ( IncidenceBase::Observer *  observer)

Register observer.

The observer is notified when the observed object changes.

Definition at line 395 of file incidencebase.cpp.

◆ removeComment()

bool IncidenceBase::removeComment ( const TQString &  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 240 of file incidencebase.cpp.

◆ setDtStart()

void IncidenceBase::setDtStart ( const TQDateTime &  dtStart)
virtual

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

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

Definition at line 194 of file incidencebase.cpp.

◆ setFloats()

void IncidenceBase::setFloats ( bool  f)

Set whether the incidence floats, i.e.

has a date but no time attached to it.

Definition at line 227 of file incidencebase.cpp.

◆ setLastModified()

void IncidenceBase::setLastModified ( const TQDateTime &  lm)

Sets the time the incidence was last modified.

Definition at line 145 of file incidencebase.cpp.

◆ setOrganizer()

void IncidenceBase::setOrganizer ( const Person &  o)

sets the organizer for the event

Definition at line 164 of file incidencebase.cpp.

◆ setPilotId()

void IncidenceBase::setPilotId ( unsigned long  id)

Set Pilot Id.

Definition at line 382 of file incidencebase.cpp.

◆ setReadOnly()

void IncidenceBase::setReadOnly ( bool  readOnly)
virtual

Set readonly status.

Reimplemented in KCal::Incidence.

Definition at line 189 of file incidencebase.cpp.

◆ setSyncStatus()

void IncidenceBase::setSyncStatus ( int  status)

Set synchronisation satus.

Definition at line 364 of file incidencebase.cpp.

◆ setUid()

void IncidenceBase::setUid ( const TQString &  uid)

Set the unique id for the event.

Definition at line 134 of file incidencebase.cpp.

◆ syncStatus()

int IncidenceBase::syncStatus ( ) const

Return synchronisation status.

Definition at line 377 of file incidencebase.cpp.

◆ uid()

TQString IncidenceBase::uid ( ) const

Return the unique id for the event.

Definition at line 140 of file incidencebase.cpp.

◆ unRegisterObserver()

void IncidenceBase::unRegisterObserver ( IncidenceBase::Observer *  observer)

Unregister observer.

It isn't notified anymore about changes.

Definition at line 400 of file incidencebase.cpp.

◆ updated()

void IncidenceBase::updated ( )

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

Definition at line 405 of file incidencebase.cpp.

The documentation for this class was generated from the following files: