ImageSizeCheck Class Reference

#include <CheckImageSize.h>

Inheritance diagram for ImageSizeCheck:

Public Member Functions
Level	check (KisImageSP) const
Level	check (KisImageSP) const override
bool	checkNeeded (KisImageSP image) const
bool	checkNeeded (KisImageSP image) const override
	ImageSizeCheck (int maxWidth, int maxHeight, const QString &id, Level level, const QString &customWarning=QString())
	ImageSizeCheck (int maxWidth, int maxHeight, const QString &id, Level level, const QString &customWarning=QString())
Public Member Functions inherited from KisExportCheckBase
virtual QString	id () const
	KisExportCheckBase (const QString &id, Level level, const QString &customWarning=QString(), bool perLayerCheck=false)
	KisExportCheckBase.
virtual bool	perLayerCheck () const
QString	warning () const
virtual	~KisExportCheckBase ()

Public Attributes
int	m_maxH
int	m_maxW

Additional Inherited Members
Public Types inherited from KisExportCheckBase
enum	Level { SUPPORTED , PARTIALLY , UNSUPPORTED }
Protected Attributes inherited from KisExportCheckBase
QString	m_id
Level	m_level {UNSUPPORTED}
bool	m_perLayerCheck {false}
QString	m_warning

Detailed Description

Definition at line 17 of file CheckImageSize.h.

Constructor & Destructor Documentation

ImageSizeCheck() [1/2]

ImageSizeCheck::ImageSizeCheck ( int maxWidth, int maxHeight, const QString & id, Level level, const QString & customWarning = QString() )

inline

Definition at line 21 of file CheckImageSize.h.

        : KisExportCheckBase(id, level, customWarning, true)
        , m_maxW(maxWidth)
        , m_maxH(maxHeight)
    {
        if (customWarning.isEmpty()) {
            m_warning = i18nc("image conversion warning", "This image is larger than <b>%1 x %2</b>. Images this size cannot be saved to this format.", m_maxW, m_maxH);
        }
    }

References m_maxH, m_maxW, and KisExportCheckBase::m_warning.

ImageSizeCheck() [2/2]

ImageSizeCheck::ImageSizeCheck ( int maxWidth, int maxHeight, const QString & id, Level level, const QString & customWarning = QString() )

inline

Definition at line 20 of file ImageSizeCheck.h.

        : KisExportCheckBase(id, level, customWarning, true)
        , m_maxW(maxWidth)
        , m_maxH(maxHeight)
    {
        if (customWarning.isEmpty()) {
            m_warning = i18nc("image conversion warning", "This image is larger than <b>%1 x %2</b>. Images this size cannot be saved to this format.", m_maxW, m_maxH);
        }
    }

Member Function Documentation

check() [1/2]

Level ImageSizeCheck::check ( KisImageSP image ) const

inlinevirtual

Returns

the level of support for this feature

Implements KisExportCheckBase.

Definition at line 36 of file CheckImageSize.h.

    {
        return m_level;
    }

References KisExportCheckBase::m_level.

check() [2/2]

Level ImageSizeCheck::check ( KisImageSP image ) const

inlineoverridevirtual

Returns

the level of support for this feature

Implements KisExportCheckBase.

Definition at line 35 of file ImageSizeCheck.h.

    {
        return m_level;
    }

References KisExportCheckBase::m_level.

checkNeeded() [1/2]

bool ImageSizeCheck::checkNeeded ( KisImageSP image ) const

inlinevirtual

Returns

whether the image uses this feature

Implements KisExportCheckBase.

Definition at line 31 of file CheckImageSize.h.

    {
        return image->width() <= m_maxW && image->height() <= m_maxH;
    }

References KisImage::height(), m_maxH, m_maxW, and KisImage::width().

checkNeeded() [2/2]

bool ImageSizeCheck::checkNeeded ( KisImageSP image ) const

inlineoverridevirtual

Returns

whether the image uses this feature

Implements KisExportCheckBase.

Definition at line 30 of file ImageSizeCheck.h.

    {
        return image->width() >= m_maxW && image->height() >= m_maxH;
    }

References KisImage::height(), and KisImage::width().

Member Data Documentation

m_maxH

int ImageSizeCheck::m_maxH

Definition at line 42 of file CheckImageSize.h.

m_maxW

int ImageSizeCheck::m_maxW

Definition at line 41 of file CheckImageSize.h.

---

The documentation for this class was generated from the following files:

• libs/impex/CheckImageSize.h
• libs/impex/ImageSizeCheck.h