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

API reference - Class QImageReader

Notation used in Ruby API documentation

Description: Binding of QImageReader

Public constructors

new QImageReadernewConstructor QImageReader::QImageReader()
new QImageReadernew(QIODevice ptr device)Constructor QImageReader::QImageReader(QIODevice *device, const QByteArray &format)
new QImageReadernew(QIODevice ptr device,
string format)
Constructor QImageReader::QImageReader(QIODevice *device, const QByteArray &format)
new QImageReadernew(string fileName)Constructor QImageReader::QImageReader(const QString &fileName, const QByteArray &format)
new QImageReadernew(string fileName,
string format)
Constructor QImageReader::QImageReader(const QString &fileName, const QByteArray &format)

Public methods

[const]boolautoDetectImageFormatMethod bool QImageReader::autoDetectImageFormat()
voidautoDetectImageFormat=(bool enabled)Method void QImageReader::setAutoDetectImageFormat(bool enabled)
[const]QColorbackgroundColorMethod QColor QImageReader::backgroundColor()
voidbackgroundColor=(const QColor color)Method void QImageReader::setBackgroundColor(const QColor &color)
[const]boolcanReadMethod bool QImageReader::canRead()
[const]QRectclipRectMethod QRect QImageReader::clipRect()
voidclipRect=(const QRect rect)Method void QImageReader::setClipRect(const QRect &rect)
voidcreateEnsures the C++ object is created
[const]intcurrentImageNumberMethod int QImageReader::currentImageNumber()
[const]QRectcurrentImageRectMethod QRect QImageReader::currentImageRect()
[const]booldecideFormatFromContentMethod bool QImageReader::decideFormatFromContent()
voiddecideFormatFromContent=(bool ignored)Method void QImageReader::setDecideFormatFromContent(bool ignored)
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]QIODevice ptrdeviceMethod QIODevice * QImageReader::device()
voiddevice=(QIODevice ptr device)Method void QImageReader::setDevice(QIODevice *device)
[const]QImageReader_ImageReaderErrorerrorMethod QImageReader::ImageReaderError QImageReader::error()
[const]stringerrorStringMethod QString QImageReader::errorString()
[const]stringfileNameMethod QString QImageReader::fileName()
voidfileName=(string fileName)Method void QImageReader::setFileName(const QString &fileName)
[const]stringformatMethod QByteArray QImageReader::format()
voidformat=(string format)Method void QImageReader::setFormat(const QByteArray &format)
[const]intimageCountMethod int QImageReader::imageCount()
[const]QImage_FormatimageFormatMethod QImage::Format QImageReader::imageFormat()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
booljumpToImage(int imageNumber)Method bool QImageReader::jumpToImage(int imageNumber)
booljumpToNextImageMethod bool QImageReader::jumpToNextImage()
[const]intloopCountMethod int QImageReader::loopCount()
[const]intnextImageDelayMethod int QImageReader::nextImageDelay()
[const]intqualityMethod int QImageReader::quality()
voidquality=(int quality)Method void QImageReader::setQuality(int quality)
QImagereadMethod QImage QImageReader::read()
boolread(QImage ptr image)Method bool QImageReader::read(QImage *image)
[const]QRectscaledClipRectMethod QRect QImageReader::scaledClipRect()
voidscaledClipRect=(const QRect rect)Method void QImageReader::setScaledClipRect(const QRect &rect)
[const]QSizescaledSizeMethod QSize QImageReader::scaledSize()
voidscaledSize=(const QSize size)Method void QImageReader::setScaledSize(const QSize &size)
voidsetAutoDetectImageFormat(bool enabled)Method void QImageReader::setAutoDetectImageFormat(bool enabled)
voidsetBackgroundColor(const QColor color)Method void QImageReader::setBackgroundColor(const QColor &color)
voidsetClipRect(const QRect rect)Method void QImageReader::setClipRect(const QRect &rect)
voidsetDecideFormatFromContent(bool ignored)Method void QImageReader::setDecideFormatFromContent(bool ignored)
voidsetDevice(QIODevice ptr device)Method void QImageReader::setDevice(QIODevice *device)
voidsetFileName(string fileName)Method void QImageReader::setFileName(const QString &fileName)
voidsetFormat(string format)Method void QImageReader::setFormat(const QByteArray &format)
voidsetQuality(int quality)Method void QImageReader::setQuality(int quality)
voidsetScaledClipRect(const QRect rect)Method void QImageReader::setScaledClipRect(const QRect &rect)
voidsetScaledSize(const QSize size)Method void QImageReader::setScaledSize(const QSize &size)
[const]QSizesizeMethod QSize QImageReader::size()
[const]boolsupportsAnimationMethod bool QImageReader::supportsAnimation()
[const]boolsupportsOption(const QImageIOHandler_ImageOption option)Method bool QImageReader::supportsOption(QImageIOHandler::ImageOption option)
[const]stringtext(string key)Method QString QImageReader::text(const QString &key)
[const]string[]textKeysMethod QStringList QImageReader::textKeys()

