File indexing completed on 2025-01-19 03:55:43

 /* ============================================================
  *
  * This file is a part of digiKam project
  * https://www.digikam.org
  *
  * Date        : 2009-12-13
  * Description : a widget to preview image effect.
  *
  * SPDX-FileCopyrightText: 2009-2024 by Gilles Caulier <caulier dot gilles at gmail dot com>
  * SPDX-FileCopyrightText: 2008      by Kare Sars <kare dot sars at iki dot fi>
  * SPDX-FileCopyrightText: 2012      by Benjamin Girault <benjamin dot girault at gmail dot com>
  *
  * SPDX-License-Identifier: GPL-2.0-or-later
  *
  * ============================================================ */
 
 #ifndef DIGIKAM_DPREVIEW_IMAGE_H
 #define DIGIKAM_DPREVIEW_IMAGE_H
 
 // Qt includes
 
 #include <QGraphicsView>
 #include <QGraphicsPixmapItem>
 #include <QString>
 #include <QColor>
 
 // Local includes
 
 #include "digikam_export.h"
 
 class QResizeEvent;
 class QWheelEvent;
 class QMouseEvent;
 class QEvent;
 
 namespace Digikam
 {
 
 class DIGIKAM_EXPORT DSelectionItem : public QGraphicsItem
 {
 public:
 
     typedef enum
     {
         None,
         Top,
         TopRight,
         Right,
         BottomRight,
         Bottom,
         BottomLeft,
         Left,
         TopLeft,
         Move
     } Intersects;
 
 public:
 
     explicit DSelectionItem(const QRectF& rect);
     ~DSelectionItem() override;
 
 public:
 
     void setMaxRight(qreal maxRight);
     void setMaxBottom(qreal maxBottom);
 
     Intersects intersects(QPointF& point);
 
     void saveZoom(qreal zoom);
 
     void    setRect(const QRectF& rect);
     QRectF  rect()                                      const;
     QPointF fixTranslation(QPointF dp)                  const;
 
 public:
 
     // Graphics Item methods
     QRectF boundingRect() const                               override;
     void paint(QPainter* painter,
                const QStyleOptionGraphicsItem* option,
                QWidget* widget)                               override;
 
 private:
 
     void updateAnchors();
 
 private:
 
     class Private;
     Private* const d;
 };
 
 // -----------------------------------------------------------------------------------------
 
 class DIGIKAM_EXPORT DPreviewImage : public QGraphicsView
 {
     Q_OBJECT
 
 public:
 
     explicit DPreviewImage(QWidget* const parent);
     ~DPreviewImage() override;
 
 public:
 
     bool load(const QUrl& file)         const;
     bool setImage(const QImage& img)    const;
     void enableSelectionArea(bool b);
 
     /**
      * Sets a selection area and show it
      *
      * @param rectangle This rectangle should have height and width of 1.0
      */
     void   setSelectionArea(const QRectF& rectangle);
     QRectF getSelectionArea()           const;
 
 public Q_SLOTS:
 
     void slotZoomIn();
     void slotZoomOut();
 //  void slotZoomSel();      // TODO: add a button for that purpose
     void slotZoom2Fit();
 
     ///@{
     /// Selection area specific slots (TL = TopLeft, BR = BottomRight)
     void slotSetTLX(float ratio);
     void slotSetTLY(float ratio);
     void slotSetBRX(float ratio);
     void slotSetBRY(float ratio);
     ///@}
 
     /**
      * This function is used to set a selection without the user setting it.
      * \note all parameters must be in the range 0.0 -> 1.0.
      * \param tl_x is the x coordinate of the top left corner 0=0 1=image with.
      * \param tl_y is the y coordinate of the top left corner 0=0 1=image height.
      * \param br_x is the x coordinate of the bottom right corner 0=0 1=image with.
      * \param br_y is the y coordinate of the bottom right corner 0=0 1=image height.
      */
     void slotSetSelection(float tl_x, float tl_y, float br_x, float br_y);
     void slotClearActiveSelection();
 
     /**
      * This function is used to darken everything except what is inside the given area.
      * \note all parameters must be in the range 0.0 -> 1.0.
      * \param tl_x is the x coordinate of the top left corner 0=0 1=image with.
      * \param tl_y is the y coordinate of the top left corner 0=0 1=image height.
      * \param br_x is the x coordinate of the bottom right corner 0=0 1=image with.
      * \param br_y is the y coordinate of the bottom right corner 0=0 1=image height.
      */
     void slotSetHighlightArea(float tl_x, float tl_y, float br_x, float br_y);
 
     /**
      * This function sets the percentage of the highlighted area that is visible.
      * The rest is hidden. This stacks with the previous highlight area.
      * \param percentage is the percentage of the highlighted area that is shown.
      * \param hideColor is the color to use to hide the highlighted area of the image.
      */
     void slotSetHighlightShown(int percentage, const QColor& highLightColor = Qt::white);
 
     /**
      * This function removes the highlight area.
      */
     void slotClearHighlight();
 
 protected:
 
     void wheelEvent(QWheelEvent*)           override;
     void mousePressEvent(QMouseEvent*)      override;
     void mouseReleaseEvent(QMouseEvent*)    override;
     void mouseMoveEvent(QMouseEvent*)       override;
     void leaveEvent(QEvent*)                override;
     bool eventFilter(QObject*, QEvent*)     override;
     void resizeEvent(QResizeEvent*)         override;
 
 #if (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0))
 
     void enterEvent(QEnterEvent*)          override;
 
 #else
 
     void enterEvent(QEvent*)               override;
 
 #endif
 
     void updateSelVisibility();
     void updateHighlight();
 
 private:
 
     class Private;
     Private* const d;
 };
 
 } // namespace Digikam
 
 #endif // DIGIKAM_DPREVIEW_IMAGE_H