icalformat.h

Go to the documentation of this file.

/*
  This file is part of the kcalcore library.

  Copyright (c) 2001-2003 Cornelius Schumacher <schumacher@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 KCALCORE_ICALFORMAT_H
#define KCALCORE_ICALFORMAT_H

#include "incidence.h"
#include "freebusy.h"
#include "kcalcore_export.h"
#include "calformat.h"
#include "schedulemessage.h"

#include <KDE/KDateTime>

namespace KCalCore {

class FreeBusy;
class Incidence;
class IncidenceBase;
class RecurrenceRule;

class KCALCORE_EXPORT ICalFormat : public CalFormat
{
public:
    ICalFormat();

    virtual ~ICalFormat();

    bool load(const Calendar::Ptr &calendar, const QString &fileName);

    bool save(const Calendar::Ptr &calendar, const QString &fileName);

    bool fromString(const Calendar::Ptr &calendar, const QString &string,
                    bool deleted = false, const QString &notebook = QString());

    Incidence::Ptr fromString(const QString &string);

    bool fromString(RecurrenceRule *rule, const QString &string);

    bool fromRawString(const Calendar::Ptr &calendar, const QByteArray &string,
                       bool deleted = false, const QString &notebook = QString());

    QString toString(const Calendar::Ptr &calendar,
                     const QString &notebook = QString(), bool deleted = false);

    QString toString(const Incidence::Ptr &incidence);

    QByteArray toRawString(const Incidence::Ptr &incidence);

    QString toString(RecurrenceRule *rule);

    QString toICalString(const Incidence::Ptr &incidence);

    QString createScheduleMessage(const IncidenceBase::Ptr &incidence,
                                  iTIPMethod method);

    ScheduleMessage::Ptr parseScheduleMessage(const Calendar::Ptr &calendar,
            const QString &string);

    FreeBusy::Ptr parseFreeBusy(const QString &string);

    void setTimeSpec(const KDateTime::Spec &timeSpec);

    KDateTime::Spec timeSpec() const;

    QString timeZoneId() const;

protected:
    virtual void virtual_hook(int id, void *data);

private:
    //@cond PRIVATE
    Q_DISABLE_COPY(ICalFormat)
    class Private;
    Private *const d;
    //@endcond
};

}

#endif