customproperties.h

Go to the documentation of this file.

/*
  This file is part of the kcal 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 KCAL_CUSTOMPROPERTIES_H
#define KCAL_CUSTOMPROPERTIES_H

#include "kcal_export.h"

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

namespace KCal {

class KCAL_DEPRECATED_EXPORT CustomProperties
{
  public:
    CustomProperties();

    CustomProperties( const CustomProperties &other );

    virtual ~CustomProperties();

    // KDE5: make protected to prevent accidental usage
    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 );

    void removeNonKDECustomProperty( const QByteArray &name );

    QString nonKDECustomProperty( const QByteArray &name ) const;

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

    QMap<QByteArray, QString> customProperties() const;

    // KDE5: make protected to prevent accidental usage
    CustomProperties &operator=( const CustomProperties &other );

  protected:
    virtual void customPropertyUpdated()  {}

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

}

#endif