API reference - Class QImageWriter

DeviceError

Signature: [static,const] QImageWriter_ImageWriterError DeviceError

Description: Enum constant QImageWriter::DeviceError

Python specific notes:
The object exposes a readable attribute 'DeviceError'. This is the getter.

InvalidImageError

Signature: [static,const] QImageWriter_ImageWriterError InvalidImageError

Description: Enum constant QImageWriter::InvalidImageError

Python specific notes:
The object exposes a readable attribute 'InvalidImageError'. This is the getter.

UnknownError

Signature: [static,const] QImageWriter_ImageWriterError UnknownError

Description: Enum constant QImageWriter::UnknownError

Python specific notes:
The object exposes a readable attribute 'UnknownError'. This is the getter.

UnsupportedFormatError

Signature: [static,const] QImageWriter_ImageWriterError UnsupportedFormatError

Description: Enum constant QImageWriter::UnsupportedFormatError

Python specific notes:
The object exposes a readable attribute 'UnsupportedFormatError'. This is the getter.

_const_cast

Signature: [const] QImageWriter ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

canWrite

Signature: [const] bool canWrite

Description: Method bool QImageWriter::canWrite()

compression

Signature: [const] int compression

Description: Method int QImageWriter::compression()

Python specific notes:
The object exposes a readable attribute 'compression'. This is the getter.

compression=

Signature: void compression= (int compression)

Description: Method void QImageWriter::setCompression(int compression)

Python specific notes:
The object exposes a writable attribute 'compression'. This is the setter.

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

description

Signature: [const] string description

Description: Method QString QImageWriter::description()

Python specific notes:
The object exposes a readable attribute 'description'. This is the getter.

description=

Signature: void description= (string description)

Description: Method void QImageWriter::setDescription(const QString &description)

Python specific notes:
The object exposes a writable attribute 'description'. This is the setter.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

device

Signature: [const] QIODevice ptr device

Description: Method QIODevice *QImageWriter::device()

Python specific notes:
The object exposes a readable attribute 'device'. This is the getter.

device=

Signature: void device= (QIODevice ptr device)

Description: Method void QImageWriter::setDevice(QIODevice *device)

Python specific notes:
The object exposes a writable attribute 'device'. This is the setter.

error

Signature: [const] QImageWriter_ImageWriterError error

Description: Method QImageWriter::ImageWriterError QImageWriter::error()

errorString

Signature: [const] string errorString

Description: Method QString QImageWriter::errorString()

fileName

Signature: [const] string fileName

Description: Method QString QImageWriter::fileName()

Python specific notes:
The object exposes a readable attribute 'fileName'. This is the getter.

fileName=

Signature: void fileName= (string fileName)

Description: Method void QImageWriter::setFileName(const QString &fileName)

Python specific notes:
The object exposes a writable attribute 'fileName'. This is the setter.

format

Signature: [const] bytes format

Description: Method QByteArray QImageWriter::format()

Python specific notes:
The object exposes a readable attribute 'format'. This is the getter.

format=

Signature: void format= (bytes format)

Description: Method void QImageWriter::setFormat(const QByteArray &format)

Python specific notes:
The object exposes a writable attribute 'format'. This is the setter.

gamma

Signature: [const] float gamma

Description: Method float QImageWriter::gamma()

Python specific notes:
The object exposes a readable attribute 'gamma'. This is the getter.

gamma=

Signature: void gamma= (float gamma)

Description: Method void QImageWriter::setGamma(float gamma)

Python specific notes:
The object exposes a writable attribute 'gamma'. This is the setter.

imageFormatsForMimeType

Signature: [static] bytes[] imageFormatsForMimeType (bytes mimeType)

Description: Static method QList<QByteArray> QImageWriter::imageFormatsForMimeType(const QByteArray &mimeType)

This method is static and can be called without an instance.

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

new

(1) Signature: [static] new QImageWriter new

Description: Constructor QImageWriter::QImageWriter()

This method creates an object of class QImageWriter.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QImageWriter new (QIODevice ptr device, bytes format)

Description: Constructor QImageWriter::QImageWriter(QIODevice *device, const QByteArray &format)

This method creates an object of class QImageWriter.

Python specific notes:
This method is the default initializer of the object.

(3) Signature: [static] new QImageWriter new (string fileName, bytes format = QByteArray())

Description: Constructor QImageWriter::QImageWriter(const QString &fileName, const QByteArray &format)

This method creates an object of class QImageWriter.

Python specific notes:
This method is the default initializer of the object.

optimizedWrite

Signature: [const] bool optimizedWrite

Description: Method bool QImageWriter::optimizedWrite()

Python specific notes:
The object exposes a readable attribute 'optimizedWrite'. This is the getter.

optimizedWrite=

Signature: void optimizedWrite= (bool optimize)

Description: Method void QImageWriter::setOptimizedWrite(bool optimize)

Python specific notes:
The object exposes a writable attribute 'optimizedWrite'. This is the setter.

progressiveScanWrite

Signature: [const] bool progressiveScanWrite

Description: Method bool QImageWriter::progressiveScanWrite()

Python specific notes:
The object exposes a readable attribute 'progressiveScanWrite'. This is the getter.

progressiveScanWrite=

Signature: void progressiveScanWrite= (bool progressive)

Description: Method void QImageWriter::setProgressiveScanWrite(bool progressive)

Python specific notes:
The object exposes a writable attribute 'progressiveScanWrite'. This is the setter.

quality

Signature: [const] int quality

Description: Method int QImageWriter::quality()

Python specific notes:
The object exposes a readable attribute 'quality'. This is the getter.

quality=

Signature: void quality= (int quality)

Description: Method void QImageWriter::setQuality(int quality)

Python specific notes:
The object exposes a writable attribute 'quality'. This is the setter.

setCompression

Signature: void setCompression (int compression)

Description: Method void QImageWriter::setCompression(int compression)

Python specific notes:
The object exposes a writable attribute 'compression'. This is the setter.

setDescription

Signature: void setDescription (string description)

Description: Method void QImageWriter::setDescription(const QString &description)

Python specific notes:
The object exposes a writable attribute 'description'. This is the setter.

setDevice

Signature: void setDevice (QIODevice ptr device)

Description: Method void QImageWriter::setDevice(QIODevice *device)

Python specific notes:
The object exposes a writable attribute 'device'. This is the setter.

setFileName

Signature: void setFileName (string fileName)

Description: Method void QImageWriter::setFileName(const QString &fileName)

Python specific notes:
The object exposes a writable attribute 'fileName'. This is the setter.

setFormat

Signature: void setFormat (bytes format)

Description: Method void QImageWriter::setFormat(const QByteArray &format)

Python specific notes:
The object exposes a writable attribute 'format'. This is the setter.

setGamma

Signature: void setGamma (float gamma)

Description: Method void QImageWriter::setGamma(float gamma)

Python specific notes:
The object exposes a writable attribute 'gamma'. This is the setter.

setOptimizedWrite

Signature: void setOptimizedWrite (bool optimize)

Description: Method void QImageWriter::setOptimizedWrite(bool optimize)

Python specific notes:
The object exposes a writable attribute 'optimizedWrite'. This is the setter.

setProgressiveScanWrite

Signature: void setProgressiveScanWrite (bool progressive)

Description: Method void QImageWriter::setProgressiveScanWrite(bool progressive)

Python specific notes:
The object exposes a writable attribute 'progressiveScanWrite'. This is the setter.

setQuality

Signature: void setQuality (int quality)

Description: Method void QImageWriter::setQuality(int quality)

Python specific notes:
The object exposes a writable attribute 'quality'. This is the setter.

setSubType

Signature: void setSubType (bytes type)

Description: Method void QImageWriter::setSubType(const QByteArray &type)

Python specific notes:
The object exposes a writable attribute 'subType'. This is the setter.

setText

Signature: void setText (string key, string text)

Description: Method void QImageWriter::setText(const QString &key, const QString &text)

setTransformation

Signature: void setTransformation (QImageIOHandler_QFlags_Transformation orientation)

Description: Method void QImageWriter::setTransformation(QFlags<QImageIOHandler::Transformation> orientation)

Python specific notes:
The object exposes a writable attribute 'transformation'. This is the setter.

subType

Signature: [const] bytes subType

Description: Method QByteArray QImageWriter::subType()

Python specific notes:
The object exposes a readable attribute 'subType'. This is the getter.

subType=

Signature: void subType= (bytes type)

Description: Method void QImageWriter::setSubType(const QByteArray &type)

Python specific notes:
The object exposes a writable attribute 'subType'. This is the setter.

supportedImageFormats

Signature: [static] bytes[] supportedImageFormats

Description: Static method QList<QByteArray> QImageWriter::supportedImageFormats()

This method is static and can be called without an instance.

supportedMimeTypes

Signature: [static] bytes[] supportedMimeTypes

Description: Static method QList<QByteArray> QImageWriter::supportedMimeTypes()

This method is static and can be called without an instance.

supportedSubTypes

Signature: [const] bytes[] supportedSubTypes

Description: Method QList<QByteArray> QImageWriter::supportedSubTypes()

supportsOption

Signature: [const] bool supportsOption (const QImageIOHandler_ImageOption option)

Description: Method bool QImageWriter::supportsOption(QImageIOHandler::ImageOption option)

tr

Signature: [static] string tr (string sourceText, string disambiguation = nullptr, int n = -1)

Description: Static method QString QImageWriter::tr(const char *sourceText, const char *disambiguation, int n)

This method is static and can be called without an instance.

trUtf8

Signature: [static] string trUtf8 (string sourceText, string disambiguation = nullptr, int n = -1)

Description: Static method QString QImageWriter::trUtf8(const char *sourceText, const char *disambiguation, int n)

This method is static and can be called without an instance.

transformation

Signature: [const] QImageIOHandler_QFlags_Transformation transformation

Description: Method QFlags<QImageIOHandler::Transformation> QImageWriter::transformation()

Python specific notes:
The object exposes a readable attribute 'transformation'. This is the getter.

transformation=

Signature: void transformation= (QImageIOHandler_QFlags_Transformation orientation)

Description: Method void QImageWriter::setTransformation(QFlags<QImageIOHandler::Transformation> orientation)

Python specific notes:
The object exposes a writable attribute 'transformation'. This is the setter.

write

Signature: bool write (const QImage image)

Description: Method bool QImageWriter::write(const QImage &image)