calformat.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_CALFORMAT_H
#define KCALCORE_CALFORMAT_H

#include "kcalcore_export.h"
#include "calendar.h"

#include <QtCore/QString>

namespace KCalCore {

class Exception;

class KCALCORE_EXPORT CalFormat
{
public:
    CalFormat();

    virtual ~CalFormat();

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

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

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

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

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

    void clearException();

    Exception *exception() const;

    static void setApplication(const QString &application,
                               const QString &productID);

    static const QString &application(); //krazy:exclude=constref

    static const QString &productId(); //krazy:exclude=constref

    QString loadedProductId();

    static QString createUniqueId();

    void setException(Exception *error);

protected:
    void setLoadedProductId(const QString &id);

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

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

}

#endif