attachment.h

Go to the documentation of this file.

/*
  This file is part of the kcalcore library.

  Copyright (c) 2002 Michael Brade <brade@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_ATTACHMENT_H
#define KCALCORE_ATTACHMENT_H

#include "kcalcore_export.h"

#include <QtCore/QHash>
#include <QtCore/QString>
#include <QtCore/QSharedPointer>
#include <QMetaType>

namespace KCalCore {

class KCALCORE_EXPORT Attachment
{
public:
    typedef QSharedPointer<Attachment> Ptr;

    typedef QVector<Ptr> List;

    explicit Attachment(const QString &uri, const QString &mime = QString());

    explicit Attachment(const QByteArray &base64,
                        const QString &mime = QString());

    Attachment(const Attachment &attachment);

    ~Attachment();

    void setUri(const QString &uri);

    QString uri() const;

    bool isUri() const;

    bool isBinary() const;

    void setData(const QByteArray &base64);

    QByteArray data() const;

    void setDecodedData(const QByteArray &data);

    QByteArray decodedData() const;

    uint size() const;

    void setMimeType(const QString &mime);

    QString mimeType() const;

    void setShowInline(bool showinline);

    bool showInline() const;

    void setLabel(const QString &label);

    QString label() const;

    void setLocal(bool local);

    bool isLocal() const;

    Attachment &operator=(const Attachment &attachment);

    bool operator==(const Attachment &attachment) const;

    bool operator!=(const Attachment &attachment) const;

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

    friend KCALCORE_EXPORT QDataStream &operator<<(QDataStream &s, const KCalCore::Attachment::Ptr &);
    friend KCALCORE_EXPORT QDataStream &operator>>(QDataStream &s, const KCalCore::Attachment::Ptr &);
};

KCALCORE_EXPORT QDataStream &operator<<(QDataStream &out, const KCalCore::Attachment::Ptr &);

KCALCORE_EXPORT QDataStream &operator>>(QDataStream &in, const KCalCore::Attachment::Ptr &);

}

//@cond PRIVATE
Q_DECLARE_TYPEINFO(KCalCore::Attachment::Ptr, Q_MOVABLE_TYPE);
Q_DECLARE_METATYPE(KCalCore::Attachment::Ptr)
//@endcond

//@cond PRIVATE
inline uint qHash(const QSharedPointer<KCalCore::Attachment> &key)
{
    return qHash<KCalCore::Attachment>(key.data());
}
//@endcond

#endif