KisExportCheckBase Class Reference

The KisExportCheckBase class defines the interface of the individual checks of an export filter's capabilities. More...

#include <KisExportCheckBase.h>

Inheritance diagram for KisExportCheckBase:

Public Types
enum	Level { SUPPORTED , PARTIALLY , UNSUPPORTED }

Public Member Functions
virtual Level	check (KisImageSP image) const =0
virtual bool	checkNeeded (KisImageSP image) const =0
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 ()

Protected Attributes
QString	m_id
Level	m_level {UNSUPPORTED}
bool	m_perLayerCheck {false}
QString	m_warning

Detailed Description

The KisExportCheckBase class defines the interface of the individual checks of an export filter's capabilities.

Definition at line 19 of file KisExportCheckBase.h.

Member Enumeration Documentation

Level

enum KisExportCheckBase::Level

The level determines the level of support the export filter has for the given feature.

Enumerator
SUPPORTED
PARTIALLY
UNSUPPORTED

Definition at line 25 of file KisExportCheckBase.h.

               {
        SUPPORTED,  //< The filter fully supports this
        PARTIALLY,  //< The filter can handle this, but the user needs to be warned about possible degradation
        UNSUPPORTED //< This cannot be saved using this filter
    };

Constructor & Destructor Documentation

KisExportCheckBase()

KisExportCheckBase::KisExportCheckBase	(	const QString &	id,
		Level	level,
		const QString &	customWarning = QString(),
		bool	perLayerCheck = false )

KisExportCheckBase.

Parameters

level	the level of support the filter has for the given feature
customWarning	A custom warning to use instead of the default one

Definition at line 9 of file KisExportCheckBase.cpp.

    : m_id(id)
    , m_level(level)
    , m_perLayerCheck(_perLayerCheck)
{
    if (!customWarning.isEmpty()) {
        m_warning = customWarning;
    }
}

References m_warning.

~KisExportCheckBase()

KisExportCheckBase::~KisExportCheckBase ( )

virtual

Definition at line 19 of file KisExportCheckBase.cpp.

{
}

Member Function Documentation

check()

virtual Level KisExportCheckBase::check ( KisImageSP image ) const

pure virtual

Returns

the level of support for this feature

Implemented in ImageSizeCheck, AnimationCheck, ColorModelCheck, ColorModelHomogenousCheck, ColorModelPerLayerCheck, CompositionsCheck, ExifCheck, TiffExifCheck, FillLayerTypeCheck, ImageSizeCheck, IntegralFrameDurationCheck, LayerOpacityCheck, MultiLayerCheck, MultiTransparencyMaskCheck, NodeTypeCheck, PSDLayerStyleCheck, ShapeLayerTypeCheck, and sRGBProfileCheck.

checkNeeded()

virtual bool KisExportCheckBase::checkNeeded ( KisImageSP image ) const

pure virtual

Returns

whether the image uses this feature

Implemented in ImageSizeCheck, AnimationCheck, ColorModelCheck, ColorModelHomogenousCheck, ColorModelPerLayerCheck, CompositionsCheck, ExifCheck, TiffExifCheck, FillLayerTypeCheck, ImageSizeCheck, IntegralFrameDurationCheck, LayerOpacityCheck, MultiLayerCheck, MultiTransparencyMaskCheck, NodeTypeCheck, PSDLayerStyleCheck, ShapeLayerTypeCheck, and sRGBProfileCheck.

id()

QString KisExportCheckBase::id ( ) const

virtual

Returns

the unique id of the check

Definition at line 23 of file KisExportCheckBase.cpp.

{
    return m_id;
}

References m_id.

perLayerCheck()

bool KisExportCheckBase::perLayerCheck ( ) const

virtual

Returns

true if this check is only relevant for file formats that can save multiple layers

Definition at line 28 of file KisExportCheckBase.cpp.

{
    return m_perLayerCheck;
}

References m_perLayerCheck.

warning()

QString KisExportCheckBase::warning

(

)

const

Returns

the message to show the user

Definition at line 33 of file KisExportCheckBase.cpp.

{
    return m_warning;
}

References m_warning.

Member Data Documentation

m_id

QString KisExportCheckBase::m_id

protected

Definition at line 57 of file KisExportCheckBase.h.

m_level

Level KisExportCheckBase::m_level {UNSUPPORTED}

protected

Definition at line 58 of file KisExportCheckBase.h.

{UNSUPPORTED};

m_perLayerCheck

bool KisExportCheckBase::m_perLayerCheck {false}

protected

Definition at line 60 of file KisExportCheckBase.h.

{false};

m_warning

QString KisExportCheckBase::m_warning

protected

Definition at line 59 of file KisExportCheckBase.h.

---

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

• libs/impex/KisExportCheckBase.h
• libs/impex/KisExportCheckBase.cpp