KCal Library
#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
Definition at line 64 of file icaltimezones.h.
Member Typedef Documentation
◆ ZoneMap
typedef QMap<QString, ICalTimeZone> KCal::ICalTimeZones::ZoneMap |
Definition at line 86 of file icaltimezones.h.
Constructor & Destructor Documentation
◆ ICalTimeZones()
KCal::ICalTimeZones::ICalTimeZones | ( | ) |
Constructs an empty time zone collection.
Definition at line 96 of file icaltimezones.cpp.
◆ ~ICalTimeZones()
KCal::ICalTimeZones::~ICalTimeZones | ( | ) |
Destructor.
Definition at line 101 of file icaltimezones.cpp.
Member Function Documentation
◆ add()
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 111 of file icaltimezones.cpp.
◆ clear()
void KCal::ICalTimeZones::clear | ( | ) |
Clears the collection.
Definition at line 150 of file icaltimezones.cpp.
◆ remove() [1/2]
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 124 of file icaltimezones.cpp.
◆ remove() [2/2]
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 137 of file icaltimezones.cpp.
◆ zone()
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 155 of file icaltimezones.cpp.
◆ zones()
const ICalTimeZones::ZoneMap KCal::ICalTimeZones::zones | ( | ) | const |
Returns all the time zones defined in this collection.
- Returns
- time zone collection
Definition at line 106 of file icaltimezones.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.