#include <kra_export.h>

Inheritance diagram for KraExport:

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

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

void	initializeCapabilities () override

	KraExport (QObject *parent, const QVariantList &)

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

	~KraExport () override

Public Member Functions inherited from KisImportExportFilter
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

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 ()

	~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 kra_export.h.

Constructor & Destructor Documentation

◆ KraExport()

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

Definition at line 34 of file kra_export.cpp.

                                                          : KisImportExportFilter(parent)
{
}

◆ ~KraExport()

KraExport::~KraExport ( )

override

Definition at line 38 of file kra_export.cpp.

39{

40}

Member Function Documentation

◆ convert()

KisImportExportErrorCode KraExport::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 42 of file kra_export.cpp.

{
    KisImageSP image = document->savingImage();
    KIS_ASSERT_RECOVER_RETURN_VALUE(image, ImportExportCodes::InternalError);
 
    KraConverter kraConverter(document, updater());
    KisImportExportErrorCode res = kraConverter.buildFile(io, filename(), !document->isAutosaving());
    dbgFile << "KraExport::convert result =" << res;
    return res;
}

References KraConverter::buildFile(), dbgFile, KisImportExportFilter::filename, ImportExportCodes::InternalError, KIS_ASSERT_RECOVER_RETURN_VALUE, and KisImportExportFilter::updater.

◆ exportSupportsGuides()

bool KraExport::exportSupportsGuides ( ) const

overridevirtual

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

Definition at line 77 of file kra_export.cpp.

                                           {
    return true;
}

◆ initializeCapabilities()

void KraExport::initializeCapabilities ( )

overridevirtual

Reimplemented from KisImportExportFilter.

Definition at line 53 of file kra_export.cpp.

{
    // Kra supports everything, by definition
    KisExportCheckFactory *factory = 0;
    Q_FOREACH(const QString &id, KisExportCheckRegistry::instance()->keys()) {
        factory = KisExportCheckRegistry::instance()->get(id);
        addCapability(factory->create(KisExportCheckBase::SUPPORTED));
    }
}

References KisImportExportFilter::addCapability(), KisExportCheckFactory::create(), KoGenericRegistry< T >::get(), KisExportCheckRegistry::instance(), and KisExportCheckBase::SUPPORTED.

◆ verify()

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

overridevirtual

Verify whether the given file is correct and readable.

Reimplemented from KisImportExportFilter.

Definition at line 63 of file kra_export.cpp.

{
    QString error = KisImportExportFilter::verify(fileName);
    if (error.isEmpty()) {
        return KisImportExportFilter::verifyZiPBasedFiles(fileName,
                                                          QStringList()
                                                          << "mimetype"
                                                          << "documentinfo.xml"
                                                          << "maindoc.xml"
                                                          << "preview.png");
    }
    return error;
}

References KisImportExportFilter::verify(), and KisImportExportFilter::verifyZiPBasedFiles().

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

plugins/impex/kra/kra_export.h
plugins/impex/kra/kra_export.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KraExport()

◆ ~KraExport()

Member Function Documentation

◆ convert()

◆ exportSupportsGuides()

◆ initializeCapabilities()

◆ verify()