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:

Inheritance graph
[legend]
Collaboration diagram for KCal::Event:

Collaboration graph
[legend]
List of all members.

Public Types

typedef ListBase< EventList
enum  Transparency { Opaque, Transparent }

Public Member Functions

 Event (const Event &)
bool operator== (const Event &) const
QCString type () const
Eventclone ()
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 46 of file event.cpp.

void Event::setDtEnd const QDateTime dtEnd  ) 
 

Set end date and time.

Definition at line 63 of file event.cpp.

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

Referenced by KCal::Calendar::dissociateOccurrence(), KCal::ResourceKABC::doLoad(), KCal::DndFactory::pasteIncidence(), and KCal::VCalFormat::VEventToEvent().

QDateTime Event::dtEnd  )  const [virtual]
 

Return end date and time.

Reimplemented from KCal::Incidence.

Definition at line 75 of file event.cpp.

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

Referenced by KCal::Calendar::dissociateOccurrence(), KCal::VCalFormat::eventToVEvent(), isMultiDay(), KCal::DndFactory::pasteIncidence(), KCal::VCalFormat::populate(), 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 85 of file event.cpp.

Referenced by KCal::SelectDialog::SelectDialog().

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

Referenced by KCal::SelectDialog::SelectDialog().

QString Event::dtEndStr  )  const
 

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

Definition at line 95 of file event.cpp.

void Event::setHasEndDate bool   ) 
 

Set whether the event has an end date/time.

Definition at line 100 of file event.cpp.

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

bool Event::hasEndDate  )  const
 

Return whether the event has an end date/time.

Definition at line 105 of file event.cpp.

Referenced by dtEnd(), and KCal::SelectDialog::SelectDialog().

bool Event::isMultiDay  )  const
 

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

Definition at line 110 of file event.cpp.

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

References KCal::IncidenceBase::updated().

Referenced by KCal::ResourceKABC::doLoad(), and KCal::VCalFormat::VEventToEvent().

Event::Transparency Event::transparency  )  const
 

Return the event's time transparency level.

Definition at line 123 of file event.cpp.

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

void Event::setDuration int  seconds  )  [virtual]
 

Set duration of this event.

Reimplemented from KCal::IncidenceBase.

Definition at line 128 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.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Fri Dec 21 14:22:15 2007 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003