kopeteproperty.h

Go to the documentation of this file.

/*
    kopeteproperty.h

    Kopete::Property class

    Copyright (c) 2007    by Gustavo Pichorim Boiko <gustavo.boiko@kdemail.net>
    Copyright (c) 2004    by Stefan Gehn <metz AT gehn.net>
    Copyright (c) 2006    by Michaël Larouche <larouche@kde.org>

    Kopete    (c) 2004-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 _KOPETEPROPERTY_H_
#define _KOPETEPROPERTY_H_

#include <QtCore/QVariant>
#include <QtCore/QFlags>

#include "kopete_export.h"

namespace Kopete
{

class KOPETE_EXPORT PropertyTmpl
{
    public:
        enum PropertyOption 
        { 
            NoProperty = 0x0,
            PersistentProperty = 0x1, 
            RichTextProperty = 0x2, 
            PrivateProperty = 0x4 
        };
        Q_DECLARE_FLAGS(PropertyOptions, PropertyOption)

        
        PropertyTmpl();

        PropertyTmpl( const QString &key,
            const QString &label,
            const QString &icon = QString(),
            PropertyOptions options = NoProperty);

        PropertyTmpl(const PropertyTmpl &other);

        ~PropertyTmpl();

        PropertyTmpl &operator=(const PropertyTmpl &other);

        bool operator==(const PropertyTmpl &other) const;
        bool operator!=(const PropertyTmpl &other) const;

        const QString &key() const;

        const QString &label() const;

        const QString &icon() const;

        PropertyOptions options() const;

        bool persistent() const;

        bool isRichText() const;

        bool isPrivate() const;

        static PropertyTmpl null;

        bool isNull() const;

        typedef QMap<QString, PropertyTmpl>  Map;

    private:
        class Private;
        Private *d;
};

Q_DECLARE_OPERATORS_FOR_FLAGS(PropertyTmpl::PropertyOptions)

class KOPETE_EXPORT Property
{
    public:
        Property();

        Property(const PropertyTmpl &tmpl, const QVariant &value);

        Property(const Property &other);

        ~Property();

        Property &operator=(const Property &other);

        const PropertyTmpl &tmpl() const;

        const QVariant &value() const;

        static Property null;

        bool isNull() const;

        bool isRichText() const;

        typedef QMap<QString, Property> Map;

    private:
        class Private;
        Private * const d;
};

} // END namespace Kopete

#endif //_KOPETEPROPERTY_H_