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 List of all members.

Public Member Functions

 Event (const Event &)
QCString type () const
Incidenceclone ()
void setDtEnd (const QDateTime &dtEnd)
 for setting an event's ending date/time with a QDateTime.

QDateTime dtEnd () const
 returns an event's ending date/time as a QDateTime.

QString dtEndTimeStr () const
 returns an event's end time as a string formatted according to the users locale settings

QString dtEndDateStr (bool shortfmt=true) const
 returns an event's end date as a string formatted according to the users locale settings

QString dtEndStr () const
 returns an event's end date and time as a string formatted according to the users locale settings

void setHasEndDate (bool)
bool hasEndDate () const
bool isMultiDay () const
 Return true if the event spans multiple days, otherwise return false.

void setTransparency (int transparency)
 set the event's time transparency level.

int transparency () const
 get the event's time transparency level.

void setDuration (int seconds)

Detailed Description

This class provides an Event in the sense of RFC2445.

Definition at line 34 of file event.h.


Member Function Documentation

void Event::setDtEnd const QDateTime dtEnd  ) 
 

for setting an event's ending date/time with a QDateTime.

Definition at line 51 of file event.cpp.

Referenced by KCal::DndFactory::pasteEvent(), and KCal::VCalFormat::VEventToEvent().

QDateTime Event::dtEnd  )  const
 

returns an event's ending date/time as a QDateTime.

Definition at line 63 of file event.cpp.

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

Referenced by KCal::CalendarLocal::deleteEvent(), KCal::VCalFormat::eventToVEvent(), KCal::CalendarLocal::insertEvent(), isMultiDay(), KCal::CalendarLocal::numEvents(), KCal::DndFactory::pasteEvent(), KCal::VCalFormat::populate(), KCal::CalendarLocal::rawEvents(), KCal::CalendarLocal::rawEventsForDate(), and KCal::VCalFormat::VEventToEvent().

QString Event::dtEndTimeStr  )  const
 

returns an event's end time as a string formatted according to the users locale settings

Definition at line 73 of file event.cpp.

References QDateTime::time().

QString Event::dtEndDateStr bool  shortfmt = true  )  const
 

returns an event's end date as a string formatted according to the users locale settings

Definition at line 78 of file event.cpp.

References QDateTime::date().

QString Event::dtEndStr  )  const
 

returns an event's end date and time as a string formatted according to the users locale settings

Definition at line 83 of file event.cpp.

bool Event::isMultiDay  )  const
 

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

Definition at line 98 of file event.cpp.

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

Referenced by KCal::CalendarLocal::close(), KCal::CalendarLocal::deleteEvent(), KCal::CalendarLocal::numEvents(), KCal::CalendarLocal::rawEvents(), and KCal::CalendarLocal::rawEventsForDate().

void Event::setTransparency int  transparency  ) 
 

set the event's time transparency level.

Definition at line 105 of file event.cpp.

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

int Event::transparency  )  const
 

get the event's time transparency level.

Definition at line 112 of file event.cpp.

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


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.5.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Sun Feb 15 11:40:28 2004 by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2001