KDECore
KTimeZones Class Reference
[Time zone classes]
#include <ktimezone.h>
Inherited by KSystemTimeZonesPrivate.
Detailed Description
The KTimeZones class represents a time zone database which consists of a collection of individual time zone definitions.Each individual time zone is defined in a KTimeZone instance, which provides generic support for private or system time zones. The time zones in the collection are indexed by name, which must be unique within the collection.
Different time zone sources could define the same time zone differently. (For example, a calendar file originating from another system might hold its own time zone definitions, which may not necessarily be identical to your own system's definitions.) In order to keep conflicting definitions separate, it will often be necessary when dealing with multiple time zone sources to create a separate KTimeZones instance for each source collection.
If you want to access system time zones, use the KSystemTimeZones class.
Represents a time zone database or collection
Definition at line 308 of file ktimezone.h.
Public Types | |
typedef QMap< QString, KTimeZone > | ZoneMap |
Public Member Functions | |
bool | add (const KTimeZone &zone) |
void | clear () |
KTimeZones () | |
KTimeZone | remove (const QString &name) |
KTimeZone | remove (const KTimeZone &zone) |
KTimeZone | zone (const QString &name) const |
const ZoneMap | zones () const |
~KTimeZones () |
Member Typedef Documentation
typedef QMap<QString, KTimeZone> KTimeZones::ZoneMap |
Definition at line 322 of file ktimezone.h.
Constructor & Destructor Documentation
KTimeZones::KTimeZones | ( | ) |
Definition at line 58 of file ktimezone.cpp.
KTimeZones::~KTimeZones | ( | ) |
Definition at line 63 of file ktimezone.cpp.
Member Function Documentation
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
- See also:
- remove()
Definition at line 73 of file ktimezone.cpp.
void KTimeZones::clear | ( | ) |
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 99 of file ktimezone.cpp.
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 83 of file ktimezone.cpp.
Returns the time zone with the given name.
- Parameters:
-
name name of time zone
- Returns:
- time zone, or 0 if not found
Definition at line 119 of file ktimezone.cpp.
const KTimeZones::ZoneMap KTimeZones::zones | ( | ) | const |
Returns all the time zones defined in this collection.
- Returns:
- time zone collection
Definition at line 68 of file ktimezone.cpp.
The documentation for this class was generated from the following files: