key.h

/*
    This file is part of the KContacts framework.
    Copyright (c) 2002 Tobias Koenig <[email protected]>

    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 KCONTACTS_KEY_H
#define KCONTACTS_KEY_H

#include "kcontacts_export.h"

#include <QDataStream>
#include <QSharedDataPointer>

namespace KContacts {
class KCONTACTS_EXPORT Key
{
    friend KCONTACTS_EXPORT QDataStream &operator<<(QDataStream &, const Key &);
    friend KCONTACTS_EXPORT QDataStream &operator>>(QDataStream &, Key &);

public:
    typedef QVector<Key> List;

    enum Type {
        X509,   
        PGP,    
        Custom  
    };

    typedef QList<Type> TypeList;

    explicit Key(const QString &text = QString(), Type type = PGP);

    Key(const Key &other);

    ~Key();

    Q_REQUIRED_RESULT bool operator==(const Key &other) const;

    Q_REQUIRED_RESULT bool operator!=(const Key &other) const;

    Key &operator=(const Key &other);

    void setId(const QString &identifier);

    Q_REQUIRED_RESULT QString id() const;

    void setBinaryData(const QByteArray &data);

    Q_REQUIRED_RESULT QByteArray binaryData() const;

    void setTextData(const QString &data);

    Q_REQUIRED_RESULT QString textData() const;

    Q_REQUIRED_RESULT bool isBinary() const;

    void setType(Type type);

    void setCustomTypeString(const QString &type);

    Q_REQUIRED_RESULT Type type() const;

    Q_REQUIRED_RESULT QString customTypeString() const;

    Q_REQUIRED_RESULT QString toString() const;

    Q_REQUIRED_RESULT static TypeList typeList();

    Q_REQUIRED_RESULT static QString typeLabel(Type type);

private:
    class Private;
    QSharedDataPointer<Private> d;
};

KCONTACTS_EXPORT QDataStream &operator<<(QDataStream &stream, const Key &key);

KCONTACTS_EXPORT QDataStream &operator>>(QDataStream &stream, Key &key);
}
Q_DECLARE_TYPEINFO(KContacts::Key, Q_MOVABLE_TYPE);
#endif