libkcal Library API Documentation

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

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

Public Methods

 Event ()
 Event (const Event &)
 ~Event ()
bool operator== (const Event &) const
QCString type () const
Event * clone ()
void setDtEnd (const QDateTime &dtEnd)
virtual QDateTime dtEnd () 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)

Detailed Description

This class provides an Event in the sense of RFC2445.

Definition at line 31 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

Definition at line 40 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 45 of file event.cpp.

void Event::setDtEnd const QDateTime   dtEnd
 

Set end date and time.

Definition at line 62 of file event.cpp.

References setHasEndDate(), and KCal::IncidenceBase::updated().

Referenced by KCal::ResourceKABC::load(), KCal::DndFactory::pasteIncidence(), and KCal::VCalFormat::VEventToEvent().

QDateTime Event::dtEnd   const [virtual]
 

Return end date and time.

Reimplemented from KCal::Incidence.

Definition at line 74 of file event.cpp.

References QDateTime::addSecs(), KCal::IncidenceBase::dtStart(), hasEndDate(), and KCal::Incidence::summary().

Referenced by KCal::VCalFormat::eventToVEvent(), isMultiDay(), KCal::DndFactory::pasteIncidence(), KCal::VCalFormat::populate(), KCal::CalendarLocal::rawEvents(), KCal::CalendarLocal::rawEventsForDate(), and KCal::VCalFormat::VEventToEvent().

QString Event::dtEndTimeStr   const
 

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

Definition at line 84 of file event.cpp.

References QDateTime::time().

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

References QDateTime::date().

QString Event::dtEndStr   const
 

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

Definition at line 94 of file event.cpp.

void Event::setHasEndDate bool   
 

Set whether the event has an end date/time.

Definition at line 99 of file event.cpp.

Referenced by KCal::ResourceKABC::load(), setDtEnd(), and setDuration().

bool Event::hasEndDate   const
 

Return whether the event has an end date/time.

Definition at line 104 of file event.cpp.

Referenced by dtEnd().

bool Event::isMultiDay   const
 

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

Definition at line 109 of file event.cpp.

References QDateTime::date(), dtEnd(), and KCal::IncidenceBase::dtStart().

Referenced by KCal::CalendarLocal::rawEventsForDate().

void Event::setTransparency Transparency    transparency
 

Set the event's time transparency level.

Definition at line 115 of file event.cpp.

References transparency(), and KCal::IncidenceBase::updated().

Referenced by KCal::VCalFormat::VEventToEvent().

Event::Transparency Event::transparency   const
 

Return the event's time transparency level.

Definition at line 122 of file event.cpp.

Referenced by KCal::VCalFormat::eventToVEvent(), and setTransparency().

void Event::setDuration int    seconds [virtual]
 

Set duration of this event.

Reimplemented from KCal::IncidenceBase.

Definition at line 127 of file event.cpp.

References setHasEndDate().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for libkcal Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat May 1 11:36:24 2004 by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2003