KCal Library
#include <event.h>

Public Types | |
typedef boost::shared_ptr < const Event > | ConstPtr |
typedef ListBase< Event > | List |
typedef boost::shared_ptr< Event > | Ptr |
enum | Transparency { Opaque, Transparent } |
Public Member Functions | |
Event () | |
Event (const Event &other) | |
~Event () | |
Event * | clone () |
QDate | dateEnd () const |
virtual KDateTime | dtEnd () const |
QString | dtEndDateStr (bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec()) const |
QString | dtEndStr (bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec()) const |
QString | dtEndTimeStr (bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec()) const |
bool | hasEndDate () const |
bool | isMultiDay (const KDateTime::Spec &spec=KDateTime::Spec()) const |
Event & | operator= (const Event &other) |
bool | operator== (const Event &event) const |
void | setDtEnd (const KDateTime &dtEnd) |
void | setDuration (const Duration &duration) |
void | setHasEndDate (bool b) |
void | setTransparency (Transparency transparency) |
virtual void | shiftTimes (const KDateTime::Spec &oldSpec, const KDateTime::Spec &newSpec) |
Transparency | transparency () const |
QByteArray | type () const |
Protected Member Functions | |
virtual KDateTime | endDateRecurrenceBase () const |
Detailed Description
This class provides an Event in the sense of RFC2445.
Member Typedef Documentation
typedef boost::shared_ptr<const Event> KCal::Event::ConstPtr |
A shared pointer to a non-mutable Event.
Reimplemented from KCal::Incidence.
typedef ListBase<Event> KCal::Event::List |
typedef boost::shared_ptr<Event> KCal::Event::Ptr |
A shared pointer to an Event object.
Reimplemented from KCal::Incidence.
Member Enumeration Documentation
Constructor & Destructor Documentation
Event::Event | ( | ) |
Event::Event | ( | const Event & | other | ) |
Member Function Documentation
Event * Event::clone | ( | ) | [virtual] |
Returns an exact copy of this Event.
The caller owns the returned object.Implements KCal::Incidence.
QDate Event::dateEnd | ( | ) | const |
KDateTime Event::dtEnd | ( | ) | const [virtual] |
QString Event::dtEndDateStr | ( | bool | shortfmt = true , |
const KDateTime::Spec & | spec = KDateTime::Spec() |
||
) | const |
Returns the event end date as a string formatted according to the user's locale settings.
- Parameters:
-
shortfmt If set, use short date format; else use long format. spec If set, return the date in the given spec, else use the event's current spec.
QString Event::dtEndStr | ( | bool | shortfmt = true , |
const KDateTime::Spec & | spec = KDateTime::Spec() |
||
) | const |
Returns the event end date/time as string formatted according to the user's locale settings.
- Parameters:
-
shortfmt If set, use short date format; else use long format. spec If set, return the date/time in the given spec, else use the event's current spec.
QString Event::dtEndTimeStr | ( | bool | shortfmt = true , |
const KDateTime::Spec & | spec = KDateTime::Spec() |
||
) | const |
Returns the event end time as a string formatted according to the user's locale settings.
- Parameters:
-
shortfmt If set, use short date format; else use long format. spec If set, return the time in the given spec, else use the event's current spec.
KDateTime Event::endDateRecurrenceBase | ( | ) | const [protected, virtual] |
Returns the end date/time of the base incidence.
Reimplemented from KCal::Incidence.
bool Event::hasEndDate | ( | ) | const |
bool Event::isMultiDay | ( | const KDateTime::Spec & | spec = KDateTime::Spec() | ) | const |
bool Event::operator== | ( | const Event & | event | ) | const |
void Event::setDtEnd | ( | const KDateTime & | dtEnd | ) |
void Event::setDuration | ( | const Duration & | duration | ) | [virtual] |
Sets the duration of this event.
- Parameters:
-
duration is the event Duration.
Reimplemented from KCal::IncidenceBase.
void Event::setHasEndDate | ( | bool | b | ) |
void Event::setTransparency | ( | Event::Transparency | transparency | ) |
void Event::shiftTimes | ( | const KDateTime::Spec & | oldSpec, |
const KDateTime::Spec & | newSpec | ||
) | [virtual] |
Shift the times of the incidence so that they appear at the same clock time as before but in a new time zone.
The shift is done from a viewing time zone rather than from the actual incidence time zone.
For example, shifting an incidence whose start time is 09:00 America/New York, using an old viewing time zone (oldSpec
) of Europe/London, to a new time zone (newSpec
) of Europe/Paris, will result in the time being shifted from 14:00 (which is the London time of the incidence start) to 14:00 Paris time.
- Parameters:
-
oldSpec the time specification which provides the clock times newSpec the new time specification
Reimplemented from KCal::Incidence.
Event::Transparency Event::transparency | ( | ) | const |
QByteArray Event::type | ( | ) | const [virtual] |
Prints the type of Incidence as a string.
Implements KCal::IncidenceBase.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2012 The KDE developers.
Generated on Thu Aug 2 2012 15:25:54 by doxygen 1.7.5 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.