customproperties.h

Go to the documentation of this file.

/*
  This file is part of the kcalcore library.

  Copyright (c) 2002,2006,2010 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 KCALCORE_CUSTOMPROPERTIES_H
#define KCALCORE_CUSTOMPROPERTIES_H

#include "kcalcore_export.h"

#include <QtCore/QMap>
#include <QtCore/QString>

namespace KCalCore {

class KCALCORE_EXPORT CustomProperties
{
    friend KCALCORE_EXPORT QDataStream &operator<<(QDataStream &s,
            const KCalCore::CustomProperties &properties);
    friend KCALCORE_EXPORT QDataStream &operator>>(QDataStream &s,
            KCalCore::CustomProperties &properties);
public:
    CustomProperties();

    CustomProperties(const CustomProperties &other);

    virtual ~CustomProperties();

    bool operator==(const CustomProperties &properties) const;

    void setCustomProperty(const QByteArray &app, const QByteArray &key,
                           const QString &value);

    void removeCustomProperty(const QByteArray &app, const QByteArray &key);

    QString customProperty(const QByteArray &app, const QByteArray &key) const;

    static QByteArray customPropertyName(const QByteArray &app, const QByteArray &key);

    void setNonKDECustomProperty(const QByteArray &name, const QString &value,
                                 const QString &parameters = QString());

    void removeNonKDECustomProperty(const QByteArray &name);

    QString nonKDECustomProperty(const QByteArray &name) const;

    QString nonKDECustomPropertyParameters(const QByteArray &name) const;

    void setCustomProperties(const QMap<QByteArray, QString> &properties);

    QMap<QByteArray, QString> customProperties() const;

    CustomProperties &operator=(const CustomProperties &other);

protected:
    virtual void customPropertyUpdate();

    virtual void customPropertyUpdated();

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

private:
    //@cond PRIVATE
    class Private;
    Private *const d;
    //@endcond
};

KCALCORE_EXPORT QDataStream &operator<<(QDataStream &stream,
                                        const KCalCore::CustomProperties &properties);

KCALCORE_EXPORT QDataStream &operator>>(QDataStream &stream,
                                        KCalCore::CustomProperties &properties);

}

#endif