• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

KCal Library

KCal::ICalTimeZone

KCal::ICalTimeZone Class Reference

#include <icaltimezones.h>

Inherits KTimeZone.

List of all members.


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 <software@astrojar.org.uk>.

Definition at line 142 of file icaltimezones.h.


Public Member Functions

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

Static Public Member Functions

static ICalTimeZone utc ()

Constructor & Destructor Documentation

KCal::ICalTimeZone::ICalTimeZone (  ) 

Constructs a null time zone.

A null time zone is invalid.

See also:
isValid()

Definition at line 208 of file icaltimezones.cpp.

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

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

KCal::ICalTimeZone::~ICalTimeZone (  )  [virtual]

Destructor.

Definition at line 235 of file icaltimezones.cpp.


Member Function Documentation

QString KCal::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 238 of file icaltimezones.cpp.

icaltimezone * KCal::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 262 of file icaltimezones.cpp.

QDateTime KCal::ICalTimeZone::lastModified (  )  const

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

Returns:
time, or QDateTime() if none

Definition at line 250 of file icaltimezones.cpp.

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

QByteArray KCal::ICalTimeZone::url (  )  const

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

Returns:
URL

Definition at line 244 of file icaltimezones.cpp.

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

QByteArray KCal::ICalTimeZone::vtimezone (  )  const

Returns the VTIMEZONE string which represents this time zone.

Returns:
VTIMEZONE string

Definition at line 256 of file icaltimezones.cpp.


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

KCal Library

Skip menu "KCal Library"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  • kabc
  • kblog
  • kcal
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.6
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