The base class for import and export filters. More...

#include <KisImportExportFilter.h>

Inheritance diagram for KisImportExportFilter:

Public Member Functions
virtual KisImportExportErrorCode	convert (KisDocument document, QIODevice io, KisPropertiesConfigurationSP configuration=0)=0

virtual KisConfigWidget *	createConfigurationWidget (QWidget *parent, const QByteArray &from="", const QByteArray &to="") const
	createConfigurationWidget creates a widget that can be used to define the settings for a given import/export filter

virtual KisPropertiesConfigurationSP	defaultConfiguration (const QByteArray &from="", const QByteArray &to="") const
	defaultConfiguration defines the default settings for the given import export filter

virtual QMap< QString, KisExportCheckBase * >	exportChecks ()
	generate and return the list of capabilities of this export filter. The list

virtual bool	exportSupportsGuides () const
	exportSupportsGuides Because guides are in the document and not the image, checking for guides cannot be made an exportCheck.

KisPropertiesConfigurationSP	lastSavedConfiguration (const QByteArray &from="", const QByteArray &to="") const
	lastSavedConfiguration return the last saved configuration for this filter

	Private ()

void	setBatchMode (bool batchmode)

void	setFilename (const QString &filename)

void	setImportUserFeedBackInterface (KisImportUserFeedbackInterface *interface)

void	setMimeType (const QString &mime)

void	setRealFilename (const QString &filename)

void	setUpdater (QPointer< KoUpdater > updater)

virtual bool	supportsIO () const
	Override and return false for the filters that use a library that cannot handle file handles, only file names.

QPointer< KoUpdater >	updater ()

virtual QString	verify (const QString &fileName) const
	Verify whether the given file is correct and readable.

	~KisImportExportFilter () override

	~Private ()

Public Attributes
bool	batchmode

QMap< QString, KisExportCheckBase * >	capabilities

QString	filename

KisImportUserFeedbackInterface *	importUserFeedBackInterface {nullptr}

QByteArray	mime

QString	realFilename

QPointer< KoUpdater >	updater

Static Public Attributes
static const QString	CICPPrimariesTag = "CICPCompatiblePrimaries"

static const QString	CICPTransferCharacteristicsTag = "CICPCompatibleTransferFunction"

static const QString	ColorDepthIDTag = "ColorDepthID"

static const QString	ColorModelIDTag = "ColorModelID"

static const QString	HDRTag = "HDRSupported"

static const QString	ImageContainsTransparencyTag = "ImageContainsTransparency"

static const QString	sRGBTag = "sRGB"

Protected Member Functions
void	addCapability (KisExportCheckBase *capability)

void	addSupportedColorModels (QList< QPair< KoID, KoID > > supportedColorModels, const QString &name, KisExportCheckBase::Level level=KisExportCheckBase::PARTIALLY)

bool	batchMode () const

QString	filename () const

KisImportUserFeedbackInterface *	importUserFeedBackInterface () const

virtual void	initializeCapabilities ()

	KisImportExportFilter (QObject *parent=0)

QByteArray	mimeType () const

QString	realFilename () const

void	setProgress (int value)

QString	verifyZiPBasedFiles (const QString &fileName, const QStringList &filesToCheck) const

Private Member Functions
	KisImportExportFilter (const KisImportExportFilter &rhs)

KisImportExportFilter &	operator= (const KisImportExportFilter &rhs)

Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Private Attributes
Private *const	d

Private Attributes inherited from Private
KisCanvas2 *	canvas

int	displayedFrame

int	intendedFrame

Detailed Description

The base class for import and export filters.

Derive your filter class from this base class and implement the convert() method. Don't forget to specify the Q_OBJECT macro in your class even if you don't use signals or slots. This is needed as filters are created on the fly.

Note: Take care: The m_chain pointer is invalid while the constructor runs due to the implementation – don't use it in the constructor. After the constructor, when running the convert() method it's guaranteed to be valid, so no need to check against 0.; If the code is compiled in debug mode, setting CALLIGRA_DEBUG_FILTERS environment variable to any value disables deletion of temporary files while importing/exporting. This is useful for testing purposes.

Author: Werner Trobin trobi.nosp@m.n@kd.nosp@m.e.org

Todo: the class has no constructor and therefore cannot initialize its private class

Definition at line 35 of file KisImportExportFilter.cpp.

Constructor & Destructor Documentation

◆ ~Private()

KisImportExportFilter::~Private ( )

inline

Definition at line 52 of file KisImportExportFilter.cpp.

    {
        qDeleteAll(capabilities);
    }

◆ ~KisImportExportFilter()

KisImportExportFilter::~KisImportExportFilter ( )

override

Definition at line 66 of file KisImportExportFilter.cpp.

{
    if (d->updater) {
        d->updater->setProgress(100);
    }
    delete d;
}

References d.

◆ KisImportExportFilter() [1/2]

KisImportExportFilter::KisImportExportFilter ( QObject * parent = 0 )

protected

This is the constructor your filter has to call, obviously.

Definition at line 60 of file KisImportExportFilter.cpp.

    : QObject(parent)
    , d(new Private)
{
}

◆ KisImportExportFilter() [2/2]

KisImportExportFilter::KisImportExportFilter ( const KisImportExportFilter & rhs )

private

Member Function Documentation

◆ addCapability()

void KisImportExportFilter::addCapability ( KisExportCheckBase * capability )

protected

Definition at line 217 of file KisImportExportFilter.cpp.

{
    d->capabilities[capability->id()] = capability;
}

References d, and KisExportCheckBase::id().

◆ addSupportedColorModels()

void KisImportExportFilter::addSupportedColorModels	(	QList< QPair< KoID, KoID > >	supportedColorModels,
		const QString &	name,
		KisExportCheckBase::Level	level = KisExportCheckBase::PARTIALLY )

protected

Definition at line 224 of file KisImportExportFilter.cpp.

{
    Q_ASSERT(level != KisExportCheckBase::SUPPORTED);
    QString layerMessage;
    QString imageMessage;
    QList<KoID> allColorModels = KoColorSpaceRegistry::instance()->colorModelsList(KoColorSpaceRegistry::AllColorSpaces);
    Q_FOREACH(const KoID &colorModelID, allColorModels) {
        QList<KoID> allColorDepths = KoColorSpaceRegistry::instance()->colorDepthList(colorModelID.id(), KoColorSpaceRegistry::AllColorSpaces);
        Q_FOREACH(const KoID &colorDepthID, allColorDepths) {
 
            KisExportCheckFactory *colorModelCheckFactory =
                    KisExportCheckRegistry::instance()->get("ColorModelCheck/" + colorModelID.id() + "/" + colorDepthID.id());
            KisExportCheckFactory *colorModelPerLayerCheckFactory =
                    KisExportCheckRegistry::instance()->get("ColorModelPerLayerCheck/" + colorModelID.id() + "/" + colorDepthID.id());
 
            if(!colorModelCheckFactory || !colorModelPerLayerCheckFactory) {
                qWarning() << "No factory for" << colorModelID << colorDepthID;
                continue;
            }
 
            if (supportedColorModels.contains(QPair<KoID, KoID>(colorModelID, colorDepthID))) {
                addCapability(colorModelCheckFactory->create(KisExportCheckBase::SUPPORTED));
                addCapability(colorModelPerLayerCheckFactory->create(KisExportCheckBase::SUPPORTED));
            }
            else {
 
 
                if (level == KisExportCheckBase::PARTIALLY) {
                    imageMessage = i18nc("image conversion warning",
                                         "%1 cannot save images with color model <b>%2</b> and depth <b>%3</b>. The image will be converted."
                                         ,name, colorModelID.name(), colorDepthID.name());
 
                    layerMessage =
                            i18nc("image conversion warning",
                                  "%1 cannot save layers with color model <b>%2</b> and depth <b>%3</b>. The layers will be converted or skipped."
                                  ,name, colorModelID.name(), colorDepthID.name());
                }
                else {
                    imageMessage = i18nc("image conversion warning",
                                         "%1 cannot save images with color model <b>%2</b> and depth <b>%3</b>. The image will not be saved."
                                         ,name, colorModelID.name(), colorDepthID.name());
 
                    layerMessage =
                            i18nc("image conversion warning",
                                  "%1 cannot save layers with color model <b>%2</b> and depth <b>%3</b>. The layers will be skipped."
                                  , name, colorModelID.name(), colorDepthID.name());
                 }
 
 
 
                addCapability(colorModelCheckFactory->create(level, imageMessage));
                addCapability(colorModelPerLayerCheckFactory->create(level, layerMessage));
            }
        }
    }
}

