KCal::ICalTimeZones Class Reference

#include <icaltimezones.h>

Public Types
typedef QMap< QString, ICalTimeZone >	ZoneMap

Public Member Functions
	ICalTimeZones ()
	~ICalTimeZones ()
bool	add (const ICalTimeZone &zone)
void	clear ()
ICalTimeZone	remove (const ICalTimeZone &zone)
ICalTimeZone	remove (const QString &name)
ICalTimeZone	zone (const QString &name) const
const ZoneMap	zones () const

Detailed Description

The ICalTimeZones class represents a time zone database which consists of a collection of individual iCalendar time zone definitions.

Each individual time zone is defined in a ICalTimeZone instance. The time zones in the collection are indexed by name, which must be unique within the collection.

Different calendars could define the same time zone differently. As a result, to avoid conflicting definitions, each calendar should normally have its own ICalTimeZones collection.

This class is analogous to KTimeZones, but holds ICalTimeZone instances rather than generic KTimeZone instances.

Represents a collection of iCalendar time zones

Author

David Jarvie softw.nosp@m.are@.nosp@m.astro.nosp@m.jar..nosp@m.org.u.nosp@m.k.

Definition at line 64 of file icaltimezones.h.

Constructor & Destructor Documentation

KCal::ICalTimeZones::ICalTimeZones

(

)

Constructs an empty time zone collection.

Definition at line 97 of file icaltimezones.cpp.

KCal::ICalTimeZones::~ICalTimeZones

(

)

Destructor.

Definition at line 102 of file icaltimezones.cpp.

Member Function Documentation

bool KCal::ICalTimeZones::add

(

const ICalTimeZone &

zone

)

Adds a time zone to the collection.

The time zone's name must be unique within the collection.

Parameters

zone	time zone to add

Returns

true if successful, false if zone's name duplicates one already in the collection

Definition at line 112 of file icaltimezones.cpp.

void KCal::ICalTimeZones::clear

(

)

Clears the collection.

Definition at line 151 of file icaltimezones.cpp.

ICalTimeZone KCal::ICalTimeZones::remove

(

const ICalTimeZone &

zone

)

Removes a time zone from the collection.

Parameters

zone	time zone to remove

Returns

the time zone which was removed, or invalid if not found

Definition at line 125 of file icaltimezones.cpp.

ICalTimeZone KCal::ICalTimeZones::remove

(

const QString &

name

)

Removes a time zone from the collection.

Parameters

name	name of time zone to remove

Returns

the time zone which was removed, or invalid if not found

Definition at line 138 of file icaltimezones.cpp.

ICalTimeZone KCal::ICalTimeZones::zone

(

const QString &

name

)

const

Returns the time zone with the given name.

Note that the ICalTimeZone returned remains a member of the ICalTimeZones collection, and should not be deleted without calling remove() first.

Parameters

name	name of time zone

Returns

time zone, or invalid if not found

Definition at line 156 of file icaltimezones.cpp.

const ICalTimeZones::ZoneMap KCal::ICalTimeZones::zones

(

)

const

Returns all the time zones defined in this collection.

Returns

time zone collection

Definition at line 107 of file icaltimezones.cpp.

---

The documentation for this class was generated from the following files:

• icaltimezones.h
• icaltimezones.cpp