KLayout Manual: Main Index » Class Index » API reference - Class QImageReader

API reference - Class QImageReader

Notation used in Ruby API documentation

Description: Binding of QImageReader

Sub-classes: ImageReaderError

• Public constructors
• Public methods
• Public static methods and constants
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

Public constructors

Public methods

Public static methods and constants

Deprecated methods (protected, public, static, non-static and constructors)

Detailed description

[static,const] new QImageReader_ImageReaderError ptr DeviceError

Description: Enum constant QImageReader::DeviceError

[static,const] new QImageReader_ImageReaderError ptr FileNotFoundError

Description: Enum constant QImageReader::FileNotFoundError

[static,const] new QImageReader_ImageReaderError ptr InvalidDataError

Description: Enum constant QImageReader::InvalidDataError

[static,const] new QImageReader_ImageReaderError ptr UnknownError

Description: Enum constant QImageReader::UnknownError

[static,const] new QImageReader_ImageReaderError ptr UnsupportedFormatError

Description: Enum constant QImageReader::UnsupportedFormatError

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.

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.

[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.

[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.

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.

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.

[const] bool autoDetectImageFormat

Description: Method bool QImageReader::autoDetectImageFormat()

Python specific notes:

The object exposes a readable attribute 'autoDetectImageFormat'. This is the getter.

void autoDetectImageFormat=(bool enabled)

Description: Method void QImageReader::setAutoDetectImageFormat(bool enabled)

Python specific notes:

The object exposes a writable attribute 'autoDetectImageFormat'. This is the setter.

[const] QColor backgroundColor

Description: Method QColor QImageReader::backgroundColor()

Python specific notes:

The object exposes a readable attribute 'backgroundColor'. This is the getter.

void backgroundColor=(const QColor color)

Description: Method void QImageReader::setBackgroundColor(const QColor &color)

Python specific notes:

The object exposes a writable attribute 'backgroundColor'. This is the setter.

[const] bool canRead

Description: Method bool QImageReader::canRead()

[const] QRect clipRect

Description: Method QRect QImageReader::clipRect()

Python specific notes:

The object exposes a readable attribute 'clipRect'. This is the getter.

void clipRect=(const QRect rect)

Description: Method void QImageReader::setClipRect(const QRect &rect)

Python specific notes:

The object exposes a writable attribute 'clipRect'. This is the setter.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[const] int currentImageNumber

Description: Method int QImageReader::currentImageNumber()

[const] QRect currentImageRect

Description: Method QRect QImageReader::currentImageRect()

[const] bool decideFormatFromContent

Description: Method bool QImageReader::decideFormatFromContent()

Python specific notes:

The object exposes a readable attribute 'decideFormatFromContent'. This is the getter.

void decideFormatFromContent=(bool ignored)

Description: Method void QImageReader::setDecideFormatFromContent(bool ignored)

Python specific notes:

The object exposes a writable attribute 'decideFormatFromContent'. This is the setter.

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

[const] QIODevice ptr device

Description: Method QIODevice *QImageReader::device()

Python specific notes:

The object exposes a readable attribute 'device'. This is the getter.

void device=(QIODevice ptr device)

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

Python specific notes:

The object exposes a writable attribute 'device'. This is the setter.

[const] QImageReader_ImageReaderError error

Description: Method QImageReader::ImageReaderError QImageReader::error()

[const] string errorString

Description: Method QString QImageReader::errorString()

[const] string fileName

Description: Method QString QImageReader::fileName()

Python specific notes:

The object exposes a readable attribute 'fileName'. This is the getter.

void fileName=(string fileName)

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

Python specific notes:

The object exposes a writable attribute 'fileName'. This is the setter.

[const] string format

Description: Method QByteArray QImageReader::format()

Python specific notes:

The object exposes a readable attribute 'format'. This is the getter.

void format=(string format)

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

Python specific notes:

The object exposes a writable attribute 'format'. This is the setter.

[const] int imageCount

Description: Method int QImageReader::imageCount()

[const] QImage_Format imageFormat

Description: Method QImage::Format QImageReader::imageFormat()

Python specific notes:

This method is available as method '_inst_imageFormat' in Python

[static] string imageFormat(string fileName)

Description: Static method QByteArray QImageReader::imageFormat(const QString &fileName)

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

Python specific notes:

This method is available as method '_class_imageFormat' in Python

[static] string imageFormat(QIODevice ptr device)

Description: Static method QByteArray QImageReader::imageFormat(QIODevice *device)

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

Python specific notes:

This method is available as method '_class_imageFormat' in Python

[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

bool jumpToImage(int imageNumber)

Description: Method bool QImageReader::jumpToImage(int imageNumber)

bool jumpToNextImage

Description: Method bool QImageReader::jumpToNextImage()

[const] int loopCount

Description: Method int QImageReader::loopCount()

[static] new QImageReader new

Description: Constructor QImageReader::QImageReader()

This method creates an object of class QImageReader.

Python specific notes:

This method is the default initializer of the object

[static] new QImageReader new(QIODevice ptr device,string format = QByteArray())

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

This method creates an object of class QImageReader.

Python specific notes:

This method is the default initializer of the object

[static] new QImageReader new(string fileName,string format = QByteArray())

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

This method creates an object of class QImageReader.

Python specific notes:

This method is the default initializer of the object

[const] int nextImageDelay

Description: Method int QImageReader::nextImageDelay()

[const] int quality

Description: Method int QImageReader::quality()

Python specific notes:

The object exposes a readable attribute 'quality'. This is the getter.

void quality=(int quality)

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

Python specific notes:

The object exposes a writable attribute 'quality'. This is the setter.

QImage read

Description: Method QImage QImageReader::read()

bool read(QImage ptr image)

Description: Method bool QImageReader::read(QImage *image)

[const] QRect scaledClipRect

Description: Method QRect QImageReader::scaledClipRect()

Python specific notes:

The object exposes a readable attribute 'scaledClipRect'. This is the getter.

void scaledClipRect=(const QRect rect)

Description: Method void QImageReader::setScaledClipRect(const QRect &rect)

Python specific notes:

The object exposes a writable attribute 'scaledClipRect'. This is the setter.

[const] QSize scaledSize

Description: Method QSize QImageReader::scaledSize()

Python specific notes:

The object exposes a readable attribute 'scaledSize'. This is the getter.

void scaledSize=(const QSize size)

Description: Method void QImageReader::setScaledSize(const QSize &size)

Python specific notes:

The object exposes a writable attribute 'scaledSize'. This is the setter.

void setAutoDetectImageFormat(bool enabled)

Description: Method void QImageReader::setAutoDetectImageFormat(bool enabled)

Python specific notes:

The object exposes a writable attribute 'autoDetectImageFormat'. This is the setter.

void setBackgroundColor(const QColor color)

Description: Method void QImageReader::setBackgroundColor(const QColor &color)

Python specific notes:

The object exposes a writable attribute 'backgroundColor'. This is the setter.

void setClipRect(const QRect rect)

Description: Method void QImageReader::setClipRect(const QRect &rect)

Python specific notes:

The object exposes a writable attribute 'clipRect'. This is the setter.

void setDecideFormatFromContent(bool ignored)

Description: Method void QImageReader::setDecideFormatFromContent(bool ignored)

Python specific notes:

The object exposes a writable attribute 'decideFormatFromContent'. This is the setter.

void setDevice(QIODevice ptr device)

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

Python specific notes:

The object exposes a writable attribute 'device'. This is the setter.

void setFileName(string fileName)

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

Python specific notes:

The object exposes a writable attribute 'fileName'. This is the setter.

void setFormat(string format)

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

Python specific notes:

The object exposes a writable attribute 'format'. This is the setter.

void setQuality(int quality)

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

Python specific notes:

The object exposes a writable attribute 'quality'. This is the setter.

void setScaledClipRect(const QRect rect)

Description: Method void QImageReader::setScaledClipRect(const QRect &rect)

Python specific notes:

The object exposes a writable attribute 'scaledClipRect'. This is the setter.

void setScaledSize(const QSize size)

Description: Method void QImageReader::setScaledSize(const QSize &size)

Python specific notes:

The object exposes a writable attribute 'scaledSize'. This is the setter.

[const] QSize size

Description: Method QSize QImageReader::size()

Python specific notes:

This method is also available as 'len(object)'

[static] string[] supportedImageFormats

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

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

[const] bool supportsAnimation

Description: Method bool QImageReader::supportsAnimation()

[const] bool supportsOption(const QImageIOHandler_ImageOption option)

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

[const] string text(string key)

Description: Method QString QImageReader::text(const QString &key)

[const] string[] textKeys

Description: Method QStringList QImageReader::textKeys()