References addCapability(), KoColorSpaceRegistry::AllColorSpaces, KoColorSpaceRegistry::colorDepthList(), KoColorSpaceRegistry::colorModelsList(), KisExportCheckFactory::create(), KoGenericRegistry< T >::get(), KoID::id(), KisExportCheckRegistry::instance(), KoColorSpaceRegistry::instance(), KoID::name(), KisExportCheckBase::PARTIALLY, and KisExportCheckBase::SUPPORTED.

◆ batchMode()

bool KisImportExportFilter::batchMode ( ) const

protected

Definition at line 84 of file KisImportExportFilter.cpp.

{
    return d->batchmode;
}

References d.

◆ convert()

virtual KisImportExportErrorCode KisImportExportFilter::convert	(	KisDocument *	document,
		QIODevice *	io,
		KisPropertiesConfigurationSP	configuration = 0 )

pure virtual

The filter chain calls this method to perform the actual conversion. The passed mimetypes should be a pair of those you specified in your .desktop file. You have to implement this method to make the filter work.

Returns: The error status, see the #ConversionStatus enum. KisImportExportFilter::OK means that everything is alright.

Implemented in JPEGXLExport, RGBEExport, KisSVGImport, KisBrushExport, KisBrushImport, KisCSVExport, KisCSVImport, EXRExport, exrImport, KisGIFExport, KisGIFImport, HeifExport, HeifImport, KisHeightMapExport, KisHeightMapImport, jp2Import, KisJPEGExport, KisJPEGImport, KraExport, KraImport, KrzExport, OraExport, OraImport, KisPNGExport, KisPNGImport, psdExport, psdImport, KisQImageIOExport, KisQImageIOImport, QMLExport, KisRawImport, KisSpriterExport, KisTGAExport, KisTGAImport, KisTIFFExport, KisWebPExport, KisWebPImport, KisXCFImport, JPEGXLImport, KisPDFImport, RGBEImport, and KisTIFFImport.

◆ createConfigurationWidget()

KisConfigWidget * KisImportExportFilter::createConfigurationWidget	(	QWidget *	parent,
		const QByteArray &	from = "",
		const QByteArray &	to = "" ) const

virtual

createConfigurationWidget creates a widget that can be used to define the settings for a given import/export filter

Parameters

parent	the owner of the widget; the caller is responsible for deleting
from	The mimetype of the source file/document
to	The mimetype of the destination file/document

Returns: the widget

Reimplemented in KisQImageIOExport, KisBrushExport, EXRExport, HeifExport, KisHeightMapExport, KisJPEGExport, JPEGXLExport, KisPNGExport, RGBEExport, KisTIFFExport, and KisWebPExport.

Definition at line 142 of file KisImportExportFilter.cpp.

{
    Q_UNUSED(from);
    Q_UNUSED(to);
    return 0;
}

◆ defaultConfiguration()

KisPropertiesConfigurationSP KisImportExportFilter::defaultConfiguration	(	const QByteArray &	from = "",
		const QByteArray &	to = "" ) const

virtual

defaultConfiguration defines the default settings for the given import export filter

Parameters

