canvas.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2013-08-04
 * Description : image editor canvas management class
 *
 * Copyright (C) 2013-2014 by Yiou Wang <geow812 at gmail dot com>
 * 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_EDITOR_CANVAS_H
#define DIGIKAM_IMAGE_EDITOR_CANVAS_H
 
// Qt includes
 
#include <QRect>
#include <QWheelEvent>
#include <QMouseEvent>
#include <QKeyEvent>
 
// Local includes
 
#include "digikam_export.h"
#include "dimg.h"
#include "graphicsdimgview.h"
#include "editorcore.h"
 
class QWheelEvent;
class QKeyEvent;
 
namespace Digikam
{
 
class EditorCore;
class ExposureSettingsContainer;
class ICCSettingsContainer;
class IccTransform;
class IOFileSettings;
 
class DIGIKAM_EXPORT Canvas : public GraphicsDImgView
{
    Q_OBJECT
 
public:
 
    explicit Canvas(QWidget* const parent = nullptr);
    ~Canvas() override;
 
    void load(const QString& filename, IOFileSettings* const IOFileSettings);
    void preload(const QString& filename);
 
    void resetImage();
    void abortSaving();
    void setModified();
    void makeDefaultEditingCanvas();
 
    QString     ensureHasCurrentUuid()   const;
 
    EditorCore* interface()              const;
 
    DImg        currentImage()           const;
 
    QString     currentImageFileFormat() const;
 
    QString     currentImageFilePath()   const;
 
    int         imageWidth()             const;
 
    int         imageHeight()            const;
 
    QRect       getSelectedArea()        const;
 
    bool        isReadOnly()             const;
 
    void setICCSettings(const ICCSettingsContainer& cmSettings);
 
    void applyTransform(const IccTransform& transform);
 
    void setExposureSettings(ExposureSettingsContainer* const expoSettings);
 
    void setSoftProofingEnabled(bool enable);
 
    void setExifOrient(bool exifOrient);
 
    bool exifRotated() const;
 
    void fitToSelect();
 
Q_SIGNALS:
 
    void signalChanged();
    void signalSelected(bool);
    void signalRightButtonClicked();
    void signalShowNextImage();
    void signalShowPrevImage();
    void signalPrepareToLoad();
    void signalLoadingStarted(const QString& filename);
    void signalLoadingFinished(const QString& filename, bool success);
    void signalLoadingProgress(const QString& filePath, float progress);
    void signalSavingStarted(const QString& filename);
    void signalSavingFinished(const QString& filename, bool success);
    void signalSavingProgress(const QString& filePath, float progress);
    void signalSelectionChanged(const QRect&);
    void signalSelectionSetText(const QRect&);
    void signalToggleOffFitToWindow();
    void signalUndoSteps(int);
    void signalRedoSteps(int);
    void signalZoomChanged(double);
    void signalAddedDropedItems(QDropEvent*);
 
public Q_SLOTS:
 
    void slotRotate90();
    void slotRotate180();
    void slotRotate270();
    void slotFlipHoriz();
    void slotFlipVert();
    void slotCrop();
 
    void slotRestore();
    void slotUndo(int steps = 1);
    void slotRedo(int steps = 1);
 
    void slotCopy();
 
    void slotSelectAll();
    void slotSelectNone();
    void slotSelected();
    void slotSelectionMoved();
 
protected:
 
    void keyPressEvent(QKeyEvent*) override;
    void mousePressEvent(QMouseEvent*) override;
    void addRubber();
 
    void dragMoveEvent(QDragMoveEvent*) override;
    void dragEnterEvent(QDragEnterEvent*) override;
    void dropEvent(QDropEvent*) override;
 
private:
 
    QRect calcSelectedArea() const;
    void  reset();
 
private Q_SLOTS:
 
    void slotModified();
    void slotImageLoaded(const QString& filePath, bool success);
    void slotImageSaved(const QString& filePath, bool success);
    void slotAddItemStarted(const QPointF& pos);
    void slotAddItemMoving(const QRectF& rect);
    void slotAddItemFinished(const QRectF& rect);
    void cancelAddItem();
 
private:
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_IMAGE_EDITOR_CANVAS_H