KCalCore::ICalTimeZone Class Reference

#include <icaltimezones.h>

Inherits KTimeZone.

Public Member Functions
	ICalTimeZone ()
	ICalTimeZone (ICalTimeZoneSource *source, const QString &name, ICalTimeZoneData *data)
	ICalTimeZone (const KTimeZone &tz, const QDate &earliest=QDate())
virtual	~ICalTimeZone ()
QString	city () const
icaltimezone *	icalTimezone () const
QDateTime	lastModified () const
bool	update (const ICalTimeZone &other)
QByteArray	url () const
QByteArray	vtimezone () const

Static Public Member Functions
static ICalTimeZone	utc ()

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

Detailed Description

The ICalTimeZone class represents an iCalendar VTIMEZONE component.

ICalTimeZone instances are normally created by ICalTimeZoneSource::parse().

An iCalendar time zone

See also

ICalTimeZoneSource, ICalTimeZoneData

Author

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

Definition at line 176 of file icaltimezones.h.

Constructor & Destructor Documentation

KCalCore::ICalTimeZone::ICalTimeZone

(

)

Constructs a null time zone.

A null time zone is invalid.

See also

isValid()

Definition at line 273 of file icaltimezones.cpp.

KCalCore::ICalTimeZone::ICalTimeZone	(	ICalTimeZoneSource *	source,
		const QString &	name,
		ICalTimeZoneData *	data
	)

Creates a time zone.

This constructor is normally called from ICalTimeZoneSource::parse().

Parameters

source	iCalendar VTIMEZONE reader and parser
name	time zone's unique name within the iCalendar object
data	parsed VTIMEZONE data

Definition at line 277 of file icaltimezones.cpp.

KCalCore::ICalTimeZone::ICalTimeZone ( const KTimeZone &  tz, const QDate &  earliest = QDate()  )

explicit

Constructor which converts a KTimeZone to an ICalTimeZone instance.

Parameters

tz	KTimeZone instance
earliest	earliest date for which time zone data should be stored

Definition at line 284 of file icaltimezones.cpp.

KCalCore::ICalTimeZone::~ICalTimeZone ( )

virtual

Destructor.

Definition at line 300 of file icaltimezones.cpp.

Member Function Documentation

QString KCalCore::ICalTimeZone::city

(

)

const

Returns the name of the city for this time zone, if any.

There is no fixed format for the name.

Returns

city name

Definition at line 303 of file icaltimezones.cpp.

icaltimezone * KCalCore::ICalTimeZone::icalTimezone

(

)

const

Returns the ICal timezone structure which represents this time zone.

The caller is responsible for freeing the returned structure using icaltimezone_free().

Returns

icaltimezone structure

Definition at line 327 of file icaltimezones.cpp.

QDateTime KCalCore::ICalTimeZone::lastModified

(

)

const

Returns the LAST-MODIFIED time of the VTIMEZONE, if any.

Returns

time, or QDateTime() if none

Definition at line 315 of file icaltimezones.cpp.

bool KCalCore::ICalTimeZone::update

(

const ICalTimeZone &

other

)

Update the definition of the time zone to be identical to another ICalTimeZone instance.

A prerequisite is that the two instances must have the same name.

The purpose of this method is to enable updates of ICalTimeZone definitions when a calendar is reloaded, without invalidating pointers to the instance (particularly pointers held by KDateTime objects).

Parameters

other

time zone whose definition is to be used

Returns

true if definition was updated (i.e. names are the same)

Definition at line 333 of file icaltimezones.cpp.

QByteArray KCalCore::ICalTimeZone::url

(

)

const

Returns the URL of the published VTIMEZONE definition, if any.

Returns

URL

Definition at line 309 of file icaltimezones.cpp.

ICalTimeZone KCalCore::ICalTimeZone::utc ( )

static

Returns a standard UTC time zone, with name "UTC".

Note

The ICalTimeZone returned by this method does not belong to any ICalTimeZones collection. Any ICalTimeZones instance may contain its own UTC ICalTimeZone defined by its time zone source data, but that will be a different instance than this ICalTimeZone.

Returns

UTC time zone

Definition at line 344 of file icaltimezones.cpp.

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

protectedvirtual

IncidenceBase::virtual_hook()

Definition at line 354 of file icaltimezones.cpp.

QByteArray KCalCore::ICalTimeZone::vtimezone

(

)

const

Returns the VTIMEZONE string which represents this time zone.

Returns

VTIMEZONE string

Definition at line 321 of file icaltimezones.cpp.

---

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

• icaltimezones.h
• icaltimezones.cpp