from	The mimetype of the source file/document
to	The mimetype of the destination file/document

Returns: a serializable KisPropertiesConfiguration object

Reimplemented in KisQImageIOExport, KisWebPExport, KisBrushExport, EXRExport, HeifExport, KisHeightMapExport, KisJPEGExport, JPEGXLExport, KisPNGExport, RGBEExport, and KisTIFFExport.

Definition at line 125 of file KisImportExportFilter.cpp.

{
    Q_UNUSED(from);
    Q_UNUSED(to);
    return 0;
}

◆ exportChecks()

QMap< QString, KisExportCheckBase * > KisImportExportFilter::exportChecks ( )

virtual

generate and return the list of capabilities of this export filter. The list

Returns: returns the list of capabilities of this export filter

Definition at line 149 of file KisImportExportFilter.cpp.

{
    qDeleteAll(d->capabilities);
    initializeCapabilities();
    return d->capabilities;
}

References d, and initializeCapabilities().

◆ exportSupportsGuides()

bool KisImportExportFilter::exportSupportsGuides ( ) const

virtual

exportSupportsGuides Because guides are in the document and not the image, checking for guides cannot be made an exportCheck.

Returns: whether this filter supports exporting guides

Reimplemented in KraExport, and psdExport.

Definition at line 156 of file KisImportExportFilter.cpp.

{
    return false;
}

◆ filename()

QString KisImportExportFilter::filename ( ) const

protected

◆ importUserFeedBackInterface()

KisImportUserFeedbackInterface * KisImportExportFilter::importUserFeedBackInterface ( ) const

protected

◆ initializeCapabilities()

void KisImportExportFilter::initializeCapabilities ( )

protectedvirtual

Reimplemented in KisBrushExport, KisCSVExport, EXRExport, KisGIFExport, HeifExport, KisHeightMapExport, KisJPEGExport, JPEGXLExport, KraExport, KrzExport, OraExport, KisPNGExport, psdExport, KisQImageIOExport, QMLExport, RGBEExport, KisSpriterExport, KisTGAExport, KisTIFFExport, and KisWebPExport.

Definition at line 212 of file KisImportExportFilter.cpp.

{
    // XXX: Initialize everything to fully supported?
}

◆ lastSavedConfiguration()

KisPropertiesConfigurationSP KisImportExportFilter::lastSavedConfiguration	(	const QByteArray &	from = "",
		const QByteArray &	to = "" ) const

lastSavedConfiguration return the last saved configuration for this filter

Parameters

from	The mimetype of the source file/document
to	The mimetype of the destination file/document

Returns: a serializable KisPropertiesConfiguration object

Definition at line 132 of file KisImportExportFilter.cpp.

{
    KisPropertiesConfigurationSP cfg = defaultConfiguration(from, to);
    const QString filterConfig = KisConfig(true).exportConfigurationXML(to);
    if (cfg && !filterConfig.isEmpty()) {
        cfg->fromXML(filterConfig, false);
    }
    return cfg;
}

References defaultConfiguration(), and KisConfig::exportConfigurationXML().

◆ mimeType()

QByteArray KisImportExportFilter::mimeType ( ) const

protected

Definition at line 120 of file KisImportExportFilter.cpp.

{
    return d->mime;
}

References d.

◆ operator=()

KisImportExportFilter & KisImportExportFilter::operator= ( const KisImportExportFilter & rhs )

private

◆ Private()

KisImportExportFilter::Private ( )

inline

Definition at line 47 of file KisImportExportFilter.cpp.

        : updater(0), mime("")
        , batchmode(false)
    {}

◆ realFilename()

QString KisImportExportFilter::realFilename ( ) const

protected

◆ setBatchMode()

void KisImportExportFilter::setBatchMode ( bool batchmode )

Definition at line 94 of file KisImportExportFilter.cpp.

{
    d->batchmode = batchmode;
}

References batchmode, and d.

◆ setFilename()

void KisImportExportFilter::setFilename ( const QString & filename )

