imagezoomsettings.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2010-04-30
 * Description : Image zoom settings
 *
 * Copyright (C) 2010-2011 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 *
 * 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_ZOOM_SETTINGS_H
#define DIGIKAM_IMAGE_ZOOM_SETTINGS_H
 
// Qt includes
 
#include <QSizeF>
#include <QRectF>
#include <QPointF>
 
// Local includes
 
#include "digikam_export.h"
 
namespace Digikam
{
 
class DIGIKAM_EXPORT ImageZoomSettings
{
 
public:
 
    enum FitToSizeMode
    {
        AlwaysFit,
        OnlyScaleDown
    };
 
public:
 
    ImageZoomSettings();
    explicit ImageZoomSettings(const QSize& imageSize, const QSize& originalSize = QSize());
 
    void setImageSize(const QSize& size, const QSize& originalSize = QSize());
 
    double zoomFactor()                                                             const;
 
    double realZoomFactor()                                                         const;
 
    QSizeF imageSize()                                                              const;
 
    QSizeF originalImageSize()                                                      const;
 
    QSizeF zoomedSize()                                                             const;
 
    bool isFitToSize(const QSizeF& frameSize)                                       const;
 
    void setZoomFactor(double zoom);
 
    void fitToSize(const QSizeF& frameSize, FitToSizeMode = AlwaysFit);
 
    QRectF sourceRect(const QRectF& imageRect)                                      const;
 
    QRectF mapZoomToImage(const QRectF& imageRect)                                  const;
 
    QRectF mapImageToZoom(const QRectF& imagePoint)                                 const;
 
    QPointF mapZoomToImage(const QPointF& zoomedPoint)                              const;
 
    QPointF mapImageToZoom(const QPointF& imagePoint)                               const;
 
    double fitToSizeZoomFactor(const QSizeF& frameSize, FitToSizeMode = AlwaysFit)  const;
 
    double snappedZoomStep(double nextZoom, const QSizeF& frameSize)                const;
 
    double snappedZoomFactor(double newZoom, const QSizeF& frameSize)               const;
 
protected:
 
    QSizeF m_size;
    double m_zoom;
    double m_zoomConst;
    double m_zoomRatio;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_IMAGE_ZOOM_SETTINGS_H