KCal::Event Class Reference
#include <event.h>
List of all members.
Detailed Description
This class provides an
Event in the sense of RFC2445.
Definition at line 40 of file event.h.
Member Typedef Documentation
Member Enumeration Documentation
The different Event transparency types.
- Enumerator:
-
Opaque |
Event appears in free/busy time. |
Transparent |
Event does not appear in free/busy time. |
Definition at line 46 of file event.h.
Constructor & Destructor Documentation
Constructs an event.
Private class that helps to provide binary compatibility between releases.
Definition at line 65 of file event.cpp.
Event::Event |
( |
const Event & |
other |
) |
|
Copy constructor.
- Parameters:
-
| other | is the event to copy. |
Definition at line 70 of file event.cpp.
Destroys the event.
Definition at line 75 of file event.cpp.
Member Function Documentation
bool Event::operator== |
( |
const Event & |
other |
) |
const |
Compares two events for equality.
- Parameters:
-
| other | is the comparison event. |
Definition at line 85 of file event.cpp.
QByteArray Event::type |
( |
|
) |
const [virtual] |
Event * Event::clone |
( |
|
) |
[virtual] |
void Event::setDtEnd |
( |
const KDateTime & |
dtEnd |
) |
|
Sets the event end date and time.
- Parameters:
-
| dtEnd | is a KDateTime specifying when the event ends. |
- See also:
- dtEnd(), dateEnd().
Definition at line 99 of file event.cpp.
KDateTime Event::dtEnd |
( |
|
) |
const [virtual] |
QDate Event::dateEnd |
( |
|
) |
const |
Returns the date 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 126 of file event.cpp.
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. |
Definition at line 136 of file event.cpp.
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. |
Definition at line 152 of file event.cpp.
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. |
Definition at line 172 of file event.cpp.
void Event::setHasEndDate |
( |
bool |
b |
) |
|
Sets whether the event has an end date/time.
- Parameters:
-
| b | If set, indicates the event has an end date. |
Definition at line 192 of file event.cpp.
bool Event::hasEndDate |
( |
|
) |
const |
Returns whether the event has an end date/time.
Definition at line 197 of file event.cpp.
bool Event::isMultiDay |
( |
const KDateTime::Spec & |
spec = KDateTime::Spec() |
) |
const |
Returns true if the event spans multiple days, otherwise return false.
- Parameters:
-
| spec | If set, looks if the event is multiday for the given spec. If not set, looks if event this multiday for its spec. |
Definition at line 202 of file event.cpp.
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.
Definition at line 222 of file event.cpp.
Sets the event's time transparency level.
- Parameters:
-
| transparency | is the event Transparency level. |
Definition at line 232 of file event.cpp.
Returns the event's time transparency level.
Definition at line 241 of file event.cpp.
void Event::setDuration |
( |
const Duration & |
duration |
) |
[virtual] |
KDateTime Event::endDateRecurrenceBase |
( |
|
) |
const [protected, virtual] |
The documentation for this class was generated from the following files: