KCalCore::ICalTimeZoneSource Class Reference

#include <icaltimezones.h>

Inherits KTimeZoneSource.

Public Member Functions
	ICalTimeZoneSource ()
virtual	~ICalTimeZoneSource ()
ICalTimeZone	parse (icalcomponent *vtimezone)
bool	parse (icalcomponent *calendar, ICalTimeZones &zones)
ICalTimeZone	parse (MSTimeZone *tz)
ICalTimeZone	parse (MSTimeZone *tz, ICalTimeZones &zones)
ICalTimeZone	parse (const QString &name, const QStringList &tzList, ICalTimeZones &zones)
ICalTimeZone	parse (const QString &name, const QStringList &tzList)
bool	parse (const QString &fileName, ICalTimeZones &zones)
ICalTimeZone	parse (icaltimezone *tz)
ICalTimeZone	standardZone (const QString &zone, bool icalBuiltIn=false)

Static Public Member Functions
static QByteArray	icalTzidPrefix ()

Protected Member Functions
virtual void	virtual_hook (int id, void *data)

Detailed Description

A class which reads and parses iCalendar VTIMEZONE components, and accesses libical time zone data.

ICalTimeZoneSource is used to parse VTIMEZONE components and create ICalTimeZone instances to represent them.

Reader and parser for iCalendar time zone data

See also

ICalTimeZone, ICalTimeZoneData

Author

David Jarvie djarv.nosp@m.ie@k.nosp@m.de.or.nosp@m.g

Definition at line 405 of file icaltimezones.h.

Constructor & Destructor Documentation

KCalCore::ICalTimeZoneSource::ICalTimeZoneSource

(

)

Constructs an iCalendar time zone source.

Definition at line 800 of file icaltimezones.cpp.

KCalCore::ICalTimeZoneSource::~ICalTimeZoneSource ( )

virtual

Destructor.

Definition at line 807 of file icaltimezones.cpp.

Member Function Documentation

QByteArray KCalCore::ICalTimeZoneSource::icalTzidPrefix ( )

static

Returns the prefix string used in the TZID field in built-in libical time zones.

The prefix string starts and ends with '/'. The name normally used for the time zone is obtained by stripping the prefix and the following characters up to the next '/', inclusive.

Returns

prefix string

Definition at line 1375 of file icaltimezones.cpp.

ICalTimeZone KCalCore::ICalTimeZoneSource::parse

(

icalcomponent *

vtimezone

)

Creates an ICalTimeZone instance containing the detailed information parsed from an iCalendar VTIMEZONE component.

Parameters

vtimezone

the VTIMEZONE component from which data is to be extracted

Returns

an ICalTimeZone instance containing the parsed data, or invalid on error

Definition at line 853 of file icaltimezones.cpp.

bool KCalCore::ICalTimeZoneSource::parse	(	icalcomponent *	calendar,
		ICalTimeZones &	zones
	)

Creates an ICalTimeZone instance for each iCalendar VTIMEZONE component within a CALENDAR component.

The ICalTimeZone instances are added to a ICalTimeZones collection.

If an error occurs while processing any time zone, any remaining time zones are left unprocessed.

Parameters

calendar	the CALENDAR component from which data is to be extracted
zones	the time zones collection to which the ICalTimeZone instances are to be added

Returns

false if any error occurred (either parsing a VTIMEZONE component or adding an ICalTimeZone to zones), true otherwise

Definition at line 833 of file icaltimezones.cpp.

ICalTimeZone KCalCore::ICalTimeZoneSource::parse

(

MSTimeZone *

tz

)

Creates an ICalTimeZone instance containing the detailed information contained in an MSTimeZone structure.

Parameters

tz	the MSTimeZone structure from which data is to be extracted

Returns

an ICalTimeZone instance containing the time zone data, or invalid on error

ICalTimeZone KCalCore::ICalTimeZoneSource::parse	(	MSTimeZone *	tz,
		ICalTimeZones &	zones
	)

Creates an ICalTimeZone instance and adds it to a ICalTimeZones collection or returns an existing instance for the MSTimeZone component.

Parameters

tz	the MSTimeZone structure to parse
zones	the time zones collection to which the ICalTimeZone instances are to be added

Returns

an ICalTimeZone instance containing the time zone data, or invalid on error

ICalTimeZone KCalCore::ICalTimeZoneSource::parse	(	const QString &	name,
		const QStringList &	tzList,
		ICalTimeZones &	zones
	)

Creates an ICalTimeZone instance containing the detailed information contained in a QStringList produced by vcalformat, and adds it to a ICalTimeZones collection or returns an existing instance for the vcal component.

Parameters

name	the name of timezone
tzList	the QStringList to parse
zones	the time zones collection to which the ICalTimeZone instances are to be added

Returns

an ICalTimeZone instance containing the time zone data, or invalid on error

Definition at line 1053 of file icaltimezones.cpp.

ICalTimeZone KCalCore::ICalTimeZoneSource::parse	(	const QString &	name,
		const QStringList &	tzList
	)

Creates an ICalTimeZone instance containing the detailed information contained in a QStringList produced by vcalformat.

Parameters

name	the name of timezone
tzList	the QStringList from which data is to be extracted

Returns

an ICalTimeZone instance containing the time zone data, or invalid on error

Definition at line 1079 of file icaltimezones.cpp.

bool KCalCore::ICalTimeZoneSource::parse	(	const QString &	fileName,
		ICalTimeZones &	zones
	)

Reads an iCalendar file and creates an ICalTimeZone instance for each VTIMEZONE component within it.

The ICalTimeZone instances are added to a ICalTimeZones collection.

If an error occurs while processing any time zone, any remaining time zones are left unprocessed.

Parameters

fileName	the file from which data is to be extracted
zones	the time zones collection to which the ICalTimeZone instances are to be added

Returns

false if any error occurred, true otherwise

Definition at line 811 of file icaltimezones.cpp.

ICalTimeZone KCalCore::ICalTimeZoneSource::parse

(

icaltimezone *

tz

)

Creates an ICalTimeZone instance containing the detailed information contained in an icaltimezone structure.

Note that an icaltimezone instance may internally refer to a built-in (i.e. system) time zone, in which case the data obtained from tz will actually be derived from the built-in time zone rather than from a VTIMEZONE component.

Parameters

tz	the icaltimezone structure from which data is to be extracted

Returns

an ICalTimeZone instance containing the time zone data, or invalid on error

Definition at line 1170 of file icaltimezones.cpp.

ICalTimeZone KCalCore::ICalTimeZoneSource::standardZone	(	const QString &	zone,
		bool	icalBuiltIn = false
	)

Creates an ICalTimeZone instance for a standard time zone.

The system time zone definition is used in preference; otherwise, the built-in libical time zone definition is used.

Parameters

zone	time zone name, which may optionally include the libical prefix string
icalBuiltIn	true to fetch only the libical built-in time zone, and ignore system time zone definitions

Returns

an ICalTimeZone instance containing the time zone data, or invalid on error

Definition at line 1338 of file icaltimezones.cpp.

void KCalCore::ICalTimeZoneSource::virtual_hook ( int  id, void *  data  )

protectedvirtual

IncidenceBase::virtual_hook()

Definition at line 1392 of file icaltimezones.cpp.

---

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

• icaltimezones.h
• icaltimezones.cpp