KisQImageIOExport Class Reference

#include <kis_qimageio_export.h>

Inheritance diagram for KisQImageIOExport:

Public Member Functions
KisImportExportErrorCode	convert (KisDocument *document, QIODevice *io, KisPropertiesConfigurationSP configuration=0) override
KisConfigWidget *	createConfigurationWidget (QWidget *parent, const QByteArray &from, const QByteArray &to) const override
	createConfigurationWidget creates a widget that can be used to define the settings for a given import/export filter
KisPropertiesConfigurationSP	defaultConfiguration (const QByteArray &, const QByteArray &) const override
	defaultConfiguration defines the default settings for the given import export filter
void	initializeCapabilities () override
	KisQImageIOExport (QObject *parent, const QVariantList &)
	~KisQImageIOExport () override
Public Member Functions inherited from KisImportExportFilter
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 ()

Additional Inherited Members
Public Attributes inherited from KisImportExportFilter
bool	batchmode
QMap< QString, KisExportCheckBase * >	capabilities
QString	filename
KisImportUserFeedbackInterface *	importUserFeedBackInterface {nullptr}
QByteArray	mime
QString	realFilename
QPointer< KoUpdater >	updater
Static Public Attributes inherited from KisImportExportFilter
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 inherited from KisImportExportFilter
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
	KisImportExportFilter (QObject *parent=0)
QByteArray	mimeType () const
QString	realFilename () const
void	setProgress (int value)
QString	verifyZiPBasedFiles (const QString &fileName, const QStringList &filesToCheck) const

Detailed Description

Definition at line 14 of file kis_qimageio_export.h.

Constructor & Destructor Documentation

KisQImageIOExport()

KisQImageIOExport::KisQImageIOExport	(	QObject *	parent,
		const QVariantList &	)

Definition at line 58 of file kis_qimageio_export.cpp.

                                                                          : KisImportExportFilter(parent)
{
}

~KisQImageIOExport()

KisQImageIOExport::~KisQImageIOExport ( )

override

Definition at line 62 of file kis_qimageio_export.cpp.

{
}

Member Function Documentation

convert()

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

overridevirtual

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.

Implements KisImportExportFilter.

Definition at line 66 of file kis_qimageio_export.cpp.

{
    QRect rc = document->savingImage()->bounds();
    QImage image = document->savingImage()->projection()->convertToQImage(0, 0, 0, rc.width(), rc.height(), KoColorConversionTransformation::internalRenderingIntent(), KoColorConversionTransformation::internalConversionFlags());
    int quality = -1;
    if (configuration) {
        quality = configuration->getInt("quality", -1);
    }
 
    bool result = image.save(io, QFileInfo(filename()).suffix().toLatin1(), quality);
    if (result) {
        return ImportExportCodes::OK;
    }
    else {
        return ImportExportCodes::FileFormatIncorrect;
    }
}

References ImportExportCodes::FileFormatIncorrect, KisImportExportFilter::filename, KoColorConversionTransformation::internalConversionFlags(), KoColorConversionTransformation::internalRenderingIntent(), and ImportExportCodes::OK.

createConfigurationWidget()

KisConfigWidget * KisQImageIOExport::createConfigurationWidget ( QWidget * parent, const QByteArray & from, const QByteArray & to ) const

overridevirtual

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 from KisImportExportFilter.

Definition at line 93 of file kis_qimageio_export.cpp.

{
    if (mimeType() == "image/webp") {
        return new KisWdgOptionsQImageIO(parent);
    }
 
    return 0;
}

References KisImportExportFilter::mimeType().

defaultConfiguration()

KisPropertiesConfigurationSP KisQImageIOExport::defaultConfiguration ( const QByteArray & from, const QByteArray & to ) const

overridevirtual

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 from KisImportExportFilter.

Definition at line 102 of file kis_qimageio_export.cpp.

{
    if (mimeType() == "image/webp") {
        KisPropertiesConfigurationSP cfg = new KisPropertiesConfiguration();
        // the Qt webp plugin chooses 75 when passing -1 (default argument) to QImage::save()
        cfg->setProperty("quality", 75);
        return cfg;
    }
    return 0;
}

References KisImportExportFilter::mimeType().

initializeCapabilities()

void KisQImageIOExport::initializeCapabilities ( )

overridevirtual

Reimplemented from KisImportExportFilter.

Definition at line 84 of file kis_qimageio_export.cpp.

{
    QList<QPair<KoID, KoID> > supportedColorModels;
    supportedColorModels << QPair<KoID, KoID>()
            << QPair<KoID, KoID>(RGBAColorModelID, Integer8BitsColorDepthID);
    addSupportedColorModels(supportedColorModels, KisMimeDatabase::descriptionForMimeType(mimeType()));
    addCapability(KisExportCheckRegistry::instance()->get("ColorModelPerLayerCheck/" + RGBAColorModelID.id() + "/" + Integer8BitsColorDepthID.id())->create(KisExportCheckBase::SUPPORTED));
}

References KisImportExportFilter::addCapability(), KisImportExportFilter::addSupportedColorModels(), KisMimeDatabase::descriptionForMimeType(), get(), KoID::id(), KisExportCheckRegistry::instance(), Integer8BitsColorDepthID, KisImportExportFilter::mimeType(), RGBAColorModelID, and KisExportCheckBase::SUPPORTED.

---

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

• plugins/impex/qimageio/kis_qimageio_export.h
• plugins/impex/qimageio/kis_qimageio_export.cpp