#include <event.h>

Inheritance diagram for KCal::Event:

Public Types
enum	Transparency { Opaque , Transparent }
typedef ListBase< Event >	List
Public Types inherited from KCal::Incidence
enum	Status { StatusNone , StatusTentative , StatusConfirmed , StatusCompleted , StatusNeedsAction , StatusCanceled , StatusInProcess , StatusDraft , StatusFinal , StatusX }
enum	{ SecrecyPublic = 0 , SecrecyPrivate = 1 , SecrecyConfidential = 2 }
typedef ListBase< Incidence >	List
Public Types inherited from KCal::IncidenceBase
enum	{ SYNCNONE = 0 , SYNCMOD = 1 , SYNCDEL = 3 }

Public Member Functions
	Event (const Event &)
Event &	operator= (const Event &e)
bool	operator== (const Event &) const
TQCString	type () const
Event *	clone ()
void	setDtEnd (const TQDateTime &dtEnd)
virtual TQDateTime	dtEnd () const
TQDate	dateEnd () const
TQString TDE_DEPRECATED	dtEndTimeStr () const
TQString TDE_DEPRECATED	dtEndDateStr (bool shortfmt=true) const
TQString TDE_DEPRECATED	dtEndStr () const
void	setHasEndDate (bool)
bool	hasEndDate () const
bool	isMultiDay () const
void	setTransparency (Transparency transparency)
Transparency	transparency () const
void	setDuration (int seconds)
Public Member Functions inherited from KCal::Incidence
	Incidence (const Incidence &)
Incidence &	operator= (const Incidence &i)
bool	operator== (const Incidence &) const
void	setReadOnly (bool readonly)
void	setFloats (bool f)
void	recreate ()
void	setCreated (const TQDateTime &)
TQDateTime	created () const
void	setRevision (int rev)
int	revision () const
virtual void	setDtStart (const TQDateTime &dtStart)
void	setDescription (const TQString &description)
TQString	description () const
void	setSummary (const TQString &summary)
TQString	summary () const
void	setCategories (const TQStringList &categories)
void	setCategories (const TQString &catStr)
TQStringList	categories () const
TQString	categoriesStr () const
void	setRelatedToUid (const TQString &)
TQString	relatedToUid () const
void	setRelatedTo (Incidence *relatedTo)
Incidence *	relatedTo () const
Incidence::List	relations () const
void	addRelation (Incidence *)
void	removeRelation (Incidence *)
Recurrence *	recurrence () const
void	clearRecurrence ()
bool	doesRecur () const
uint	recurrenceType () const
virtual bool	recursOn (const TQDate &qd) const
bool	recursAt (const TQDateTime &qdt) const
virtual bool	recursOn (const TQDate &qd, Calendar *cal) const
bool	recursAt (const TQDateTime &qdt, Calendar *cal) const
virtual TQValueList< TQDateTime >	startDateTimesForDate (const TQDate &date) const
virtual TQValueList< TQDateTime >	startDateTimesForDateTime (const TQDateTime &datetime) const
virtual TQDateTime	endDateForStart (const TQDateTime &startDt) const
void	addAttachment (Attachment *attachment)
void	deleteAttachment (Attachment *attachment)
void	deleteAttachments (const TQString &mime)
Attachment::List	attachments () const
Attachment::List	attachments (const TQString &mime) const
void	clearAttachments ()
void	setSecrecy (int)
int	secrecy () const
TQString	secrecyStr () const
void	setStatus (Status status)
void	setCustomStatus (const TQString &status)
Status	status () const
TQString	statusStr () const
void	setResources (const TQStringList &resources)
TQStringList	resources () const
void	setPriority (int priority)
int	priority () const
bool	hasRecurrenceID () const
void	setHasRecurrenceID (bool hasRecurrenceID)
void	setRecurrenceID (const TQDateTime &recurrenceID)
TQDateTime	recurrenceID () const
void	addChildIncidence (TQString childIncidence)
void	deleteChildIncidence (TQString childIncidence)
IncidenceList	childIncidences () const
const Alarm::List &	alarms () const
Alarm *	newAlarm ()
void	addAlarm (Alarm *)
void	removeAlarm (Alarm *)
void	clearAlarms ()
bool	isAlarmEnabled () const
void	setLocation (const TQString &location)
TQString	location () const
void	setSchedulingID (const TQString &sid)
TQString	schedulingID () const
virtual void	recurrenceUpdated (Recurrence *)
Public Member Functions inherited from KCal::IncidenceBase
	IncidenceBase (const IncidenceBase &)
IncidenceBase &	operator= (const IncidenceBase &i)
bool	operator== (const IncidenceBase &) const
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
bool	isReadOnly () const
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
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 TQDateTime	endDateRecurrenceBase () const
Protected Member Functions inherited from KCal::IncidenceBase
virtual void	customPropertyUpdated ()

Additional Inherited Members
Static Public Member Functions inherited from KCal::Incidence
static TQStringList	secrecyList ()
static TQString	secrecyName (int)
static TQString	statusName (Status)
Protected Attributes inherited from KCal::IncidenceBase
bool	mReadOnly

Detailed Description

This class provides an Event in the sense of RFC2445.

Definition at line 32 of file event.h.

Member Typedef Documentation

◆ List

typedef ListBase<Event> KCal::Event::List

Definition at line 43 of file event.h.

Member Enumeration Documentation

◆ Transparency

enum KCal::Event::Transparency

Transparency of event.

Opaque - event appears in free/busy time Transparent - event doesn't appear in free/busy time

Definition at line 41 of file event.h.

Constructor & Destructor Documentation

◆ Event() [1/2]

Event::Event ( )

Definition at line 30 of file event.cpp.

◆ Event() [2/2]

Event::Event ( const Event & e )

Definition at line 35 of file event.cpp.

◆ ~Event()

Event::~Event ( )

Definition at line 42 of file event.cpp.

Member Function Documentation

◆ clone()

Event * Event::clone ( )

virtual

Return copy of this Event.

The caller owns the returned objet.

Implements KCal::Incidence.

Definition at line 47 of file event.cpp.

◆ dateEnd()

TQDate Event::dateEnd ( ) const

Returns the day when the event ends.

This might be different from dtEnd().date, since the end date/time is non-inclusive. So timed events ending at 0:00 have their end date on the day before.

Definition at line 95 of file event.cpp.

◆ dtEnd()

TQDateTime Event::dtEnd ( ) const

virtual

Return end date and time.

Reimplemented from KCal::Incidence.

Definition at line 85 of file event.cpp.

◆ dtEndDateStr()

TQString Event::dtEndDateStr ( bool shortfmt = true ) const

Return end date as string formatted according to the users locale settings.

Parameters

shortfmt if true return string in short format, if false return long format

Deprecated: use IncidenceFormatter::dateToString()

Definition at line 106 of file event.cpp.

◆ dtEndStr()

TQString Event::dtEndStr ( ) const

Return end date and time as string formatted according to the users locale settings.

Deprecated: use IncidenceFormatter::dateTimeToString()

Definition at line 111 of file event.cpp.

◆ dtEndTimeStr()

TQString Event::dtEndTimeStr ( ) const

Return end time as string formatted according to the users locale settings.

Deprecated: use IncidenceFormatter::timeToString()

Definition at line 101 of file event.cpp.

◆ endDateRecurrenceBase()

virtual TQDateTime KCal::Event::endDateRecurrenceBase ( ) const

inlineprotectedvirtual

Return the end date/time of the base incidence.

Reimplemented from KCal::Incidence.

Definition at line 124 of file event.h.

◆ hasEndDate()

bool Event::hasEndDate ( ) const

Return whether the event has an end date/time.

Definition at line 121 of file event.cpp.

◆ isMultiDay()

bool Event::isMultiDay ( ) const

Return true if the event spans multiple days, otherwise return false.

Definition at line 126 of file event.cpp.

◆ operator=()

Event & Event::operator= ( const Event & e )

Definition at line 53 of file event.cpp.

◆ operator==()

bool Event::operator== ( const Event & e2 ) const

Definition at line 62 of file event.cpp.

◆ setDtEnd()

void Event::setDtEnd ( const TQDateTime & dtEnd )

Set end date and time.

Definition at line 73 of file event.cpp.

◆ setDuration()

void Event::setDuration ( int seconds )

virtual

Set duration of this event.

Reimplemented from KCal::IncidenceBase.

Definition at line 150 of file event.cpp.

◆ setHasEndDate()

void Event::setHasEndDate ( bool b )

Set whether the event has an end date/time.

Definition at line 116 of file event.cpp.

◆ setTransparency()

void Event::setTransparency ( Event::Transparency transparency )

Set the event's time transparency level.

Definition at line 138 of file event.cpp.

◆ transparency()

Event::Transparency Event::transparency ( ) const

Return the event's time transparency level.

Definition at line 145 of file event.cpp.

◆ type()

TQCString KCal::Event::type ( ) const

inlinevirtual

Implements KCal::IncidenceBase.

Definition at line 51 of file event.h.

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

libkcal

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ List

Member Enumeration Documentation

◆ Transparency

Constructor & Destructor Documentation

◆ Event() [1/2]

◆ Event() [2/2]

◆ ~Event()

Member Function Documentation

◆ clone()

◆ dateEnd()

◆ dtEnd()

◆ dtEndDateStr()

◆ dtEndStr()

◆ dtEndTimeStr()

◆ endDateRecurrenceBase()

◆ hasEndDate()

◆ isMultiDay()

◆ operator=()

◆ operator==()

◆ setDtEnd()

◆ setDuration()

◆ setHasEndDate()

◆ setTransparency()

◆ transparency()

◆ type()

libkcal

libkcal