KCal::IncidenceBase Class Reference

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

#include <incidencebase.h>

Inheritance diagram for KCal::IncidenceBase:


Public Types
enum	{ SYNCNONE = 0, SYNCMOD = 1, SYNCDEL = 3 }
	pilot syncronization states More...
Public Member Functions
	IncidenceBase (const IncidenceBase &)
virtual QCString	type () const =0
void	setUid (const QString &)
	Set the unique id for the event.
QString	uid () const
	Return the unique id for the event.
void	setLastModified (const QDateTime &lm)
	Sets the time the incidence was last modified.
QDateTime	lastModified () const
	Return the time the incidence was last modified.
void	setOrganizer (const QString &o)
	sets the organizer for the event
QString	organizer () const
virtual void	setReadOnly (bool)
	Set readonly status.
bool	isReadOnly () const
	Return if the object is read-only.
virtual void	setDtStart (const QDateTime &dtStart)
	for setting the event's starting date/time with a QDateTime.
QDateTime	dtStart () const
	returns an event's starting date/time as a QDateTime.
QString	dtStartTimeStr () const
	returns an event's starting time as a string formatted according to the users locale settings
QString	dtStartDateStr (bool shortfmt=true) const
	returns an event's starting date as a string formatted according to the users locale settings
QString	dtStartStr () const
	returns an event's starting date and time as a string formatted according to the users locale settings
virtual void	setDuration (int seconds)
int	duration () const
void	setHasDuration (bool)
bool	hasDuration () const
bool	doesFloat () const
	returns TRUE or FALSE depending on whether the event "floats," or doesn't have a time attached to it, only a date.
void	setFloats (bool f)
	sets the event's float value.
void	addAttendee (Attendee *a, bool doupdate=true)
	Add Attendee to this incidence.
void	clearAttendees ()
	Remove all Attendees.
QPtrList< Attendee >	attendees () const
	Return list of attendees.
int	attendeeCount () const
	Return number of attendees.
Attendee *	attendeeByMail (const QString &)
	Return the Attendee with this email.
Attendee *	attendeeByMails (const QStringList &, QString email=0)
	Return first Attendee with one of this emails.
void	setSyncStatus (int stat)
	Set synchronisation satus.
int	syncStatus () const
	Return synchronisation status.
void	setPilotId (int id)
	Set Pilot Id.
int	pilotId () const
	Return Pilot Id.
void	registerObserver (Observer *)
void	updated ()
Protected Attributes
bool	mReadOnly

Detailed Description

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

Definition at line 39 of file incidencebase.h.

Member Enumeration Documentation

anonymous enum

pilot syncronization states

Definition at line 116 of file incidencebase.h.

Member Function Documentation

void IncidenceBase::setUid ( const QString & )

Set the unique id for the event.

Definition at line 68 of file incidencebase.cpp.
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 74 of file incidencebase.cpp.
Referenced by KCal::CalendarLocal::event(), KCal::VCalFormat::eventToVEvent(), KCal::VCalFormat::eventToVTodo(), KCal::CalendarLocal::journal(), KCal::ICalFormat::parseScheduleMessage(), and KCal::CalendarLocal::todo().

void IncidenceBase::setLastModified ( const QDateTime & lm )

Sets the time the incidence was last modified.

Definition at line 79 of file incidencebase.cpp.
Referenced by KCal::Incidence::recreate(), 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 86 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 91 of file incidencebase.cpp.
References QString::left(), and QString::remove().
Referenced by KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent().

void IncidenceBase::setReadOnly ( bool ) [virtual]

Set readonly status.

Reimplemented in KCal::Incidence.
Definition at line 108 of file incidencebase.cpp.

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

Return if the object is read-only.

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

QDateTime IncidenceBase::dtStart ( ) const

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

Definition at line 120 of file incidencebase.cpp.
Referenced by KCal::CalendarLocal::addJournal(), KCal::CalendarLocal::close(), KCal::CalendarLocal::deleteEvent(), KCal::Event::dtEnd(), dtStartDateStr(), dtStartStr(), dtStartTimeStr(), KCal::VCalFormat::eventToVEvent(), KCal::VCalFormat::eventToVTodo(), KCal::CalendarLocal::insertEvent(), KCal::Event::isMultiDay(), KCal::CalendarLocal::journal(), KCal::CalendarLocal::numEvents(), KCal::DndFactory::pasteEvent(), KCal::VCalFormat::populate(), KCal::CalendarLocal::rawEvents(), KCal::CalendarLocal::rawEventsForDate(), 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 125 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 130 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 135 of file incidencebase.cpp.
References dtStart().

bool IncidenceBase::doesFloat ( ) const

returns TRUE or FALSE depending on whether the event "floats," or doesn't have a time attached to it, only a date.

Definition at line 141 of file incidencebase.cpp.
Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo().

void IncidenceBase::setFloats ( bool f )

sets the event's float value.

Definition at line 146 of file incidencebase.cpp.
Referenced by KCal::VCalFormat::VEventToEvent().

void IncidenceBase::addAttendee ( Attendee * a,

bool doupdate = true

)

Add Attendee to this incidence.
IncidenceBase takes ownership of the Attendee object.
Definition at line 154 of file incidencebase.cpp.
References QPtrList< Attendee >::append().
Referenced by KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent().

void IncidenceBase::clearAttendees ( )

Remove all Attendees.

Definition at line 187 of file incidencebase.cpp.
References QPtrList< Attendee >::clear().

QPtrList<Attendee> KCal::IncidenceBase::attendees ( ) const [inline]

Return list of attendees.

Definition at line 107 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 109 of file incidencebase.h.
References QPtrList< Attendee >::count().
Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo().

Attendee * IncidenceBase::attendeeByMail ( const QString & )

Return the Attendee with this email.

Definition at line 208 of file incidencebase.cpp.
References QPtrListIterator::current(), and QPtrListIterator::toFirst().

Attendee * IncidenceBase::attendeeByMails ( const QStringList & ,

QString email = 0

)

Return first Attendee with one of this emails.

Definition at line 221 of file incidencebase.cpp.
References QPtrListIterator::current(), QString::isEmpty(), and QPtrListIterator::toFirst().

void IncidenceBase::setSyncStatus ( int stat )

Set synchronisation satus.

Definition at line 262 of file incidencebase.cpp.
Referenced by KCal::CalendarLocal::update(), KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent().

int IncidenceBase::syncStatus ( ) const

Return synchronisation status.

Definition at line 268 of file incidencebase.cpp.
Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo().

void IncidenceBase::setPilotId ( int id )

Set Pilot Id.

Definition at line 273 of file incidencebase.cpp.
Referenced by KCal::VCalFormat::VEventToEvent(), and KCal::VCalFormat::VTodoToEvent().

int IncidenceBase::pilotId ( ) const

Return Pilot Id.

Definition at line 280 of file incidencebase.cpp.
Referenced by KCal::VCalFormat::eventToVEvent(), and KCal::VCalFormat::eventToVTodo().

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

libkcal Library API Documentation

KCal::IncidenceBase Class Reference

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Member Function Documentation