• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDECore

KTimeZoneSource Class Reference
[Time zone classes]

Base class representing a source of time zone information. More...

#include <ktimezone.h>

Inheritance diagram for KTimeZoneSource:
KSystemTimeZoneSource KTzfileTimeZoneSource KSystemTimeZoneSourceWindows

List of all members.

Public Member Functions

 KTimeZoneSource ()
virtual KTimeZoneData * parse (const KTimeZone &zone) const
bool useZoneParse () const
virtual ~KTimeZoneSource ()

Protected Member Functions

 KTimeZoneSource (bool useZoneParse)

Detailed Description

Base class representing a source of time zone information.

Derive subclasses from KTimeZoneSource to read and parse time zone details from a time zone database or other source of time zone information. If can know in advance what KTimeZone instances to create without having to parse the source data, you should reimplement the virtual method parse(const KTimeZone&). Otherwise, you need to define your own parse() methods with appropriate signatures, to both read and parse the new data, and create new KTimeZone instances.

KTimeZoneSource itself may be used as a dummy source which returns empty time zone details.

Base class representing a source of time zone information

See also:
KTimeZone, KTimeZoneData
Author:
David Jarvie <djarvie@kde.org>.
S.R.Haque <srhaque@iee.org>.

Definition at line 1225 of file ktimezone.h.


Constructor & Destructor Documentation

KTimeZoneSource::KTimeZoneSource (  ) 

Definition at line 885 of file ktimezone.cpp.

KTimeZoneSource::~KTimeZoneSource (  )  [virtual]

Definition at line 897 of file ktimezone.cpp.

KTimeZoneSource::KTimeZoneSource ( bool  useZoneParse  )  [explicit, protected]

Constructor for use by derived classes, which specifies whether the source database supports the ad hoc extraction of data for individual time zones using parse(const KTimeZone&).

If parse(const KTimeZone&) cannot be used, KTimeZone derived classes which use this KTimeZoneSource derived class must create a KTimeZoneData object at construction time so that KTimeZone::data() will always return a data object.

Note the default constructor is equivalent to KTimeZoneSource(true), i.e. it is only necessary to use this constructor if parse(const KTimeZone&) does not work.

Parameters:
useZoneParse true if parse(const KTimeZone&) works, false if parsing must be performed by other methods

Definition at line 891 of file ktimezone.cpp.


Member Function Documentation

KTimeZoneData * KTimeZoneSource::parse ( const KTimeZone &  zone  )  const [virtual]

Extracts detail information for one time zone from the source database.

In this base class, the method always succeeds and returns an empty data instance. Derived classes should reimplement this method to return an appropriate data class derived from KTimeZoneData. Some source databases may not be compatible with this method of parsing. In these cases, they should use the constructor KTimeZoneSource(false) and calling this method will produce a fatal error.

Parameters:
zone the time zone for which data is to be extracted.
Returns:
an instance of a class derived from KTimeZoneData containing the parsed data. The caller is responsible for deleting the KTimeZoneData instance. Null is returned on error.

Reimplemented in KSystemTimeZoneSource, KSystemTimeZoneSourceWindows, and KTzfileTimeZoneSource.

Definition at line 902 of file ktimezone.cpp.

bool KTimeZoneSource::useZoneParse (  )  const

Return whether the source database supports the ad hoc extraction of data for individual time zones using parse(const KTimeZone&).

Returns:
true if parse(const KTimeZone&) works, false if parsing must be performed by other methods

Definition at line 908 of file ktimezone.cpp.


The documentation for this class was generated from the following files:
  • ktimezone.h
  • ktimezone.cpp

KDECore

Skip menu "KDECore"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal