libkcal

KCal::Event Class Reference

#include <event.h>

Inheritance diagram for KCal::Event:

KCal::Incidence KCal::IncidenceBase KCal::Recurrence::Observer KCal::CustomProperties List of all members.

Detailed Description

This class provides an Event in the sense of RFC2445.

Definition at line 32 of file event.h.


Public Types

typedef ListBase< EventList
enum  Transparency { Opaque, Transparent }

Public Member Functions

 Event ()
 Event (const Event &)
 ~Event ()
bool operator== (const Event &) const
QCString type () const
Eventclone ()
void setDtEnd (const QDateTime &dtEnd)
virtual QDateTime dtEnd () const
QDate dateEnd () const
QString dtEndTimeStr () const
QString dtEndDateStr (bool shortfmt=true) const
QString dtEndStr () const
void setHasEndDate (bool)
bool hasEndDate () const
bool isMultiDay () const
void setTransparency (Transparency transparency)
Transparency transparency () const
void setDuration (int seconds)

Protected Member Functions

virtual QDateTime endDateRecurrenceBase () const

Member Enumeration Documentation

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.


Member Function Documentation

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.

QDate 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 86 of file event.cpp.

QDateTime Event::dtEnd  )  const [virtual]
 

Return end date and time.

Reimplemented from KCal::Incidence.

Definition at line 76 of file event.cpp.

QString 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

Definition at line 97 of file event.cpp.

QString Event::dtEndStr  )  const
 

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

Definition at line 102 of file event.cpp.

QString Event::dtEndTimeStr  )  const
 

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

Definition at line 92 of file event.cpp.

virtual QDateTime KCal::Event::endDateRecurrenceBase  )  const [inline, protected, virtual]
 

Return the end date/time of the base incidence.

Reimplemented from KCal::Incidence.

Definition at line 120 of file event.h.

bool Event::hasEndDate  )  const
 

Return whether the event has an end date/time.

Definition at line 112 of file event.cpp.

bool Event::isMultiDay  )  const
 

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

Definition at line 117 of file event.cpp.

void Event::setDtEnd const QDateTime &  dtEnd  ) 
 

Set end date and time.

Definition at line 64 of file event.cpp.

void Event::setDuration int  seconds  )  [virtual]
 

Set duration of this event.

Reimplemented from KCal::IncidenceBase.

Definition at line 141 of file event.cpp.

void Event::setHasEndDate bool   ) 
 

Set whether the event has an end date/time.

Definition at line 107 of file event.cpp.

void Event::setTransparency Transparency  transparency  ) 
 

Set the event's time transparency level.

Definition at line 129 of file event.cpp.

Event::Transparency Event::transparency  )  const
 

Return the event's time transparency level.

Definition at line 136 of file event.cpp.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys