KCal::IncidenceBase Class Reference

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

#include <incidencebase.h>

Inherits KCal::CustomProperties.

Inherited by KCal::FreeBusy, and KCal::Incidence.

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 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::List & attendees () const
int attendeeCount () const
Attendee * attendeeByMail (const QString &) const
Attendee * attendeeByMails (const QStringList &, const QString &email=QString::null) const
Attendee * attendeeByUid (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 Attributes

bool mReadOnly

Classes

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

Detailed Description

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

Member Enumeration Documentation

anonymous enum

Pilot synchronization states.

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); }

Reimplemented in KCal::Journal.

void IncidenceBase::setUid

(

const QString &

)

Set the unique id for the event.

QString IncidenceBase::uid

(

)

const

Return the unique id for the event.

void IncidenceBase::setLastModified

(

const QDateTime &

)

Sets the time the incidence was last modified.

QDateTime IncidenceBase::lastModified

(

)

const

Return the time the incidence was last modified.

void IncidenceBase::setOrganizer

(

const Person &

)

sets the organizer for the event

void IncidenceBase::setReadOnly ( bool ) [virtual]

Set readonly status.

Reimplemented in KCal::Incidence.

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

Return if the object is read-only.

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.

QDateTime IncidenceBase::dtStart ( ) const [virtual]

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

QString IncidenceBase::dtStartTimeStr ( ) const [virtual]

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

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

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

QString IncidenceBase::dtStartStr ( ) const [virtual]

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

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.

void IncidenceBase::setFloats

(

bool

)

Set whether the incidence floats, i.e.

has a date but no time attached to it.

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.

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.

void IncidenceBase::clearComments

(

)

Delete all comments associated with this incidence.

QStringList IncidenceBase::comments

(

)

const

Return all comments associated with this incidence.

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.

void IncidenceBase::clearAttendees

(

)

Remove all Attendees.

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

Return list of attendees.

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

Return number of attendees.

Attendee * IncidenceBase::attendeeByMail

(

const QString &

)

const

Return the Attendee with this email address.

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

Return first Attendee with one of the given email addresses.

Attendee * IncidenceBase::attendeeByUid

(

const QString &

uid

)

const

Return attendee with given uid.

void IncidenceBase::setSyncStatus

(

int

status

)

Set synchronisation satus.

int IncidenceBase::syncStatus

(

)

const

Return synchronisation status.

void IncidenceBase::setPilotId

(

unsigned long

)

Set Pilot Id.

unsigned long IncidenceBase::pilotId

(

)

const

Return Pilot Id.

void IncidenceBase::registerObserver

(

Observer *

)

The observer is notified when the observed object changes.

void IncidenceBase::unRegisterObserver

(

Observer *

)

Unregister observer.

It isn't notified anymore about changes.

void IncidenceBase::updated

(

)

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

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

incidencebase.h
incidencebase.cpp

libkcal

API Docs

KCal::IncidenceBase Class Reference

Public Types

Public Member Functions

Protected Attributes

Classes

Detailed Description

Member Enumeration Documentation

Member Function Documentation