libkcal

KCal::Event Class Reference

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

#include <event.h>

Inheritance diagram for KCal::Event:

KCal::Incidence KCal::IncidenceBase KCal::CustomProperties

List of all members.


Public Types

enum  Transparency { Opaque, Transparent }
typedef ListBase< EventList

Public Member Functions

 Event (const Event &)
Eventoperator= (const Event &e)
bool operator== (const Event &) const
TQCString type () const
Eventclone ()
void setDtEnd (const TQDateTime &dtEnd)
virtual TQDateTime dtEnd () const
TQDate dateEnd () const
TQString KDE_DEPRECATED dtEndTimeStr () const
TQString KDE_DEPRECATED dtEndDateStr (bool shortfmt=true) const
TQString KDE_DEPRECATED 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 TQDateTime endDateRecurrenceBase () const

Detailed Description

This class provides an Event in the sense of RFC2445.

Definition at line 32 of file event.h.


Member Enumeration Documentation

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.

void Event::setDtEnd ( const TQDateTime &  dtEnd  ) 

Set end date and time.

Definition at line 73 of file event.cpp.

TQDateTime Event::dtEnd (  )  const [virtual]

Return end date and time.

Reimplemented from KCal::Incidence.

Definition at line 85 of file event.cpp.

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.

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.

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.

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.

void Event::setHasEndDate ( bool  b  ) 

Set whether the event has an end date/time.

Definition at line 116 of file event.cpp.

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.

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.

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

Set duration of this event.

Reimplemented from KCal::IncidenceBase.

Definition at line 150 of file event.cpp.

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

Return the end date/time of the base incidence.

Reimplemented from KCal::Incidence.

Definition at line 124 of file event.h.


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