KCal::ICalTimeZoneSource Class Reference

#include <icaltimezones.h>

Inherits KTimeZoneSource.

Public Member Functions
	ICalTimeZoneSource ()
virtual	~ICalTimeZoneSource ()
ICalTimeZone	parse (icalcomponent *vtimezone)
bool	parse (icalcomponent *calendar, ICalTimeZones &zones)
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 ()

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 softw.nosp@m.are@.nosp@m.astro.nosp@m.jar..nosp@m.org.u.nosp@m.k.

Definition at line 328 of file icaltimezones.h.

Constructor & Destructor Documentation

KCal::ICalTimeZoneSource::ICalTimeZoneSource

(

)

Constructs an iCalendar time zone source.

Definition at line 702 of file icaltimezones.cpp.

KCal::ICalTimeZoneSource::~ICalTimeZoneSource ( )

virtual

Destructor.

Definition at line 708 of file icaltimezones.cpp.

Member Function Documentation

QByteArray KCal::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 1088 of file icaltimezones.cpp.

ICalTimeZone KCal::ICalTimeZoneSource::parse

(

icalcomponent *

vtimezone

)

Creates an ICalTimeZone instance containing the detailed information parsed from a 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 754 of file icaltimezones.cpp.

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

Creates an ICalTimeZone instance for each 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 734 of file icaltimezones.cpp.

bool KCal::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 712 of file icaltimezones.cpp.

ICalTimeZone KCal::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 883 of file icaltimezones.cpp.

ICalTimeZone KCal::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 1051 of file icaltimezones.cpp.

---

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

• icaltimezones.h
• icaltimezones.cpp