Public static methods and constants

QImageReader_ImageReaderErrorDeviceErrorEnum constant enum QImageReader::DeviceError
QImageReader_ImageReaderErrorFileNotFoundErrorEnum constant enum QImageReader::FileNotFoundError
QImageReader_ImageReaderErrorInvalidDataErrorEnum constant enum QImageReader::InvalidDataError
QImageReader_ImageReaderErrorUnknownErrorEnum constant enum QImageReader::UnknownError
QImageReader_ImageReaderErrorUnsupportedFormatErrorEnum constant enum QImageReader::UnsupportedFormatError
stringimageFormat(QIODevice ptr device)Static method QByteArray QImageReader::imageFormat(QIODevice *device)
stringimageFormat(string fileName)Static method QByteArray QImageReader::imageFormat(const QString &fileName)
string[]supportedImageFormatsStatic method QList<class QByteArray> QImageReader::supportedImageFormats()

Detailed description

[static] QImageReader_ImageReaderError DeviceError

Description: Enum constant enum QImageReader::DeviceError

[static] QImageReader_ImageReaderError FileNotFoundError

Description: Enum constant enum QImageReader::FileNotFoundError

[static] QImageReader_ImageReaderError InvalidDataError

Description: Enum constant enum QImageReader::InvalidDataError

[static] QImageReader_ImageReaderError UnknownError

Description: Enum constant enum QImageReader::UnknownError

[static] QImageReader_ImageReaderError UnsupportedFormatError

Description: Enum constant enum QImageReader::UnsupportedFormatError

[const] bool autoDetectImageFormat

Description: Method bool QImageReader::autoDetectImageFormat()

void autoDetectImageFormat=(bool enabled)

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

[const] QColor backgroundColor

Description: Method QColor QImageReader::backgroundColor()

void backgroundColor=(const QColor color)

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

[const] bool canRead

Description: Method bool QImageReader::canRead()

[const] QRect clipRect

Description: Method QRect QImageReader::clipRect()

void clipRect=(const QRect rect)

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

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.

[const] int currentImageNumber

Description: Method int QImageReader::currentImageNumber()

[const] QRect currentImageRect

Description: Method QRect QImageReader::currentImageRect()

[const] bool decideFormatFromContent

Description: Method bool QImageReader::decideFormatFromContent()

void decideFormatFromContent=(bool ignored)

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

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

void device=(QIODevice ptr device)

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

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

void fileName=(string fileName)

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

[const] string format

Description: Method QByteArray QImageReader::format()

void format=(string format)

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

[const] int imageCount

Description: Method int QImageReader::imageCount()

[const] QImage_Format imageFormat

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

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

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

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

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.

[static] new QImageReader new(QIODevice ptr device)

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

This method creates an object of class QImageReader.

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

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

This method creates an object of class QImageReader.

[static] new QImageReader new(string fileName)

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

This method creates an object of class QImageReader.

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

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

This method creates an object of class QImageReader.

[const] int nextImageDelay

Description: Method int QImageReader::nextImageDelay()

[const] int quality

Description: Method int QImageReader::quality()

void quality=(int quality)

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

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

void scaledClipRect=(const QRect rect)

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

[const] QSize scaledSize

Description: Method QSize QImageReader::scaledSize()

void scaledSize=(const QSize size)

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

void setAutoDetectImageFormat(bool enabled)

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

void setBackgroundColor(const QColor color)

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

void setClipRect(const QRect rect)

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

void setDecideFormatFromContent(bool ignored)

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

void setDevice(QIODevice ptr device)

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

void setFileName(string fileName)

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

void setFormat(string format)

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

void setQuality(int quality)

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

void setScaledClipRect(const QRect rect)

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

void setScaledSize(const QSize size)

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

[const] QSize size

Description: Method QSize QImageReader::size()

[static] string[] supportedImageFormats

Description: Static method QList<class 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()