Definition at line 104 of file KisImportExportFilter.cpp.

{
    d->filename = filename;
}

References d, and filename.

◆ setImportUserFeedBackInterface()

void KisImportExportFilter::setImportUserFeedBackInterface ( KisImportUserFeedbackInterface * interface )

Definition at line 99 of file KisImportExportFilter.cpp.

{
    d->importUserFeedBackInterface = interface;
}

References d.

◆ setMimeType()

void KisImportExportFilter::setMimeType ( const QString & mime )

Definition at line 115 of file KisImportExportFilter.cpp.

{
    d->mime = mime.toLatin1();
}

References d, and mime.

◆ setProgress()

void KisImportExportFilter::setProgress ( int value )

protected

Definition at line 205 of file KisImportExportFilter.cpp.

{
    if (d->updater) {
        d->updater->setValue(value);
    }
}

References d, and value().

◆ setRealFilename()

void KisImportExportFilter::setRealFilename ( const QString & filename )

Definition at line 109 of file KisImportExportFilter.cpp.

{
    d->realFilename = filename;
}

References d, and filename.

◆ setUpdater()

void KisImportExportFilter::setUpdater ( QPointer< KoUpdater > updater )

Definition at line 195 of file KisImportExportFilter.cpp.

{
    d->updater = updater;
}

References d, and updater.

◆ supportsIO()

virtual bool KisImportExportFilter::supportsIO ( ) const

inlinevirtual

Override and return false for the filters that use a library that cannot handle file handles, only file names.

Reimplemented in EXRExport, exrImport, HeifExport, HeifImport, JPEGXLImport, RGBEImport, KisSpriterExport, KisTIFFExport, and KisTIFFImport.

Definition at line 128 of file KisImportExportFilter.h.

128{ return true; }

◆ updater()

QPointer< KoUpdater > KisImportExportFilter::updater ( )

◆ verify()

QString KisImportExportFilter::verify ( const QString & fileName ) const

virtual

Verify whether the given file is correct and readable.

Reimplemented in KraExport, KrzExport, and OraExport.

Definition at line 161 of file KisImportExportFilter.cpp.

{
    QFileInfo fi(fileName);
 
    if (!fi.exists()) {
        return i18n("%1 does not exist after writing. Try saving again under a different name, in another location.", fileName);
    }
 
    if (!fi.isReadable()) {
        return i18n("%1 is not readable", fileName);
    }
 
    if (fi.size() < 10)  {
        return i18n("%1 is smaller than 10 bytes, it must be corrupt. Try saving again under a different name, in another location.", fileName);
    }
 
    QFile f(fileName);
    f.open(QFile::ReadOnly);
    QByteArray ba = f.read(std::min(f.size(), (qint64)1000));
    bool found = false;
    for(int i = 0; i < ba.size(); ++i) {
        if (ba.at(i) > 0) {
            found = true;
            break;
        }
    }
 
    if (!found) {
        return i18n("%1 has only zero bytes in the first 1000 bytes, it's probably corrupt. Try saving again under a different name, in another location.", fileName);
    }
 
    return QString();
}

◆ verifyZiPBasedFiles()

QString KisImportExportFilter::verifyZiPBasedFiles	(	const QString &	fileName,
		const QStringList &	filesToCheck ) const

protected

Definition at line 281 of file KisImportExportFilter.cpp.

{
    QScopedPointer<KoStore> store(KoStore::createStore(fileName, KoStore::Read, KIS_MIME_TYPE, KoStore::Zip));
 
    if (!store || store->bad()) {
        return i18n("Could not open the saved file %1. Please try to save again in a different location.", fileName);
    }
 
    Q_FOREACH(const QString &file, filesToCheck) {
        if (!store->hasFile(file)) {
            return i18n("Component %1 is missing in %2. Please try to save again in a different location.", file, fileName);
        }
    }
 
    return QString();
 
}

References KoStore::createStore(), KIS_MIME_TYPE, KoStore::Read, and KoStore::Zip.

