Notation used in Ruby API documentation
Module: QtGui
Description: Binding of QImageReader
Sub-classes: ImageReaderError, QFlags_ImageReaderError
new QImageReader | new | Constructor QImageReader::QImageReader() | |
new QImageReader | new | (QIODevice ptr device, bytes format = QByteArray()) | Constructor QImageReader::QImageReader(QIODevice *device, const QByteArray &format) |
new QImageReader | new | (string fileName, bytes format = QByteArray()) | Constructor QImageReader::QImageReader(const QString &fileName, const QByteArray &format) |
[const] | QImageReader ptr | _const_cast | Returns a non-const reference to self. | |
void | _create | Ensures the C++ object is created | ||
void | _destroy | Explicitly destroys the object | ||
[const] | bool | _destroyed? | Returns a value indicating whether the object was already destroyed | |
[const] | bool | _is_const_object? | Returns a value indicating whether the reference is a const reference | |
void | _manage | Marks the object as managed by the script side. | ||
void | _unmanage | Marks the object as no longer owned by the script side. | ||
[const] | bool | autoDetectImageFormat | Method bool QImageReader::autoDetectImageFormat() | |
void | autoDetectImageFormat= | (bool enabled) | Method void QImageReader::setAutoDetectImageFormat(bool enabled) | |
[const] | bool | autoTransform | Method bool QImageReader::autoTransform() | |
void | autoTransform= | (bool enabled) | Method void QImageReader::setAutoTransform(bool enabled) | |
[const] | QColor | backgroundColor | Method QColor QImageReader::backgroundColor() | |
void | backgroundColor= | (const QColor color) | Method void QImageReader::setBackgroundColor(const QColor &color) | |
[const] | bool | canRead | Method bool QImageReader::canRead() | |
[const] | QRect | clipRect | Method QRect QImageReader::clipRect() | |
void | clipRect= | (const QRect rect) | Method void QImageReader::setClipRect(const QRect &rect) | |
[const] | int | currentImageNumber | Method int QImageReader::currentImageNumber() | |
[const] | QRect | currentImageRect | Method QRect QImageReader::currentImageRect() | |
[const] | bool | decideFormatFromContent | Method bool QImageReader::decideFormatFromContent() | |
void | decideFormatFromContent= | (bool ignored) | Method void QImageReader::setDecideFormatFromContent(bool ignored) | |
[const] | QIODevice ptr | device | Method QIODevice *QImageReader::device() | |
void | device= | (QIODevice ptr device) | Method void QImageReader::setDevice(QIODevice *device) | |
[const] | QImageReader_ImageReaderError | error | Method QImageReader::ImageReaderError QImageReader::error() | |
[const] | string | errorString | Method QString QImageReader::errorString() | |
[const] | string | fileName | Method QString QImageReader::fileName() | |
void | fileName= | (string fileName) | Method void QImageReader::setFileName(const QString &fileName) | |
[const] | bytes | format | Method QByteArray QImageReader::format() | |
void | format= | (bytes format) | Method void QImageReader::setFormat(const QByteArray &format) | |
[const] | float | gamma | Method float QImageReader::gamma() | |
void | gamma= | (float gamma) | Method void QImageReader::setGamma(float gamma) | |
[const] | int | imageCount | Method int QImageReader::imageCount() | |
[const] | QImage_Format | imageFormat | Method QImage::Format QImageReader::imageFormat() | |
bool | jumpToImage | (int imageNumber) | Method bool QImageReader::jumpToImage(int imageNumber) | |
bool | jumpToNextImage | Method bool QImageReader::jumpToNextImage() | ||
[const] | int | loopCount | Method int QImageReader::loopCount() | |
[const] | int | nextImageDelay | Method int QImageReader::nextImageDelay() | |
[const] | int | quality | Method int QImageReader::quality() | |
void | quality= | (int quality) | Method void QImageReader::setQuality(int quality) | |
QImage | read | Method QImage QImageReader::read() | ||
bool | read | (QImage ptr image) | Method bool QImageReader::read(QImage *image) | |
[const] | QRect | scaledClipRect | Method QRect QImageReader::scaledClipRect() | |
void | scaledClipRect= | (const QRect rect) | Method void QImageReader::setScaledClipRect(const QRect &rect) | |
[const] | QSize | scaledSize | Method QSize QImageReader::scaledSize() | |
void | scaledSize= | (const QSize size) | Method void QImageReader::setScaledSize(const QSize &size) | |
void | setAutoDetectImageFormat | (bool enabled) | Method void QImageReader::setAutoDetectImageFormat(bool enabled) | |
void | setAutoTransform | (bool enabled) | Method void QImageReader::setAutoTransform(bool enabled) | |
void | setBackgroundColor | (const QColor color) | Method void QImageReader::setBackgroundColor(const QColor &color) | |
void | setClipRect | (const QRect rect) | Method void QImageReader::setClipRect(const QRect &rect) | |
void | setDecideFormatFromContent | (bool ignored) | Method void QImageReader::setDecideFormatFromContent(bool ignored) | |
void | setDevice | (QIODevice ptr device) | Method void QImageReader::setDevice(QIODevice *device) | |
void | setFileName | (string fileName) | Method void QImageReader::setFileName(const QString &fileName) | |
void | setFormat | (bytes format) | Method void QImageReader::setFormat(const QByteArray &format) | |
void | setGamma | (float gamma) | Method void QImageReader::setGamma(float gamma) | |
void | setQuality | (int quality) | Method void QImageReader::setQuality(int quality) | |
void | setScaledClipRect | (const QRect rect) | Method void QImageReader::setScaledClipRect(const QRect &rect) | |
void | setScaledSize | (const QSize size) | Method void QImageReader::setScaledSize(const QSize &size) | |
[const] | QSize | size | Method QSize QImageReader::size() | |
[const] | bytes | subType | Method QByteArray QImageReader::subType() | |
[const] | bytes[] | supportedSubTypes | Method QList<QByteArray> QImageReader::supportedSubTypes() | |
[const] | bool | supportsAnimation | Method bool QImageReader::supportsAnimation() | |
[const] | bool | supportsOption | (const QImageIOHandler_ImageOption option) | Method bool QImageReader::supportsOption(QImageIOHandler::ImageOption option) |
[const] | string | text | (string key) | Method QString QImageReader::text(const QString &key) |
[const] | string[] | textKeys | Method QStringList QImageReader::textKeys() | |
[const] | QImageIOHandler_QFlags_Transformation | transformation | Method QFlags<QImageIOHandler::Transformation> QImageReader::transformation() |
[static,const] | QImageReader_ImageReaderError | DeviceError | Enum constant QImageReader::DeviceError | |
[static,const] | QImageReader_ImageReaderError | FileNotFoundError | Enum constant QImageReader::FileNotFoundError | |
[static,const] | QImageReader_ImageReaderError | InvalidDataError | Enum constant QImageReader::InvalidDataError | |
[static,const] | QImageReader_ImageReaderError | UnknownError | Enum constant QImageReader::UnknownError | |
[static,const] | QImageReader_ImageReaderError | UnsupportedFormatError | Enum constant QImageReader::UnsupportedFormatError | |
bytes | imageFormat | (string fileName) | Static method QByteArray QImageReader::imageFormat(const QString &fileName) | |
bytes | imageFormat | (QIODevice ptr device) | Static method QByteArray QImageReader::imageFormat(QIODevice *device) | |
bytes[] | imageFormatsForMimeType | (bytes mimeType) | Static method QList<QByteArray> QImageReader::imageFormatsForMimeType(const QByteArray &mimeType) | |
bytes[] | supportedImageFormats | Static method QList<QByteArray> QImageReader::supportedImageFormats() | ||
bytes[] | supportedMimeTypes | Static method QList<QByteArray> QImageReader::supportedMimeTypes() | ||
string | tr | (string sourceText, string disambiguation = nullptr, int n = -1) | Static method QString QImageReader::tr(const char *sourceText, const char *disambiguation, int n) | |
string | trUtf8 | (string sourceText, string disambiguation = nullptr, int n = -1) | Static method QString QImageReader::trUtf8(const char *sourceText, const char *disambiguation, int n) |
void | create | Use of this method is deprecated. Use _create instead | ||
void | destroy | Use of this method is deprecated. Use _destroy instead | ||
[const] | bool | destroyed? | Use of this method is deprecated. Use _destroyed? instead | |
[const] | bool | is_const_object? | Use of this method is deprecated. Use _is_const_object? instead |
DeviceError | Signature: [static,const] QImageReader_ImageReaderError DeviceError Description: Enum constant QImageReader::DeviceError Python specific notes: |
FileNotFoundError | Signature: [static,const] QImageReader_ImageReaderError FileNotFoundError Description: Enum constant QImageReader::FileNotFoundError Python specific notes: |
InvalidDataError | Signature: [static,const] QImageReader_ImageReaderError InvalidDataError Description: Enum constant QImageReader::InvalidDataError Python specific notes: |
UnknownError | Signature: [static,const] QImageReader_ImageReaderError UnknownError Description: Enum constant QImageReader::UnknownError Python specific notes: |
UnsupportedFormatError | Signature: [static,const] QImageReader_ImageReaderError UnsupportedFormatError Description: Enum constant QImageReader::UnsupportedFormatError Python specific notes: |
_const_cast | Signature: [const] QImageReader 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. |
autoDetectImageFormat | Signature: [const] bool autoDetectImageFormat Description: Method bool QImageReader::autoDetectImageFormat() Python specific notes: |
autoDetectImageFormat= | Signature: void autoDetectImageFormat= (bool enabled) Description: Method void QImageReader::setAutoDetectImageFormat(bool enabled) Python specific notes: |
autoTransform | Signature: [const] bool autoTransform Description: Method bool QImageReader::autoTransform() Python specific notes: |
autoTransform= | Signature: void autoTransform= (bool enabled) Description: Method void QImageReader::setAutoTransform(bool enabled) Python specific notes: |
backgroundColor | Signature: [const] QColor backgroundColor Description: Method QColor QImageReader::backgroundColor() Python specific notes: |
backgroundColor= | Signature: void backgroundColor= (const QColor color) Description: Method void QImageReader::setBackgroundColor(const QColor &color) Python specific notes: |
canRead | Signature: [const] bool canRead Description: Method bool QImageReader::canRead() |
clipRect | Signature: [const] QRect clipRect Description: Method QRect QImageReader::clipRect() Python specific notes: |
clipRect= | Signature: void clipRect= (const QRect rect) Description: Method void QImageReader::setClipRect(const QRect &rect) Python specific notes: |
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. |
currentImageNumber | Signature: [const] int currentImageNumber Description: Method int QImageReader::currentImageNumber() |
currentImageRect | Signature: [const] QRect currentImageRect Description: Method QRect QImageReader::currentImageRect() |
decideFormatFromContent | Signature: [const] bool decideFormatFromContent Description: Method bool QImageReader::decideFormatFromContent() Python specific notes: |
decideFormatFromContent= | Signature: void decideFormatFromContent= (bool ignored) Description: Method void QImageReader::setDecideFormatFromContent(bool ignored) Python specific notes: |
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 *QImageReader::device() Python specific notes: |
device= | Signature: void device= (QIODevice ptr device) Description: Method void QImageReader::setDevice(QIODevice *device) Python specific notes: |
error | Signature: [const] QImageReader_ImageReaderError error Description: Method QImageReader::ImageReaderError QImageReader::error() |
errorString | Signature: [const] string errorString Description: Method QString QImageReader::errorString() |
fileName | Signature: [const] string fileName Description: Method QString QImageReader::fileName() Python specific notes: |
fileName= | Signature: void fileName= (string fileName) Description: Method void QImageReader::setFileName(const QString &fileName) Python specific notes: |
format | Signature: [const] bytes format Description: Method QByteArray QImageReader::format() Python specific notes: |
format= | Signature: void format= (bytes format) Description: Method void QImageReader::setFormat(const QByteArray &format) Python specific notes: |
gamma | Signature: [const] float gamma Description: Method float QImageReader::gamma() Python specific notes: |
gamma= | Signature: void gamma= (float gamma) Description: Method void QImageReader::setGamma(float gamma) Python specific notes: |
imageCount | Signature: [const] int imageCount Description: Method int QImageReader::imageCount() |
imageFormat | (1) Signature: [const] QImage_Format imageFormat Description: Method QImage::Format QImageReader::imageFormat() Python specific notes: |
(2) Signature: [static] bytes 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: | |
(3) Signature: [static] bytes 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: | |
imageFormatsForMimeType | Signature: [static] bytes[] imageFormatsForMimeType (bytes mimeType) Description: Static method QList<QByteArray> QImageReader::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. |
jumpToImage | Signature: bool jumpToImage (int imageNumber) Description: Method bool QImageReader::jumpToImage(int imageNumber) |
jumpToNextImage | Signature: bool jumpToNextImage Description: Method bool QImageReader::jumpToNextImage() |
loopCount | Signature: [const] int loopCount Description: Method int QImageReader::loopCount() |
new | (1) Signature: [static] new QImageReader new Description: Constructor QImageReader::QImageReader() This method creates an object of class QImageReader. Python specific notes: |
(2) Signature: [static] new QImageReader new (QIODevice ptr device, bytes format = QByteArray()) Description: Constructor QImageReader::QImageReader(QIODevice *device, const QByteArray &format) This method creates an object of class QImageReader. Python specific notes: | |
(3) Signature: [static] new QImageReader new (string fileName, bytes format = QByteArray()) Description: Constructor QImageReader::QImageReader(const QString &fileName, const QByteArray &format) This method creates an object of class QImageReader. Python specific notes: | |
nextImageDelay | Signature: [const] int nextImageDelay Description: Method int QImageReader::nextImageDelay() |
quality | Signature: [const] int quality Description: Method int QImageReader::quality() Python specific notes: |
quality= | Signature: void quality= (int quality) Description: Method void QImageReader::setQuality(int quality) Python specific notes: |
read | (1) Signature: QImage read Description: Method QImage QImageReader::read() |
(2) Signature: bool read (QImage ptr image) Description: Method bool QImageReader::read(QImage *image) | |
scaledClipRect | Signature: [const] QRect scaledClipRect Description: Method QRect QImageReader::scaledClipRect() Python specific notes: |
scaledClipRect= | Signature: void scaledClipRect= (const QRect rect) Description: Method void QImageReader::setScaledClipRect(const QRect &rect) Python specific notes: |
scaledSize | Signature: [const] QSize scaledSize Description: Method QSize QImageReader::scaledSize() Python specific notes: |
scaledSize= | Signature: void scaledSize= (const QSize size) Description: Method void QImageReader::setScaledSize(const QSize &size) Python specific notes: |
setAutoDetectImageFormat | Signature: void setAutoDetectImageFormat (bool enabled) Description: Method void QImageReader::setAutoDetectImageFormat(bool enabled) Python specific notes: |
setAutoTransform | Signature: void setAutoTransform (bool enabled) Description: Method void QImageReader::setAutoTransform(bool enabled) Python specific notes: |
setBackgroundColor | Signature: void setBackgroundColor (const QColor color) Description: Method void QImageReader::setBackgroundColor(const QColor &color) Python specific notes: |
setClipRect | Signature: void setClipRect (const QRect rect) Description: Method void QImageReader::setClipRect(const QRect &rect) Python specific notes: |
setDecideFormatFromContent | Signature: void setDecideFormatFromContent (bool ignored) Description: Method void QImageReader::setDecideFormatFromContent(bool ignored) Python specific notes: |
setDevice | Signature: void setDevice (QIODevice ptr device) Description: Method void QImageReader::setDevice(QIODevice *device) Python specific notes: |
setFileName | Signature: void setFileName (string fileName) Description: Method void QImageReader::setFileName(const QString &fileName) Python specific notes: |
setFormat | Signature: void setFormat (bytes format) Description: Method void QImageReader::setFormat(const QByteArray &format) Python specific notes: |
setGamma | Signature: void setGamma (float gamma) Description: Method void QImageReader::setGamma(float gamma) Python specific notes: |
setQuality | Signature: void setQuality (int quality) Description: Method void QImageReader::setQuality(int quality) Python specific notes: |
setScaledClipRect | Signature: void setScaledClipRect (const QRect rect) Description: Method void QImageReader::setScaledClipRect(const QRect &rect) Python specific notes: |
setScaledSize | Signature: void setScaledSize (const QSize size) Description: Method void QImageReader::setScaledSize(const QSize &size) Python specific notes: |
size | Signature: [const] QSize size Description: Method QSize QImageReader::size() Python specific notes: |
subType | Signature: [const] bytes subType Description: Method QByteArray QImageReader::subType() |
supportedImageFormats | Signature: [static] bytes[] supportedImageFormats Description: Static method QList<QByteArray> QImageReader::supportedImageFormats() This method is static and can be called without an instance. |
supportedMimeTypes | Signature: [static] bytes[] supportedMimeTypes Description: Static method QList<QByteArray> QImageReader::supportedMimeTypes() This method is static and can be called without an instance. |
supportedSubTypes | Signature: [const] bytes[] supportedSubTypes Description: Method QList<QByteArray> QImageReader::supportedSubTypes() |
supportsAnimation | Signature: [const] bool supportsAnimation Description: Method bool QImageReader::supportsAnimation() |
supportsOption | Signature: [const] bool supportsOption (const QImageIOHandler_ImageOption option) Description: Method bool QImageReader::supportsOption(QImageIOHandler::ImageOption option) |
text | Signature: [const] string text (string key) Description: Method QString QImageReader::text(const QString &key) |
textKeys | Signature: [const] string[] textKeys Description: Method QStringList QImageReader::textKeys() |
tr | Signature: [static] string tr (string sourceText, string disambiguation = nullptr, int n = -1) Description: Static method QString QImageReader::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 QImageReader::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> QImageReader::transformation() |