icaltimezones.h

/*
  This file is part of the kcal library.

  Copyright (c) 2005-2007 David Jarvie <djarvie@kde.org>

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Library General Public
  License as published by the Free Software Foundation; either
  version 2 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Library General Public License for more details.

  You should have received a copy of the GNU Library General Public License
  along with this library; see the file COPYING.LIB.  If not, write to
  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  Boston, MA 02110-1301, USA.
*/

#ifndef KCAL_ICALTIMEZONES_H
#define KCAL_ICALTIMEZONES_H

#include <ktimezone.h>

#include "kcal_export.h"

#ifndef ICALCOMPONENT_H
typedef struct icalcomponent_impl icalcomponent;
#endif
#ifndef ICALTIMEZONE_DEFINED
#define ICALTIMEZONE_DEFINED
typedef struct _icaltimezone  icaltimezone;
#endif

namespace KCal {

class ICalTimeZone;
class ICalTimeZoneSource;
class ICalTimeZoneData;
class ICalTimeZonesPrivate;
class ICalTimeZonePrivate;
class ICalTimeZoneSourcePrivate;
class ICalTimeZoneDataPrivate;

class KCAL_DEPRECATED_EXPORT ICalTimeZones
{
  public:
    ICalTimeZones();
    ~ICalTimeZones();

    ICalTimeZone zone( const QString &name ) const;

    typedef QMap<QString, ICalTimeZone> ZoneMap;

    const ZoneMap zones() const;

    bool add( const ICalTimeZone &zone );

    ICalTimeZone remove( const ICalTimeZone &zone );

    ICalTimeZone remove( const QString &name );

    void clear();

  private:
    ICalTimeZones( const ICalTimeZones & );            // prohibit copying
    ICalTimeZones &operator=( const ICalTimeZones & ); // prohibit copying

    ICalTimeZonesPrivate *const d;
};

class KCAL_DEPRECATED_EXPORT ICalTimeZone : public KTimeZone  //krazy:exclude=dpointer
                                                   //(no d-pointer for KTimeZone derived classes)
{
  public:
    ICalTimeZone();

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

    explicit ICalTimeZone( const KTimeZone &tz, const QDate &earliest = QDate() );

    virtual ~ICalTimeZone();

    QString city() const;

    QByteArray url() const;

    QDateTime lastModified() const;

    QByteArray vtimezone() const;

    icaltimezone *icalTimezone() const;

    bool update( const ICalTimeZone &other );

    static ICalTimeZone utc();

  private:
    // d-pointer is in ICalTimeZoneBackend.
    // This is a requirement for classes inherited from KTimeZone.
};

class KCAL_DEPRECATED_EXPORT ICalTimeZoneBackend : public KTimeZoneBackend
{
  public:
    ICalTimeZoneBackend();
    ICalTimeZoneBackend( ICalTimeZoneSource *source, const QString &name,
                         const QString &countryCode = QString(),
                         float latitude = KTimeZone::UNKNOWN,
                         float longitude = KTimeZone::UNKNOWN,
                         const QString &comment = QString() );

    ICalTimeZoneBackend( const KTimeZone &tz, const QDate &earliest );

    virtual ~ICalTimeZoneBackend();

    virtual KTimeZoneBackend *clone() const;

    virtual QByteArray type() const;

    virtual bool hasTransitions( const KTimeZone *caller ) const;

  private:
    ICalTimeZonePrivate *d; //krazy:exclude=dpointer
                            //(non-const d-pointer for KTimeZoneBackend-derived classes)
};

class KCAL_DEPRECATED_EXPORT ICalTimeZoneSource : public KTimeZoneSource
{
  public:
    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 QByteArray icalTzidPrefix();

    using KTimeZoneSource::parse; // prevent warning about hidden virtual method

  private:
    ICalTimeZoneSourcePrivate *const d;
};

class KCAL_DEPRECATED_EXPORT ICalTimeZoneData : public KTimeZoneData
{
  friend class ICalTimeZoneSource;

  public:
    ICalTimeZoneData();

    ICalTimeZoneData( const ICalTimeZoneData &rhs );

    ICalTimeZoneData( const KTimeZoneData &rhs, const KTimeZone &tz, const QDate &earliest );

    virtual ~ICalTimeZoneData();

    ICalTimeZoneData &operator=( const ICalTimeZoneData &rhs );

    virtual KTimeZoneData *clone() const;

    QString city() const;

    QByteArray url() const;

    QDateTime lastModified() const;

    QByteArray vtimezone() const;

    icaltimezone *icalTimezone() const;

    virtual bool hasTransitions() const;

  private:
    ICalTimeZoneDataPrivate *const d;
};

}

#endif