libkcal

KCal::Event

KCal::Event Class Reference

This class provides an Event in the sense of RFC2445. More...

#include <event.h>

Inheritance diagram for KCal::Event:

Inheritance graph
[legend]

List of all members.


Public Types

typedef ListBase< Event > List
enum  Transparency { Opaque, Transparent }

Public Member Functions

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

Protected Member Functions

virtual QDateTime endDateRecurrenceBase () const

Detailed Description

This class provides an Event in the sense of RFC2445.

Definition at line 32 of file event.h.

Member Typedef Documentation

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

Reimplemented from KCal::Incidence.

Definition at line 43 of file event.h.

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

Enumerator:
Opaque 
Transparent 

Definition at line 41 of file event.h.

Constructor & Destructor Documentation

Event::Event (  ) 

Definition at line 30 of file event.cpp.

Event::Event ( const Event &  e  ) 

Definition at line 35 of file event.cpp.

Event::~Event (  ) 

Definition at line 42 of file event.cpp.

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

QDateTime Event::dtEnd (  )  const [virtual]

Return end date and time.

Reimplemented from KCal::Incidence.

Definition at line 85 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 106 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 111 of file event.cpp.

QString Event::dtEndTimeStr (  )  const

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

Definition at line 101 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 121 of file event.h.

bool Event::hasEndDate (  )  const

Return whether the event has an end date/time.

Definition at line 121 of file event.cpp.

bool Event::isMultiDay (  )  const

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

Definition at line 126 of file event.cpp.

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

Definition at line 53 of file event.cpp.

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

Definition at line 62 of file event.cpp.

void Event::setDtEnd ( const QDateTime &  dtEnd  ) 

Set end date and time.

Definition at line 73 of file event.cpp.

void Event::setDuration ( int  seconds  )  [virtual]

Set duration of this event.

Reimplemented from KCal::IncidenceBase.

Definition at line 150 of file event.cpp.

void Event::setHasEndDate ( bool  b  ) 

Set whether the event has an end date/time.

Definition at line 116 of file event.cpp.

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

Set the event's time transparency level.

Definition at line 138 of file event.cpp.

Event::Transparency Event::transparency (  )  const

Return the event's time transparency level.

Definition at line 145 of file event.cpp.

QCString KCal::Event::type (  )  const [inline, virtual]

Implements KCal::IncidenceBase.

Definition at line 51 of file event.h.

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