kde-playground/kdepimlibs/kabc/picture.h

/*
    This file is part of libkabc.
    Copyright (c) 2002 Tobias Koenig <tokoe@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 KABC_PICTURE_H
#define KABC_PICTURE_H

#include "kabc_export.h"

#include <QtCore/QDataStream>
#include <QtCore/QString>
#include <QtCore/QSharedDataPointer>
#include <QImage>

namespace KABC {

class PicturePrivate;

/**
  A class to store a picture of an addressee. It can store the data directly or
  an url reference to a picture.
*/
class KABC_EXPORT Picture
{
    friend KABC_EXPORT QDataStream &operator<<( QDataStream &, const Picture & );
    friend KABC_EXPORT QDataStream &operator>>( QDataStream &, Picture & );

  public:
    /**
     * Creates an empty picture.
     */
    Picture();

    /**
     * Creates a picture which points to the given url.
     *
     * @param url A URL that describes the location of the picture file.
     */
    Picture( const QString &url );

    /**
     * Creates a picture with the given data.
     *
     * @param data The raw data of the picture.
     */
    Picture( const QImage &data );

    /**
     * Copy constructor.
     *
     * Fast operation, Picture's data is implicitly shared.
     *
     * @param picture The Picture instance to copy from
     */
    Picture( const Picture &picture );

    /**
     * Destructor.
     */
    ~Picture();

    /**
     * Assignment operator
     *
     * Fast operation, Picture's data is implicitly shared.
     *
     * @param other The Picture instance to assign to @c this
     */
    Picture &operator=( const Picture &other );

    /**
     * Equality operator.
     */
    bool operator==( const Picture & ) const;

    /**
     * Not-Equal operator.
     */
    bool operator!=( const Picture & ) const;

    /**
     * Returns true, if the picture is empty.
     */
    bool isEmpty() const;

    /**
     * Sets a URL for the location of the picture file. When using this
     * function, isIntern() will return 'false' until you use
     * setData().
     * This also clears the type, as it is unknown.
     *
     * @param url  The location URL of the picture file.
     */
    void setUrl( const QString &url );

    /**
     * Sets a URL for the location of the picture file. When using this
     * function, isIntern() will return 'false' until you use
     * setData().
     *
     * @param url  The location URL of the picture file.
     * @param type  The encoding format of the image, e.g. jpeg or png
     * @since 4.10
     */
    void setUrl( const QString &url, const QString &type );

    /**
     * Sets the image data of the picture. When using this function,
     * isIntern() will return 'true' until you use setUrl().
     * This also sets type to "png" or "jpeg" depending
     * on whether the image has an alpha channel or not.
     *
     * @param data  The image data of the picture.
     */
    void setData( const QImage &data );

    /**
     * Sets the raw data of the picture. When using this function,
     * isIntern() will return 'true' until you use setUrl().
     *
     * @param rawData  The raw data of the picture.
     * @param type  The encoding format of the image, e.g. jpeg or png
     * @since 4.10
     */
    void setRawData( const QByteArray &rawData, const QString &type );

    /**
     * Sets the type of the picture.
     * @param type the picture's data type
     * @deprecated type should only be set along with setRawData()
     */
    void KABC_DEPRECATED setType( const QString &type );

    /**
     * Returns whether the picture is described by a URL (extern) or
     * by the raw data (intern).
     * When this method returns 'true' you can use data() to
     * get the raw data. Otherwise you can request the URL of this
     * picture by url() and load the raw data from that location.
     */
    bool isIntern() const;

    /**
     * Returns the location URL of this picture.
     */
    QString url() const;

    /**
     * Returns the image data of this picture.
     */
    QImage data() const;

    /**
     * Returns the raw data of this picture.
     *
     * @since 4.10
     */
    QByteArray rawData() const;

    /**
     * Returns the type of this picture.
     */
    QString type() const;

    /**
     * Returns string representation of the picture.
     */
    QString toString() const;

  private:
    QSharedDataPointer<PicturePrivate> d;
};

/**
 * Serializes the @p picture object into the @p stream.
 */
KABC_EXPORT QDataStream &operator<<( QDataStream &stream, const Picture &picture );

/**
 * Initializes the @p picture object from the @p stream.
 */
KABC_EXPORT QDataStream &operator>>( QDataStream &stream, Picture &picture );

}

#endif