Member Data Documentation

◆ batchmode

bool KisImportExportFilter::batchmode

Definition at line 42 of file KisImportExportFilter.cpp.

◆ capabilities

QMap<QString, KisExportCheckBase*> KisImportExportFilter::capabilities

Definition at line 45 of file KisImportExportFilter.cpp.

◆ CICPPrimariesTag

const QString KisImportExportFilter::CICPPrimariesTag = "CICPCompatiblePrimaries"

static

Definition at line 62 of file KisImportExportFilter.h.

◆ CICPTransferCharacteristicsTag

const QString KisImportExportFilter::CICPTransferCharacteristicsTag = "CICPCompatibleTransferFunction"

static

Definition at line 63 of file KisImportExportFilter.h.

◆ ColorDepthIDTag

const QString KisImportExportFilter::ColorDepthIDTag = "ColorDepthID"

static

Definition at line 59 of file KisImportExportFilter.h.

◆ ColorModelIDTag

const QString KisImportExportFilter::ColorModelIDTag = "ColorModelID"

static

Definition at line 58 of file KisImportExportFilter.h.

◆ d

Private* const KisImportExportFilter::d

private

Definition at line 158 of file KisImportExportFilter.h.

◆ filename

QString KisImportExportFilter::filename

Definition at line 40 of file KisImportExportFilter.cpp.

◆ HDRTag

const QString KisImportExportFilter::HDRTag = "HDRSupported"

static

Definition at line 61 of file KisImportExportFilter.h.

◆ ImageContainsTransparencyTag

const QString KisImportExportFilter::ImageContainsTransparencyTag = "ImageContainsTransparency"

static

Definition at line 57 of file KisImportExportFilter.h.

◆ importUserFeedBackInterface

KisImportUserFeedbackInterface * KisImportExportFilter::importUserFeedBackInterface {nullptr}

Definition at line 43 of file KisImportExportFilter.cpp.

43{nullptr};

◆ mime

QByteArray KisImportExportFilter::mime

Definition at line 39 of file KisImportExportFilter.cpp.

◆ realFilename

QString KisImportExportFilter::realFilename

Definition at line 41 of file KisImportExportFilter.cpp.

◆ sRGBTag

const QString KisImportExportFilter::sRGBTag = "sRGB"

static

Definition at line 60 of file KisImportExportFilter.h.

◆ updater

QPointer< KoUpdater > KisImportExportFilter::updater

Definition at line 38 of file KisImportExportFilter.cpp.

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

libs/ui/KisImportExportFilter.cpp
libs/ui/KisImportExportFilter.h

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~Private()

◆ ~KisImportExportFilter()

◆ KisImportExportFilter() [1/2]

◆ KisImportExportFilter() [2/2]

Member Function Documentation

◆ addCapability()

◆ addSupportedColorModels()

◆ batchMode()

◆ convert()

◆ createConfigurationWidget()

◆ defaultConfiguration()

◆ exportChecks()

◆ exportSupportsGuides()

◆ filename()

◆ importUserFeedBackInterface()

◆ initializeCapabilities()

◆ lastSavedConfiguration()

◆ mimeType()

◆ operator=()

◆ Private()

◆ realFilename()

◆ setBatchMode()

◆ setFilename()

◆ setImportUserFeedBackInterface()

◆ setMimeType()

◆ setProgress()

◆ setRealFilename()

◆ setUpdater()

◆ supportsIO()

◆ updater()

◆ verify()

◆ verifyZiPBasedFiles()

Member Data Documentation

◆ batchmode

◆ capabilities

◆ CICPPrimariesTag

◆ CICPTransferCharacteristicsTag

◆ ColorDepthIDTag

◆ ColorModelIDTag

◆ d

◆ filename

◆ HDRTag

◆ ImageContainsTransparencyTag

◆ importUserFeedBackInterface

◆ mime

◆ realFilename

◆ sRGBTag

◆ updater