imageiface.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2004-02-14
 * Description : image data interface for image tools
 *
 * Copyright (C) 2004-2005 by Renchi Raju <renchi dot raju at gmail dot com>
 * Copyright (C) 2004-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 *
 * This program is free software; you can redistribute it
 * and/or modify it under the terms of the GNU General
 * Public License as published by the Free Software Foundation;
 * either version 2, or (at your option)
 * any later version.
 *
 * This program 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 General Public License for more details.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_IMAGE_IFACE_H
#define DIGIKAM_IMAGE_IFACE_H
 
// Qt includes
 
#include <QString>
#include <QPixmap>
 
// Local includes
 
#include "dimg.h"
#include "dcolor.h"
#include "filteraction.h"
#include "photoinfocontainer.h"
#include "digikam_export.h"
 
class QPaintDevice;
 
namespace Digikam
{
 
class DIGIKAM_EXPORT ImageIface
{
 
public:
 
    enum PreviewType
    {
        FullImage,      
        ImageSelection  
    };
 
public:
 
    explicit ImageIface(const QSize& size = QSize(0, 0));
    ~ImageIface();
 
    void setPreviewType(PreviewType type = FullImage);
 
    DImg  setPreviewSize(const QSize& size)                 const;
 
    QSize       previewSize()                               const;
    bool        previewHasAlpha()                           const;
    bool        previewSixteenBit()                         const;
    PreviewType previewType()                               const;
 
    DImg* previewReference();
 
    DImg  preview()                                         const;
 
    QRect selectionRect()                                   const;
 
    DImg  selection()                                       const;
 
    void crop(const QRect& region);
 
    DColor colorInfoFromOriginal(const QPoint& point)       const;
    DColor colorInfoFromPreview(const QPoint& point)        const;
    DColor colorInfoFromTargetPreview(const QPoint& point)  const;
 
    QSize originalSize()                                    const;
    bool  originalHasAlpha()                                const;
    bool  originalSixteenBit()                              const;
 
    IccProfile         originalIccProfile()                 const;
    PhotoInfoContainer originalPhotoInfo()                  const;
    MetaEngineData     originalMetadata()                   const;
    void               setOriginalMetadata(const MetaEngineData& meta);
 
    DImg* original()                                        const;
 
    void convertOriginalColorDepth(int depth);
 
    QPixmap convertToPixmap(const DImg& img)                const;
 
    void paint(QPaintDevice* const device, const QRect& rect, QPainter* const painter = nullptr);
 
    void setOriginalIccProfile(const IccProfile& profile);
 
    void setPreviewIccProfile(const IccProfile& profile);
 
    void setSelection(const QString& caller, const FilterAction& action, const DImg& img);
 
    void setPreview(const DImg& img);
 
    void setOriginal(const QString& caller, const FilterAction& action, const DImg& img);
 
private:
 
    // Disable
    ImageIface(const ImageIface&)            = delete;
    ImageIface& operator=(const ImageIface&) = delete;
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_IMAGE_IFACE_H