kopetepropertycontainer.h

Go to the documentation of this file.

/*
    kopetepropertycontainer.h - Kopete Property Container

    Copyright (c) 2007      by Gustavo Pichorim Boiko <gustavo.boiko@kdemail.net>
    Copyright (c) 2002-2004 by Duncan Mac-Vicar Prett <duncan@kde.org>
    Copyright (c) 2002-2003 by Martijn Klingens       <klingens@kde.org>
    Copyright (c) 2002-2004 by Olivier Goffart        <ogoffart@kde.org>

    Kopete    (c) 2002-2007 by the Kopete developers  <kopete-devel@kde.org>

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

#ifndef KOPETEPROPERTYCONTAINER_H
#define KOPETEPROPERTYCONTAINER_H

#include <QtCore/QObject>

#include <kdemacros.h>
#include "kopeteglobal.h"
#include "kopete_export.h"

namespace Kopete
{

class KOPETE_EXPORT PropertyContainer : public QObject
{
    Q_OBJECT

public: 
    PropertyContainer( QObject *parent = 0 );

    virtual ~PropertyContainer();

    void serializeProperties(QMap<QString, QString> &serializedData) const;

    void deserializeProperties(const QMap<QString, QString> &serializedData);

    QStringList properties() const;

    bool hasProperty(const QString &key) const;

    const Kopete::Property &property(const QString &key) const;
    const Kopete::Property &property(const Kopete::PropertyTmpl &tmpl) const;

    void setProperty(const Kopete::PropertyTmpl &tmpl, const QVariant &value);

    void removeProperty(const Kopete::PropertyTmpl &tmpl);

signals:
    void propertyChanged( Kopete::PropertyContainer *container, const QString &key,
        const QVariant &oldValue, const QVariant &newValue );

private:
    class Private;
    Private * const d;

};


} //END namespace Kopete

#endif