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

API reference - Class QImageIOHandler

Notation used in Ruby API documentation

Description: Binding of QImageIOHandler

Class hierarchy: QImageIOHandler

Sub-classes: ImageOption

• 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 QImageIOHandler_ImageOption ptr Animation

Description: Enum constant QImageIOHandler::Animation

[static,const] new QImageIOHandler_ImageOption ptr BackgroundColor

Description: Enum constant QImageIOHandler::BackgroundColor

[static,const] new QImageIOHandler_ImageOption ptr ClipRect

Description: Enum constant QImageIOHandler::ClipRect

[static,const] new QImageIOHandler_ImageOption ptr CompressionRatio

Description: Enum constant QImageIOHandler::CompressionRatio

[static,const] new QImageIOHandler_ImageOption ptr Description

Description: Enum constant QImageIOHandler::Description

[static,const] new QImageIOHandler_ImageOption ptr Endianness

Description: Enum constant QImageIOHandler::Endianness

[static,const] new QImageIOHandler_ImageOption ptr Gamma

Description: Enum constant QImageIOHandler::Gamma

[static,const] new QImageIOHandler_ImageOption ptr ImageFormat

Description: Enum constant QImageIOHandler::ImageFormat

[static,const] new QImageIOHandler_ImageOption ptr IncrementalReading

Description: Enum constant QImageIOHandler::IncrementalReading

[static,const] new QImageIOHandler_ImageOption ptr Name

Description: Enum constant QImageIOHandler::Name

[static,const] new QImageIOHandler_ImageOption ptr Quality

Description: Enum constant QImageIOHandler::Quality

[static,const] new QImageIOHandler_ImageOption ptr ScaledClipRect

Description: Enum constant QImageIOHandler::ScaledClipRect

[static,const] new QImageIOHandler_ImageOption ptr ScaledSize

Description: Enum constant QImageIOHandler::ScaledSize

[static,const] new QImageIOHandler_ImageOption ptr Size

Description: Enum constant QImageIOHandler::Size

[static,const] new QImageIOHandler_ImageOption ptr SubType

Description: Enum constant QImageIOHandler::SubType

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.

[virtual,const] bool canRead

Description: Virtual method bool QImageIOHandler::canRead()

This method can be reimplemented in a derived class.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[virtual,const] int currentImageNumber

Description: Virtual method int QImageIOHandler::currentImageNumber()

This method can be reimplemented in a derived class.

[virtual,const] QRect currentImageRect

Description: Virtual method QRect QImageIOHandler::currentImageRect()

This method can be reimplemented in a derived class.

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 *QImageIOHandler::device()

Python specific notes:

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

void device=(QIODevice ptr device)

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

Python specific notes:

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

[const] string format

Description: Method QByteArray QImageIOHandler::format()

Python specific notes:

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

void format=(string format)

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

Python specific notes:

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

[const] void format=(string format)

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

Python specific notes:

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

[virtual,const] int imageCount

Description: Virtual method int QImageIOHandler::imageCount()

This method can be reimplemented in a derived class.

[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

[virtual] bool jumpToImage(int imageNumber)

Description: Virtual method bool QImageIOHandler::jumpToImage(int imageNumber)

This method can be reimplemented in a derived class.

[virtual] bool jumpToNextImage

Description: Virtual method bool QImageIOHandler::jumpToNextImage()

This method can be reimplemented in a derived class.

[virtual,const] int loopCount

Description: Virtual method int QImageIOHandler::loopCount()

This method can be reimplemented in a derived class.

[virtual,const] string name

Description: Virtual method QByteArray QImageIOHandler::name()

This method can be reimplemented in a derived class.

[static] new QImageIOHandler new

Description: Constructor QImageIOHandler::QImageIOHandler()

This method creates an object of class QImageIOHandler.

Python specific notes:

This method is the default initializer of the object

[virtual,const] int nextImageDelay

Description: Virtual method int QImageIOHandler::nextImageDelay()

This method can be reimplemented in a derived class.

[virtual,const] QVariant option(const QImageIOHandler_ImageOption option)

Description: Virtual method QVariant QImageIOHandler::option(QImageIOHandler::ImageOption option)

This method can be reimplemented in a derived class.

[virtual] bool read(QImage ptr image)

Description: Virtual method bool QImageIOHandler::read(QImage *image)

This method can be reimplemented in a derived class.

void setDevice(QIODevice ptr device)

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

Python specific notes:

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

void setFormat(string format)

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

Python specific notes:

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

[const] void setFormat(string format)

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

Python specific notes:

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

[virtual] void setOption(const QImageIOHandler_ImageOption option,const QVariant value)

Description: Virtual method void QImageIOHandler::setOption(QImageIOHandler::ImageOption option, const QVariant &value)

This method can be reimplemented in a derived class.

[virtual,const] bool supportsOption(const QImageIOHandler_ImageOption option)

Description: Virtual method bool QImageIOHandler::supportsOption(QImageIOHandler::ImageOption option)

This method can be reimplemented in a derived class.

[virtual] bool write(const QImage image)

Description: Virtual method bool QImageIOHandler::write(const QImage &image)

This method can be reimplemented in a derived class.