• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.8.5 API Reference
  • KDE Home
  • Contact Us
 

KCalCore Library

  • KCalCore
  • ICalTimeZone
Public Member Functions | Static Public Member Functions | Protected Member Functions
KCalCore::ICalTimeZone Class Reference

#include <icaltimezones.h>

Inherits KTimeZone.

List of all members.

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 <djarvie@kde.org>

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:
sourceiCalendar VTIMEZONE reader and parser
nametime zone's unique name within the iCalendar object
dataparsed 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:
tzKTimeZone instance
earliestearliest 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:
othertime 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 
) [protected, virtual]

Standard trick to add virtuals later.

Parameters:
idis any integer unique to this class which we will use to identify the method to be called.
datais a pointer to some glob of data, typically a struct.

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
This file is part of the KDE documentation.
Documentation copyright © 1996-2012 The KDE developers.
Generated on Thu Aug 2 2012 15:24:13 by doxygen 1.7.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KCalCore Library

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

kdepimlibs-4.8.5 API Reference

Skip menu "kdepimlibs-4.8.5 API Reference"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal