API reference - Class QImageIOHandler

Notation used in Ruby API documentation

Description: Binding of QImageIOHandler

Class hierarchy: QImageIOHandler

Public constructors

new QImageIOHandlernewConstructor QImageIOHandler::QImageIOHandler()

Public methods

[virtual,const]boolcanReadVirtual method bool QImageIOHandler::canRead()
voidcreateEnsures the C++ object is created
[virtual,const]intcurrentImageNumberVirtual method int QImageIOHandler::currentImageNumber()
[virtual,const]QRectcurrentImageRectVirtual method QRect QImageIOHandler::currentImageRect()
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]QIODevice ptrdeviceMethod QIODevice *QImageIOHandler::device()
voiddevice=(QIODevice ptr device)Method void QImageIOHandler::setDevice(QIODevice *device)
[const]stringformatMethod QByteArray QImageIOHandler::format()
voidformat=(string format)Method void QImageIOHandler::setFormat(const QByteArray &format)
[const]voidformat=(string format)Method void QImageIOHandler::setFormat(const QByteArray &format)
[virtual,const]intimageCountVirtual method int QImageIOHandler::imageCount()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[virtual]booljumpToImage(int imageNumber)Virtual method bool QImageIOHandler::jumpToImage(int imageNumber)
[virtual]booljumpToNextImageVirtual method bool QImageIOHandler::jumpToNextImage()
[virtual,const]intloopCountVirtual method int QImageIOHandler::loopCount()
[virtual,const]stringnameVirtual method QByteArray QImageIOHandler::name()
[virtual,const]intnextImageDelayVirtual method int QImageIOHandler::nextImageDelay()
[virtual,const]QVariantoption(const QImageIOHandler_ImageOption option)Virtual method QVariant QImageIOHandler::option(QImageIOHandler::ImageOption option)
[virtual]boolread(QImage ptr image)Virtual method bool QImageIOHandler::read(QImage *image)
voidsetDevice(QIODevice ptr device)Method void QImageIOHandler::setDevice(QIODevice *device)
voidsetFormat(string format)Method void QImageIOHandler::setFormat(const QByteArray &format)
[const]voidsetFormat(string format)Method void QImageIOHandler::setFormat(const QByteArray &format)
[virtual]voidsetOption(const QImageIOHandler_ImageOption option,
const QVariant value)
Virtual method void QImageIOHandler::setOption(QImageIOHandler::ImageOption option, const QVariant &value)
[virtual,const]boolsupportsOption(const QImageIOHandler_ImageOption option)Virtual method bool QImageIOHandler::supportsOption(QImageIOHandler::ImageOption option)
[virtual]boolwrite(const QImage image)Virtual method bool QImageIOHandler::write(const QImage &image)

Public static methods and constants

QImageIOHandler_ImageOptionAnimationEnum constant QImageIOHandler::Animation
QImageIOHandler_ImageOptionBackgroundColorEnum constant QImageIOHandler::BackgroundColor
QImageIOHandler_ImageOptionClipRectEnum constant QImageIOHandler::ClipRect
QImageIOHandler_ImageOptionCompressionRatioEnum constant QImageIOHandler::CompressionRatio
QImageIOHandler_ImageOptionDescriptionEnum constant QImageIOHandler::Description
QImageIOHandler_ImageOptionEndiannessEnum constant QImageIOHandler::Endianness
QImageIOHandler_ImageOptionGammaEnum constant QImageIOHandler::Gamma
QImageIOHandler_ImageOptionImageFormatEnum constant QImageIOHandler::ImageFormat
QImageIOHandler_ImageOptionIncrementalReadingEnum constant QImageIOHandler::IncrementalReading
QImageIOHandler_ImageOptionNameEnum constant QImageIOHandler::Name
QImageIOHandler_ImageOptionQualityEnum constant QImageIOHandler::Quality
QImageIOHandler_ImageOptionScaledClipRectEnum constant QImageIOHandler::ScaledClipRect
QImageIOHandler_ImageOptionScaledSizeEnum constant QImageIOHandler::ScaledSize
QImageIOHandler_ImageOptionSizeEnum constant QImageIOHandler::Size
QImageIOHandler_ImageOptionSubTypeEnum constant QImageIOHandler::SubType

Detailed description

[static] QImageIOHandler_ImageOption Animation

Description: Enum constant QImageIOHandler::Animation

[static] QImageIOHandler_ImageOption BackgroundColor

Description: Enum constant QImageIOHandler::BackgroundColor

[static] QImageIOHandler_ImageOption ClipRect

Description: Enum constant QImageIOHandler::ClipRect

[static] QImageIOHandler_ImageOption CompressionRatio

Description: Enum constant QImageIOHandler::CompressionRatio

[static] QImageIOHandler_ImageOption Description

Description: Enum constant QImageIOHandler::Description

[static] QImageIOHandler_ImageOption Endianness

Description: Enum constant QImageIOHandler::Endianness

[static] QImageIOHandler_ImageOption Gamma

Description: Enum constant QImageIOHandler::Gamma

[static] QImageIOHandler_ImageOption ImageFormat

Description: Enum constant QImageIOHandler::ImageFormat

[static] QImageIOHandler_ImageOption IncrementalReading

Description: Enum constant QImageIOHandler::IncrementalReading

[static] QImageIOHandler_ImageOption Name

Description: Enum constant QImageIOHandler::Name

[static] QImageIOHandler_ImageOption Quality

Description: Enum constant QImageIOHandler::Quality

[static] QImageIOHandler_ImageOption ScaledClipRect

Description: Enum constant QImageIOHandler::ScaledClipRect

[static] QImageIOHandler_ImageOption ScaledSize

Description: Enum constant QImageIOHandler::ScaledSize

[static] QImageIOHandler_ImageOption Size

Description: Enum constant QImageIOHandler::Size

[static] QImageIOHandler_ImageOption SubType

Description: Enum constant QImageIOHandler::SubType

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

[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 destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, 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] QIODevice ptr device

Description: Method QIODevice *QImageIOHandler::device()

void device=(QIODevice ptr device)

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

[const] string format

Description: Method QByteArray QImageIOHandler::format()

void format=(string format)

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

[const] void format=(string format)

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

[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

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

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

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

void setFormat(string format)

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

[const] void setFormat(string format)

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

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